Current Calls (/current_calls/)
You can test API methods on the interactive API browser page and without writing code
Some of the resources described on the page may not be available by default due to the type of application (see Creating and authorizing applications).
This resource allows you to get information about the current calls of all client extension numbers of the "telephone terminal" type or of a specific extension number of the "telephone terminal" type as well as to control these calls.
Description of Data Structures
Call Control
To update the current call, you need to make an API request PUT to the following URL, specifying the extension_id and call_api_id:
PUT /extension/{extension_id}/current_calls/{call_api_id}
The action and send_dst options are required to be passed in the request body.
Call Control Actions
Action | Description |
---|---|
transfer | "Blind" call transfer to the number specified in send_dst |
attended_transfer | "Attended" call transfer to the number specified in send_dst |
eavesdrop | Listening to the call. When an API request is made, the number specified in send_dst is called, and when the handset is picked up, the subscriber hears a telephone conversation |
whisper | Communication with the call participant (whisper). When an API request is made, the number specified in send_dst is called; when the handset is picked up, the subscriber can communicate with the call participant |
conference | Communication with both call participants (conference). When an API request is made, the number specified in send_dst is called; when the handset is picked up, the subscriber can communicate with both call participants |
hold | Call holding |
offhold | Call off-holding |
park | Parking of the call |
pickup | Call pickup. When an API request is made, the number specified in send_dst is called; when the handset is picked up, the subscriber connects with the call participant |
Call Interruption
To interrupt the current call, you need to make an API request DELETE to the following URL, specifying the extension_id and call_api_id:
DELETE /extension/{extension_id}/current_calls/{call_api_id}