Hold a Call

Hold an active call.

Request URL

{base_url}/{api_path}/call/hold?token={token}

Request parameters

Parameter Required Type Description
channelid Yes String The call channel ID of each member during the call.

Response parameters

Parameter Type Description
status String Request result.
  • Success
  • Failed
callid String The unique ID of each call.

Examples

Request example

POST /api/v2.0.0/call/hold?token=3c423b4c0e7cab4e164a01523b8ac512 HTTP/1.1
Content-Type:application/json; charset=utf-8
Host: 192.168.5.150

{
     "channelid": "PJSIP/1023-00000030"
}
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",
    "callid":"1571625574.80"
}