Query in-session Conference
Query settings of an in-session conference, multiple in-session conferences, or all in-session conferences. You can query both conferences and instant conferences.
Request URL
{base_url}/{api_path}/conference/query_in_session?token={token}
Request parameters
Parameter | Required | Type | Description |
---|---|---|---|
number | Yes | String | Number of in-session conference. Valid values:
|
Response parameters
Parameter | Type | Description |
---|---|---|
status | String | Request result.
|
conference | Array <ConferenceInfo> | Information of in-session conference. |
- ConferenceInfo
-
Parameter Type Description callid String The unique ID of each call. conferencenumber Integer In-session conference number. conferencename String In-session conference name. members Array <MemberType> Member information.
- MemberType
-
Parameter Type Description outbound Array <OutboundInfo> Outbound information. inbound Array <InboundInfo> External number calls to the conference. ext Array <ExtensionInfo> Extension information.
- OutboundInfo
-
Parameter Type Description from Integer The caller number. to String The callee number. trunkname String The name of the trunk which is used for the call. channelid String The call channel ID of each member during the call. memberstatus String Member status. - ANSWER: The member accepts the invitation, and joins the conference.
- ANSWERED: The member dials the conference number, and joins the conference.
- HOLD: The member is in the conference, waiting for the moderator.
- InboundInfo
-
Parameter Type Description from Integer The caller number. to String The callee number. trunkname String The name of the trunk which is used for the call. channelid String The call channel ID of each member during the call. memberstatus String Member status. - ANSWER: The member accepts the invitation, and joins the conference.
- ANSWERED: The member dials the conference number, and joins the conference.
- HOLD: The member is in the conference, waiting for the moderator.
- ExtensionInfo
-
Parameter Type Description number String Extension number. channelid String The call channel ID of each member during the call. memberstatus String Member status. - ANSWER: The member accepts the invitation, and joins the conference.
- ANSWERED: The member dials the conference number, and joins the conference.
- HOLD: The member is in the conference, waiting for the moderator.
Examples
Request example
Query detailed settings of in-session conference 6410.
POST /api/v2.0.0/conference/query_in_session?token=3ddc40cf73c8ed477e4e466b044e9c89 Content-Type:application/json; charset=utf-8 Host: 192.168.5.150 { "number": "6410" }Response example
HTTP/1.1 200 OK Server: Boa/0.94.14rc21 Accept-Ranges: bytes Connection: close Content-Type: application/json Access-control-allow-origin: * Access-control-allow-methods: GET, POST, OPTIONS, PUT, DELETE { "status": "Success", "conference": [ { "callid": "1573465840.181", "conferencenumber": "6400", "conferencename": "6400", "members": [ { "ext": { "number": "4003", "channelid": "PJSIP/4003-00000036", "memberstatus": "ANSWERED" } }, { "ext": { "number": "4001", "channelid": "PJSIP/4001-00000035", "memberstatus": "ANSWERED" } }, { "inbound": { "from": "3000", "to": "6400", "trunkname": "To6.36", "channelid": "PJSIP/trunk-To6.36-endpoint-00000037", "memberstatus": "ANSWERED" } } ] } ] }