Query Information of a Scheduled Conference

Query the information of a specific scheduled conference.

Request URL

GET {base_url}/{api_path}/conference/get?access_token={access_token}

Request parameters

Parameter	Required	Type	Description
id	Yes	Integer	The ID of the conference. Note: You can query the conference ID using Search Specific Scheduled Conferences.

Response parameters

Parameter	Type	Description
errcode	Integer	Returned error code. 0: Succeed. Non-zero value: Failed. Note: You can check the error code and error message in Error Code and Error Message.
errmsg	String	Returned message. SUCCESS: Succeed. FAILURE: Failed.
data	Object <Conference_Info>	The detailed information of the conference.

Conference_Info

Parameter	Type	Description
id	Integer	The ID of the conference.
name	String	Conference name.
number	String	Conference number.
has_partic_password	Integer	Whether participants need to enter a password to join the conference. 0: No password. 1: Password required. Tip: You can query the participant password using Query Conference Password.
has_moderator_password	Integer	Whether a password is required to join the conference as a moderator. 0: No password. 1: Password required. Tip: You can query the moderator password using Query Conference Password.
sound_prompt	String	The prompt to announce the participants when someone joins or exits from the conference. default: The system prompts a tone when participant joins or exits from the conference. ext_number: The system prompts the extension number of the participant when the participant joins or exits from the conference.
allow_partic_invite	Integer	Whether extension participants can invite other members to join the conference. 0: Disabled. 1: Enabled. Extension participants can press # to invite others to join the conference.
enb_wait_moderator	Integer	Whether participants should wait for the moderator to start the conference. 0: Disabled. 1: Enabled. The conference will start only when a moderator joins the conference.
moderator_list	Array <Moderator_List>	The list of the moderators for the conference.
enb_custom_language	Integer	Whether a custom prompt language is set for the conference call. 0: Disabled. 1: Enabled.
prompt_language	String	The custom prompt language. sound-ar：العربية (Arabic) sound-cz：Čeština(Czech) sound-de：Deutsch (German) sound-en：English sound-en_BR：English (British) sound-es：Español/Castellano (Spanish Spain) sound-es_LT：Español latino (Spanish Latin) sound-fa：فارسی (Persian) sound-fr：Française (French) sound-gr：Ελληνικά (Greek) sound-hr：hrvatski (Croatian) sound-id：Bahasa Indonesia (Indonesian) sound-it：Italiano (Italian) sound-iw：עברית (Hebrew) sound-nl：Nederlands (Dutch) sound-pl：Polski (Polish) sound-pt：Português (Portuguese) sound-pt_BR：Português Brasil (Portuguese Brazil) sound-ro：Română (Romanian) sound-ru：Pусский (Russian) sound-sk：Slovenčina(Slovak) sound-sl：Slovenščina (Slovenian) sound-sr：Cрпски (Serbian) sound-th：ไทย (Thai) sound-tr：Türk (Turkish) sound-zh：中文 (Chinese) sound-zh_hk：粤语 (Cantonese)

Moderator_List

Parameter	Type	Description
id	String	The ID of the conference moderator.
name	String	The name of the conference moderator.
type	String	The type of the conference moderator. extension: Extension. ext_group: Extension group.

Examples

Request example

GET /openapi/v1.0/conference/get?access_token=zvSTsQu2hhnvvkznD7DaLFkpxDixBqRT&id=1 HTTP/1.1
Host: 192.168.5.150:8088

Response example

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "data": {
        "id": 1,
        "name": "Sales Weekly Meeting",
        "number": "6500",
        "has_partic_password": 1,
        "has_moderator_password": 1,
        "sound_prompt": "ext_number",
        "allow_partic_invite": 1,
        "enb_wait_moderator": 1,
        "moderator_list": [
            {
                "id": "50",
                "name": "Emily Parker",
                "type": "extension"
            }
        ],
        "enb_custom_language": 1,
        "prompt_language": "sound-en"
    }
}