Add an Instant Conference

Add and configure an instant conference, and invite members to join the conference in real time.

Request URL

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

Request parameters

Parameter Required Type Description
number Yes String The number of an instant conference.
Note:
  • The number MUST be outside the extension number range defined in PBX Settings > Preferences > Extension Preferences.
  • The number must be idle and not be used by other scheduled conferences, instant conferences, or system features.
name Yes String Name of the instant conference.
members Yes Array<String> Members of the instant conference.
Note:
  • Support both extension numbers and external numbers。
  • Use commas to separate multiple numbers.
moderators Yes Array<String> Moderator of an instant conference.
Note:
  • Only extension users can be the conference moderators.
  • Use commas to separate multiple numbers.
dialpermission Yes String Specify the extension whose call permission is used to place calls inviting members to join the conference.
Note: If members includes external numbers, dialpermission must be the extension which has outbound call permission.

Response parameters

Table 1.
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.

Examples

Request example

POST /openapi/v1.0/conference/start_interim_conference?access_token=D2v9gItHA3MRx9akQiTot9zJei5CyRfr HTTP/1.1

Host: yeastardocs.example.yeastarcloud.com
Content-Type: application/json

{
    "number": "6901",  
    "name": "Instant conference",    
    "members": ["1001","1003","1007","5503309" ],
    "moderators": ["1001" ],
    "dialpermission": "1001"
}

Response example

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