Conference.Ended
The Conference.Ended event is sent when a conference ends.
{
"eventType": "Conference.Ended",
"conference": {
"confId": "conferenceId_UUID",
"confAlias": "example_conference_alias"
},
"thirdPartyId": "example_thirdpartyId",
"confType": "SDK_CONF",
"ownerId": "ownerId_UUID",
"startTime": 1602086897206,
"duration": 18135,
"speakingDuration": 9097,
"recordingDuration": 6418,
"participants": [
{
"userId": "userId_UUID_01",
"ipAddress": "00.000.000.000",
"presenceDuration": 17773,
"recvTimers": {},
"sendTimers": {
"VIDEO": 12425,
"AUDIO": 15310
},
"metadata": {
"preferSendMono": "false",
"externalName": "external_name",
"externalPhotoUrl": "link_to_participant_photo",
"simulcast": "false",
"preferRecvMono": "false"
}
},
{
"userId": "userId_UUID_02",
"ipAddress": "00.000.000.001",
"presenceDuration": 9098,
"recvTimers": {
"AUDIO": 9049
},
"sendTimers": {},
"metadata": {
"preferSendMono": "false",
"externalName": "Mixer",
"externalId": "Mixer_record",
"simulcast": "false",
"preferRecvMono": "false"
}
}
],
"region": "eu",
"recordingFormat": "both",
"dolbyVoice": "true"
}
The following table explains all fields of the webhook object:
Field name | Object | Type | Meaning | Example |
---|---|---|---|---|
eventType | Root | String | The type of the webhook event. | Conference.Created |
conference.confId | Root | String in UUID format | The identifier of the ended conference. | a88484c6-2a47-4691-86e2-933eec80b316 |
conference. confAlias | Root | String | The alias of the ended conference. | virtual event 1 |
thirdPartyId | Root | String | The app key. If you implemented a common webhook listener for multiple applications, this can help you to distinguish which application is this webhook event for. | XSTXp4EsAMrcw4g== |
confType | Root | String | The conference type., either DEMO , REPLAY , or SDK_CONF . | SDK_CONF |
ownerId | Root | String | The identifier of the participant who created the conference. | bfd0173f-cd60-385b-8332-53ead1749008 |
startTime | Root | Number in milliseconds | The start time of the conference creation, in epoch. | 1683139951604 |
duration | Root | Number in milliseconds | The conference duration. | 18135 |
speakingDuration | Root | Number in milliseconds | The duration of speaking in the conference. | 815 |
recordingDuration | Root | Number in milliseconds | The recording duration. | 6418 |
participants | Root | Array of objects | The list of participants who were present in the conference when the conference ended. | bfd0173f-cd60-385b-8332-53ead1749008 |
participants[]. userId | Participants | String in UUID format | The identifier of the conference creator. | bfd0173f-cd60-385b-8332-53ead1749008 |
participants[]. ipAddress | Participants | String | The last external IP used by the conference creator in the conference. | 213.215.62.250 |
participants[]. presenceDuration | Participants | Number in milliseconds | The sum of all participants’ presence in the conference that you can use for calculating usage. | 17773 |
participants[]. recvTimers.VIDEO | Participants | Number in milliseconds | The time spent on receiving video during the conference. | 12425 |
participants[]. recvTimers.AUDIO | Participants | Number in milliseconds | The time spent on receiving audio during the conference. | 15310 |
participants[]. sendTimers.VIDEO | Participants | Number in milliseconds | The time spent on sending video during the conference. | 12425 |
participants[]. sendTimers.AUDIO | Participants | Number in milliseconds | The time spent on sending audio during the conference. | 15310 |
participants[]. metadata. preferSendMono | Participants | Boolean | Information whether the participant sent mono sound to the conference. | false |
participants[]. metadata. externalName | Participants | String | The external identifier of the participant. | [email protected] |
participants[]. metadata. externalPhotoUrl | Participants | String | The participants' avatar URL. | - |
participants[]. metadata. simulcast | Participants | Boolean | Information whether the participant used Simulcast. | false |
participants[]. metadata. preferRecvMono | Participants | String | Information whether the participant received mono sound. | false |
region | Root | String | The conference creation region. The possible values are: ca : Canada, us : United States, eu : Europe, in : India, au : Australia | eu |
recordingFormat | Root | String | The selected recording format, either audio , video , or both . | both |
dolbyVoice | Root | Boolean | Information weather Dolby Voice was enabled for the conference. | true |
Updated 4 months ago