API call EN: различия между версиями

Материал из WiKi - UserSide
(Fix Ukrainian API localization)
([IronBot] Sync EN localization from RU)
 
Строка 11: Строка 11:


==== add ====
==== add ====
''Improved in: 3.21.0 (added line parameter)''


''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)''
''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)''
Строка 24: Строка 26:
   date_add - call date
   date_add - call date
   direction - call direction ''(in|out)''
   direction - call direction ''(in|out)''
  line - number or name of the incoming line for an incoming call, or outgoing line number for an outgoing call
   phone_system_uuid - call ID in the external telephony system
   phone_system_uuid - call ID in the external telephony system
<span id="agent_call"></span>
==== dial ====
''Added in: 3.21.0''
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:
  line - number or name of the incoming line for an incoming call, or outgoing line number for an outgoing call
  number - caller's number
==== edit ====
''Added in: 3.21.10''
Description: Editing a call
Required parameters:
  id - call id
Optional parameters:
  description - comment text
  description_employee_id - id of the employee who left the comment


==== get ====
==== get ====
Строка 60: Строка 88:
  Optional parameters:
  Optional parameters:
   answer_number - called number
   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

Текущая версия от 13:10, 12 июля 2026

en | uk | ru

Section API ERP "UserSide"

Purpose: Calls

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

Subcategories

add

Improved in: 3.21.0 (added line parameter)

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)
 line - number or name of the incoming line for an incoming call, or outgoing line number for an outgoing call
 phone_system_uuid - call ID in the external telephony system

dial

Added in: 3.21.0

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:
 line - number or name of the incoming line for an incoming call, or outgoing line number for an outgoing call
 number - caller's number

edit

Added in: 3.21.10

Description: Editing a call
Required parameters:
 id - call id
Optional parameters:
 description - comment text
 description_employee_id - id of the employee who left the comment

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