Invite Conference Members

Invite internal or external users to join a conference.

Request URL

{base_url}/{api_path}/conference/add_member?token={token}

Request parameters

Parameter Required Type Description
number Yes String Conference number, which means members will be invited to which conference.
operator Yes Integer Operator number, which means who will invite conference members.
Note: Only moderators have permissions to invite conference members.
invitemember Yes Integer The number of member who will be invited to the conference. You can invite internal or external users.

Valid values:

  • A number: Invite a member to the conference.

    Example: "invitemember":"2023"

  • Multiple numbers: Invite multiple members to the conference. Separate multiple numbers with ,.

    Example: "invitemember":"2023,2024"

dialpermission Yes Integer

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 Request result.
  • Success
  • Failed

Examples

Request example

Invite internal extension 4001 to join conference 6400.

POST /api/v2.0.0/conference/add_member?token=721eebe15cb3c27b60daeb1f120f0c05
Content-Type:application/json; charset=utf-8
Host: 192.168.5.150

{
	"number": "6400",
	"operator": "4000",
	"invitemember": "4001",
	"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"
}