Add an Instant Conference

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

Request URL

{base_url}/{api_path}/instant_conference/start?token={token}

Request parameters

Parameter Required Type Description
number Yes String Number of an instant conference.
Note:

The number must be idle. Other conferences, instant conferences, or features can not use the number.

name Yes String Name of an instant conference.
moderators Yes Integer Moderator of an instant conference.

Valid values:

  • An extension number: Set a moderator only.
  • Multiple extension numbers: Set multiple moderators. Separate multiple extension numbers with ,.
    Note: To successfully add an instant conference, at least one moderator should be in the conference.
members Yes String Members of an instant conference.

Valid value:

Support to enter both internal and external numbers. Separate multiple numbers with ,.

dialpermission Yes String

Use which extension's call permission to invite members to join the conference.

Note: If members includes external numbers, dialpermission must be the extension which is of outbound call permission.

Response parameters

Parameter Type Description
status String Response status.
  • Success
  • Failed

Examples

Request example

POST /api/v2.0.0/instant_conference/start?token=721eebe15cb3c27b60daeb1f120f0c05
Content-Type:application/json; charset=utf-8
Host: api.yeastarcloud.com

{
	"number": "6466",
	"name": "6466",
	"members": "4000,4001",
	"moderators": "4000",
	"dialpermission": "4000"
}
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"
}