Response Format

ParameterTypeDescription
roomIDStringThe unique ID of the conference call room.
fromEIDStringThe unique ID of the staff who started the conference call.
statusStringThe current status of the conference. It can be "Success".
createdAtStringThe 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.
callDurationNumberThe duration of the call is in seconds.
callDurationMinNumberThe duration of the conference call is in minutes.
callDateStringThe start date and time of the conference. The value must be in RFC3339 format, e.g. 2022-11-07T00:00:00.000Z.
conferenceIDStringThe unique ID of the conference.
callConferenceList.hidStringThe unique history ID of each participant in the conference.
callConferenceList.roomIDStringThe unique room ID of each participant in the conference.
callConferenceList.fromEIDStringThe EID of the caller in each participant in the conference.
callConferenceList.toEIDStringThe EID of the callee in each participant in the conference.
callConferenceList.fromSvcIDStringThe service ID of each participant in the conference.
callConferenceList.content.byeReasonStringThe 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.callDurationNumberThe duration of each participant in the conference is in seconds.
callConferenceList.content.callEndTimeStringThe end date and time of each participant. The value must be in RFC3339 format, e.g. 2022-11-07T00:00:00.000Z.
callConferenceList.content.callIDStringThe ID of the particular call in the conference.
callConferenceList.content.callStartTimeStringThe 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.callTypeStringThe type of the call can be "onnet"(On-net) or "offnet"(Off-net).
callConferenceList.content.from.eidStringThe unique ID of the staff who started the call.
callConferenceList.content.from.pstnStringThe PSTN number of the caller.
callConferenceList.content.from.regionStringThe service region of the conference call.
callConferenceList.content.from.serviceIdStringThe service ID of the caller ID of each participant in the conference.
callConferenceList.content.from.typeStringThe call type from the caller. It can be "eid", which means on-net , or PSTN, which means offnet.
callConferenceList.content.to.eidStringThe Staff unique ID who joined the conference call as a participant.
callConferenceList.content.to.pstnStringThe PSTN number of the callee in the individual call.
callConferenceList.content.to.regionStringThe service region. It is for internal use.
callConferenceList.content.to.serviceIDStringThe service ID of the participant in the particular call in the conference.
callConferenceList.content.to.typeStringThe call type received by the callee. It can be "eid", which means on-net , or ps,tn, which means offnet.
callConferenceList.content.statusStringThe status of the call. It can be "Call Ended" or "Success".
callConferenceList.content.typeStringThe call type received by the callee. It can be "eid", which means on-net , or PSTN, which means offnet.
callConferenceList.fromRegionStringThe service region. It is for internal use.
callConferenceList.statusStringThe status of the conference. It can be "Success" or "Call Ended".
callConferenceList.createdAtStringThe date and time of the call record creation. The value must be in RFC3339 format, e.g. 2022-11-07T00:00:00.000Z.
callConferenceList.callIDStringThe call ID of each participant in the conference.
callConferenceList.callDirectionStringThe conference's direction. It can be "inbound" (Inbound Call) or "outbound" (Outbound Call).
callConferenceList.callTypeStringThe type of the conference. It can be "onnet" (On-net) or "offnet" (Off-net).
callConferenceList.callerStringThe caller number of the conference.
callConferenceList.callDurationintegerThe call duration is in seconds.
callConferenceList.callDurationMinintegerThe call duration is in minutes.
callConferenceList.callDateStringThe 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.callEndTimeStringThe end date and time of the call. The value must be in RFC3339 format, e.g. 2022-11-07T00:00:00.000Z.
callConferenceList.byeReasonStringThe reason for ending the conference. Please refer to the Bye Reason and Last Response Code for details.
callConferenceList.mediaTypeStringThe media type of each participant. It can be "audio" or "video".
callConferenceList.conferenceIDStringThe ID of the conference.
callConferenceList.callerCallIDStringThe call ID of the caller of each participant.
callConferenceList.sourceStringThe 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.endByStringThe staff who ended the call. Represented with a unique ID.
callConferenceList.cdrTypeStringThe Call Detail Record (CDR) Type is "conference".
conferenceDetail.allowParticipantUnmuteBooleanIt is for internal use.
conferenceDetail.callConferenceIDStringThe ID of the conference. It is for internal use.
conferenceDetail.createdAtStringThe 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.dialStringStringThe unique identifier or address that allows participants to join a conference call. It is for internal use.
conferenceDetail.isRecordingBooleanTrue = the conference was recorded; False =
the conference was not recorded. It is for internal use.
conferenceDetail.muteOnEntryBooleanIt must be false. It is for internal use.
conferenceDetail.originRoomIDStringThe source/origin room ID before the room was turned into a conference room. It is for internal use.
conferenceDetail.participants.cameraOpensBooleanTrue = the participant's camera was opened; False = the participant's camera was not opened. It is for internal use.
conferenceDetail.participants.eidStringThe EID of the conference participant. Represented as a staff ID. It is for internal use.
conferenceDetail.participants.inviterStringThe ID of the staff who invited another member to join the conference. It is for internal use.
conferenceDetail.participants.joinStatusStringThe status of the participants in the conference. "joined" means the participant joined the conference. It is for internal use.
conferenceDetail.participants.microphoneMuteBooleanTrue = microphones of the participants are muted.
False = microphones of the participants are not muted. It is for internal use.
conferenceDetail.participants.raisingHandBooleanIt must be false. It is for internal use.
conferenceDetail.participants.roomRoleStringThe role of the participants. It can be "owner"(Host), "deputy"(Co-host) or "visitor"(Participant). It is for internal use.
conferenceDetail.presenterStringIt is for internal use.
conferenceDetail.serviceIdStringThe service ID of the conference. It is for internal use.
conferenceDetail.subjectStringThe subject of the conference. It is for internal use.
conferenceDetail.updatedAtStringThe date and time of the conference records were updated. It is for internal use.
conferenceDetail.weblinkSetting.enableBooleanTrue = enabled the sharing of the conference link.
False = disabled the sharing of the conference link. It is for internal use.
conferenceDetail.weblinkSetting.linkStringThe URL of the conference link. It is for internal use.
conferenceDetail.weblinkSetting.smsVerifyRequiredBooleanTrue = SMS verification is required.
False = SMS verification is not required.
It is for internal use.
conferenceDetail.weblinkSetting.tokenStringA unique identifier is used to verify and authenticate a user's access to the conference. It is for internal use.
Language