get https://examplebaseURL.com/v1/api/apps//data/conference-detail
Response Format
| Parameter | Type | Description |
|---|---|---|
| roomID | String | The unique ID of the conference call room. |
| fromEID | String | The unique ID of the staff who started the conference call. |
| status | String | The current status of the conference. It can be "Success". |
| createdAt | String | The date and time of the conference record creation in the system. The value must be in RFC3339 format, e.g. 2022-11-07T00:00:00.000Z. |
| callDuration | Number | The duration of the call is in seconds. |
| callDurationMin | Number | The duration of the conference call is in minutes. |
| callDate | String | The start date and time of the conference. The value must be in RFC3339 format, e.g. 2022-11-07T00:00:00.000Z. |
| conferenceID | String | The unique ID of the conference. |
| callConferenceList.hid | String | The unique history ID of each participant in the conference. |
| callConferenceList.roomID | String | The unique room ID of each participant in the conference. |
| callConferenceList.fromEID | String | The EID of the caller in each participant in the conference. |
| callConferenceList.toEID | String | The EID of the callee in each participant in the conference. |
| callConferenceList.fromSvcID | String | The service ID of each participant in the conference. |
| callConferenceList.content.byeReason | String | The reason for ending the 1-to-1 individual call in the conference. For details, please refer to the Bye Reason and Last Response Code table. |
| callConferenceList.content.callDuration | Number | The duration of each participant in the conference is in seconds. |
| callConferenceList.content.callEndTime | String | The end date and time of each participant. The value must be in RFC3339 format, e.g. 2022-11-07T00:00:00.000Z. |
| callConferenceList.content.callID | String | The ID of the particular call in the conference. |
| callConferenceList.content.callStartTime | String | The start date and time of each participant in microseconds. The value must be in RFC3339 format, e.g. 2022-11-07T00:00:00.000Z. |
| callConferenceList.content.callType | String | The type of the call can be "onnet"(On-net) or "offnet"(Off-net). |
| callConferenceList.content.from.eid | String | The unique ID of the staff who started the call. |
| callConferenceList.content.from.pstn | String | The PSTN number of the caller. |
| callConferenceList.content.from.region | String | The service region of the conference call. |
| callConferenceList.content.from.serviceId | String | The service ID of the caller ID of each participant in the conference. |
| callConferenceList.content.from.type | String | The call type from the caller. It can be "eid", which means on-net , or PSTN, which means offnet. |
| callConferenceList.content.to.eid | String | The Staff unique ID who joined the conference call as a participant. |
| callConferenceList.content.to.pstn | String | The PSTN number of the callee in the individual call. |
| callConferenceList.content.to.region | String | The service region. It is for internal use. |
| callConferenceList.content.to.serviceID | String | The service ID of the participant in the particular call in the conference. |
| callConferenceList.content.to.type | String | The call type received by the callee. It can be "eid", which means on-net , or ps,tn, which means offnet. |
| callConferenceList.content.status | String | The status of the call. It can be "Call Ended" or "Success". |
| callConferenceList.content.type | String | The call type received by the callee. It can be "eid", which means on-net , or PSTN, which means offnet. |
| callConferenceList.fromRegion | String | The service region. It is for internal use. |
| callConferenceList.status | String | The status of the conference. It can be "Success" or "Call Ended". |
| callConferenceList.createdAt | String | The date and time of the call record creation. The value must be in RFC3339 format, e.g. 2022-11-07T00:00:00.000Z. |
| callConferenceList.callID | String | The call ID of each participant in the conference. |
| callConferenceList.callDirection | String | The conference's direction. It can be "inbound" (Inbound Call) or "outbound" (Outbound Call). |
| callConferenceList.callType | String | The type of the conference. It can be "onnet" (On-net) or "offnet" (Off-net). |
| callConferenceList.caller | String | The caller number of the conference. |
| callConferenceList.callDuration | integer | The call duration is in seconds. |
| callConferenceList.callDurationMin | integer | The call duration is in minutes. |
| callConferenceList.callDate | String | The start date and time of each participant are in milliseconds. The value must be in RFC3339 format, e.g. 2022-11-07T00:00:00.000Z. |
| callConferenceList.callEndTime | String | The end date and time of the call. The value must be in RFC3339 format, e.g. 2022-11-07T00:00:00.000Z. |
| callConferenceList.byeReason | String | The reason for ending the conference. Please refer to the Bye Reason and Last Response Code for details. |
| callConferenceList.mediaType | String | The media type of each participant. It can be "audio" or "video". |
| callConferenceList.conferenceID | String | The ID of the conference. |
| callConferenceList.callerCallID | String | The call ID of the caller of each participant. |
| callConferenceList.source | String | The value can be: - CREATE_CONF (The participant created the conference) - INVITE (Joined the call by invitation) - WEBLINK (Joined the call by via the weblink) - JOIN_GROUP (Joined the private or public space when the space starts a conference) - SCHEDULE_REVOKE (Joined the scheduled conference after Revoking) - SCHEDULE_JOIN (Joined the scheduled conference) - PSTN (Joined the call via the PSTN number) |
| callConferenceList.endBy | String | The staff who ended the call. Represented with a unique ID. |
| callConferenceList.cdrType | String | The Call Detail Record (CDR) Type is "conference". |
| conferenceDetail.allowParticipantUnmute | Boolean | It is for internal use. |
| conferenceDetail.callConferenceID | String | The ID of the conference. It is for internal use. |
| conferenceDetail.createdAt | String | The date and time of the conference. The value must be in RFC3339 format, e.g. 2022-11-07T00:00:00.000Z. It is for internal use. |
| conferenceDetail.dialString | String | The unique identifier or address that allows participants to join a conference call. It is for internal use. |
| conferenceDetail.isRecording | Boolean | True = the conference was recorded; False = the conference was not recorded. It is for internal use. |
| conferenceDetail.muteOnEntry | Boolean | It must be false. It is for internal use. |
| conferenceDetail.originRoomID | String | The source/origin room ID before the room was turned into a conference room. It is for internal use. |
| conferenceDetail.participants.cameraOpens | Boolean | True = the participant's camera was opened; False = the participant's camera was not opened. It is for internal use. |
| conferenceDetail.participants.eid | String | The EID of the conference participant. Represented as a staff ID. It is for internal use. |
| conferenceDetail.participants.inviter | String | The ID of the staff who invited another member to join the conference. It is for internal use. |
| conferenceDetail.participants.joinStatus | String | The status of the participants in the conference. "joined" means the participant joined the conference. It is for internal use. |
| conferenceDetail.participants.microphoneMute | Boolean | True = microphones of the participants are muted. False = microphones of the participants are not muted. It is for internal use. |
| conferenceDetail.participants.raisingHand | Boolean | It must be false. It is for internal use. |
| conferenceDetail.participants.roomRole | String | The role of the participants. It can be "owner"(Host), "deputy"(Co-host) or "visitor"(Participant). It is for internal use. |
| conferenceDetail.presenter | String | It is for internal use. |
| conferenceDetail.serviceId | String | The service ID of the conference. It is for internal use. |
| conferenceDetail.subject | String | The subject of the conference. It is for internal use. |
| conferenceDetail.updatedAt | String | The date and time of the conference records were updated. It is for internal use. |
| conferenceDetail.weblinkSetting.enable | Boolean | True = enabled the sharing of the conference link. False = disabled the sharing of the conference link. It is for internal use. |
| conferenceDetail.weblinkSetting.link | String | The URL of the conference link. It is for internal use. |
| conferenceDetail.weblinkSetting.smsVerifyRequired | Boolean | True = SMS verification is required. False = SMS verification is not required. It is for internal use. |
| conferenceDetail.weblinkSetting.token | String | A unique identifier is used to verify and authenticate a user's access to the conference. It is for internal use. |