Add a Scheduled Conference

Add a scheduled conference.

Request URL

POST {base_url}/{api_path}/conference/create?access_token={access_token}

Request parameters

Parameter Required Type Description
number Yes String Conference number.
Note: Only numeric characters are supported, and the length of the number should be less than 7.
name Yes String Conference name.
Note: The length of the name should be less than 127.
partic_password No String Specify the password required for participants to join the conference.
Note: The length of the password should be less than 15.
moderator_password No String Specify the password required for users to join the conference as moderators.
Note: The length of the password should be less than 15.
sound_prompt No String Specify the prompt to announce to the participants when someone joins or exits from the conference call.
Valid value:
  • default: Prompt a tone when participant joins or exits from conference.
  • ext_number: Prompt the extension number of the participant when the participant joins or exits from conference.
enb_custom_language No Integer Whether to enable custom prompt language for the conference call.
Valid value:
  • 0: Disable.
  • 1: Enable.
prompt_language No String Specify the custom prompt language.

Valid value: The prompt language existed in PBX System Prompt.

Note: You can query the available system prompt languages using Get Menu Options ("menu":"system_prompt").
enb_wait_moderator No Integer Whether participants should wait for the moderator to start the conference.
Valid value:
  • 0: Disable.
  • 1: Enable. The conference will start only when a moderator joins the conference.
allow_partic_invite No Integer Whether to allow the extension participants to invite users to join the conference.
Valid value:
  • 0: Disable.
  • 1: Enable. Extension participants can press # to invite others to join the conference.
moderator_list No Array <String> The ID list of the conference moderators.
Note:
  • You can assign either extensions or extension groups as moderators. Use Get Menu Options to query the specific IDs.
  • Use commas to separate multiple IDs. E.g. ["149","131"].

Response parameters

Table 1.
Parameter Type Description
id Integer The unique ID of the conference.
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.

Examples

Request example

POST /openapi/v1.0/conference/create?access_token=InOCBejKj6m3hrSmWU7XWdCq1npfeyos HTTP/1.1
Host: 192.168.5.150:8088
Content-Type: application/json

{
    "number": "6507",
    "name": "Regional Sales Strategy Session",
    "partic_password": "1234",
    "moderator_password": "2234",
    "sound_prompt": "default",
    "prompt_language": "sound-en",
    "enb_wait_moderator": 1,
    "enb_custom_language": 1,
    "allow_partic_invite": 1,
    "moderator_list": ["149","131"]
}

Response example

HTTP/1.1 200 OK
{
    "id": 6,
    "errcode": 0,
    "errmsg": "SUCCESS"
}