API call EN

en | uk | ru

Section API ERP "UserSide"

Purpose: Calls

Additional parameters:
action - request subcategory (possible value: see below)

Subcategories

add

Improved in: 3.20.23 (added the caller_id_name and direction parameters, added the ability to update a call record based on phone_system_uuid)

Added in: 3.18beta1

Description: Creating a call record / updating call information based on phone_system_uuid
Required parameters:
 number - caller's number
Optional parameters:
 answer_number - called number
 caller_id_name - caller's name
 date_add - call date
 direction - call direction (in|out)
 phone_system_uuid - call ID in the external telephony system

get

Added in: 3.16dev3

Description: Call list
Required parameters:
 None
Optional parameters:
 date_from - date and time of the call (from)
 date_to - date and time of the call (to)

hangup

Added in: 3.18beta1

Description: Fixing the fact that a call has ended
Required parameters:
 id - call id
OR
 phone_system_uuid - call ID in external telephony system
Optional parameters:
 record_url - reference to the call record

transfer_call

Added in: 3.18beta1

Description: Transmit information and call to another employee
Required parameters:
 id - call id
OR
 phone_system_uuid - call ID in external telephony system
Optional parameters:
 answer_number - called number

agent_call

Added in: 3.20.23

Description: Transfer an incoming call to the recipient (the call has not been answered yet)
Required parameters:
 phone_system_uuid - call ID in the external telephony system
 answer_number - called number
Optional parameters:
 number - caller number