Current Calls (/current_calls/)

Owned by esnata (Unlicensed)
Last updated: Jun 30, 2021
2 min read

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 

Name 

Type 

Description 

Name 

Type 

Description 

answer_time_gmt 

string 

Date and time the call was answered 

call_api_id 

string 

Identifier of the call for subsequent control 

call_flow 

string 

Call direction. It takes the value in or out 

callback_id  

string 

Identifier of the call back 

called_did 

string 

External number that was called 

called_extension 

array 

Information on the called extension number 

called_number 

string 

Dialed number 

caller_extension 

array 

Information on the caller extension number 

caller_id_name 

string 

Caller name 

caller_id_number 

string 

Caller number 

extension_id  

long 

Identifier of the extension number 

init_time_gmt 

string 

Call initialization date and time 

real_call 

boolean 

If the value is false, although the call is assigned to the extension number, it does not dialog (for example, the call was forwarded to a mobile number) 

record_uuid 

string 

Identifier of the conversation record 

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 

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} 

"Client" Section Resources 

GET /client/{client_id}/current_calls/ 

Get the call list for all client extension numbers of the "telephone terminal" type 

URL Options 

Name 

Type 

Name 

Type 

client_id 

string 

Response Fields 

Name 

Type 

Name 

Type 

call_list 

array 

Array 

Name 

Type 

Name 

Type 

answer_time_gmt  

string 

call_api_id  

string 

call_flow 

string 

callback_id  

string 

called_did  

string 

called_extension  

array 

called_number  

string 

caller_extension  

array 

caller_id_name  

string 

caller_id_number  

string 

extension_id  

long 

init_time_gmt 

string 

real_call  

boolean 

record_uuid  

string 

"Extension Number” Section Resources 

GET /extension/{extension_id}/current_calls/ 

Get the call list for the client extension number of the "telephone terminal" type 

URL Options 

Name 

Type 

Name 

Type 

extension_id 

string 

Response Fields 

Name 

Type 

Name 

Type 

call_list 

array 

Array 

Name 

Type 

Name 

Type 

answer_time_gmt  

string 

call_api_id  

string 

call_flow 

string 

callback_id  

string 

called_did  

string 

called_extension  

array 

called_number  

string 

caller_extension  

array 

caller_id_name  

string 

caller_id_number  

string 

extension_id  

long 

init_time_gmt 

string 

real_call  

boolean 

record_uuid  

string 

PUT /extension/{extension_id}/current_calls/{call_api_id} 

Update the current call 

URL Options 

Name 

Type 

Name 

Type 

call_api_id 

string 

extension_id 

string 

JSON Options 

Name 

Type 

Name 

Type 

action 

string 

send_dst 

string 

caller_id_name  

string 

caller_id_number  

string 

GET /extension/{extension_id}/current_calls/{call_api_id} 

Get the current call information for the extension number of the "telephone terminal" type by call_api_id 

URL Options 

Name 

Type 

Name 

Type 

call_api_id 

string 

extension_id 

string 

Response Fields 

Name 

Type 

Name 

Type 

answer_time_gmt  

string 

call_api_id  

string 

call_flow 

string 

callback_id  

string 

called_did  

string 

called_extension  

array 

called_number  

string 

caller_extension  

array 

caller_id_name  

string 

caller_id_number  

string 

extension_id  

long 

init_time_gmt 

string 

real_call  

boolean 

record_uuid  

string