Hold a Call
Hold an active call.
Request URL
POST {base_url}/{api_path}/call/hold?access_token={access_token}
Request parameters
Parameter | Required | Type | Description |
---|---|---|---|
channel_id | Yes | String | The call channel ID of the member that wants to hold the
call. Note: You can obtain the call
channel ID in the (30011) Call Status Changed
event. |
Response parameters
Parameter | Type | Description |
---|---|---|
errcode | Integer | Returned error code.
Note: You can check the error code and
error message in Error Code and Error Message.
|
errmsg | String | Returned message.
|
call_id | String | The unique ID of each call. |
Examples
Request example
Extension 1005 and extension 1009 are in a call, and extension 1005 holds the call.
POST /openapi/v1.0/call/hold?access_token=Ey7Ty0kL7bpOfPHgpJH2Qq4ozMvU4IEs HTTP/1.1 Host: 192.168.5.150:8088 Content-Type: application/json { "channel_id": "PJSIP/1005-00000023" }
Response example
HTTP/1.1 200 OK { "errcode": 0, "errmsg": "SUCCESS", "call_id": "1648627871.65" }