Invite Conference Members

Invite internal or external users to join a conference.

Request URL

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

Request parameters

Parameter Required Type Description
invitemembers Yes Array <String> The numbers of the members to be invited.
Note: Use commas to separate multiple numbers. E.g. "invitemembers":["995000","1003"].
dialpermission Yes String Specify the extension whose call permission is used to place calls inviting members to join the conference.
Note: If invited members includes external numbers, dialpermission must be the extension which has outbound call permission.
number Yes String Conference number.

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/invite_member?access_token=InOCBejKj6m3hrSmWU7XWdCq1npfeyos HTTP/1.1

Host: yeastardocs.example.yeastarcloud.com
Content-Type: application/json
{
    "dialpermission": "1001",
    "invitemembers":["995000"],
    "number": "6901"
}

Response example

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