Kick Conference Members

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

Request URL

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

Request parameters

Parameter Required Type Description
number Yes String Conference number, which means members will be kicked out of which conference.
operator Yes Integer Operator number, which means who will kick conference members.
Note: Only moderators have permissions to kick conference members.
membernumber Yes Integer Member's number.

Valid values:

  • A number: Kick the specified member.

    Example: "membernumber":"4000"

  • Multiple numbers: Kick multiple members. Separate multiple numbers with ,.

    Example: "membernumber":"4000,4001"

  • all: Kick all members.

    Example: "membernumber":"all"

Response parameters

Parameter Type Description
status String Request result.
  • Success
  • Failed

Examples

Request example

Kick extension 4001 out of conference 6400.
POST /api/v2.0.0/conference/kick_member?token=721eebe15cb3c27b60daeb1f120f0c05
Content-Type:application/json; charset=utf-8
Host: 192.168.5.150

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