Park a Call
Park an active call to a specific parking slot.
Request URL
POST {base_url}/{api_path}/call/park?access_token={access_token}
Request parameters
Parameter | Required | Type | Description |
---|---|---|---|
channel_id | Yes | String | The call channel ID of the parked party. Note: You can obtain the call channel ID in
the (30011) Call Status Changed
event. |
parking_slot | No | String | Specify a parking slot number to park the call. Note: If this parameter is left blank, the
system will automatically assign an idle parking slot
number. |
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. |
parking_slot | String | Parking slot number, the call was parked to this parking slot. |
Examples
Request example
Park the call between extension 2005 and extension 2008 to a parking slot 6000, in which the parked party is 2005.
POST /openapi/v1.0/call/park?access_token=5PqRn8K4vQdOjCa1lu0ppX6ZwREXicCW HTTP/1.1 Host: 192.168.5.150:8088 Content-Type: application/json { "channel_id": "PJSIP/2005-00000081", "parking_slot": "6000" }
Response example
The call is parked, the parked party 2005 is on hold, and the extension 2008 hears a prompt that informs the call parking slot number.
HTTP/1.1 200 OK { "errcode": 0, "errmsg": "SUCCESS", "call_id": "1651497945.90", "parking_slot": "6000" }
Retrieve a parked call
To retrieve a parked call, you can use the API request call/dial
to
dial the call parking slot number.
For more information, see Make a Call.