Kick Conference Members

Kick a member, multiple members, or all members out of a conference.

Request URL

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

Request parameters


Parameter	Required	Type	Description
member_channel_id	Yes	String	The channel ID(s) of the member(s). Valid value: To kick a member, pass the channel ID of the member. To kick multiple members, pass the channel IDs of the members, and use commas to separate multiple IDs. To kick all members, pass the value `all`. Note: You can query the member's channel ID using Query Ongoing Conferences.
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/kick_member?access_token=InOCBejKj6m3hrSmWU7XWdCq1npfeyos HTTP/1.1

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

{
    "member_channel_id": "PJSIP/1007-00000023",
    "number": "6901"
}

Response example

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