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

Материал из WiKi - UserSide
(Новая страница: «en | ru Section '''API''' ERP "UserSide"»)
 
Нет описания правки
 
Строка 2: Строка 2:


Section '''[[API_EN|API]]''' ERP "UserSide"
Section '''[[API_EN|API]]''' ERP "UserSide"
Purpose: Calls
Additional parameters:
action - request subcategory ''(possible value: see below)''
== Subcategories ==
==== add ====
''Added in: 3.18beta1''
Description: Create a call record
Obligatory parameters:
  number - incoming call number
Optional parameters:
  date_add - date of the call
  phone_system_uuid - call ID in external telephony system
  answer_number - called number
==== get ====
'' Added in: 3.16dev3''
Description: Call list
Obligatory 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
Obligatory 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
Obligatory parameters:
  id - call id
OR
  phone_system_uuid - call ID in external telephony system
Optional parameters:
  answer_number - called number

Текущая версия от 15:37, 28 июля 2023

en | ru

Section API ERP "UserSide"

Purpose: Calls

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

Subcategories

add

Added in: 3.18beta1

Description: Create a call record
Obligatory parameters:
 number - incoming call number
Optional parameters:
 date_add - date of the call
 phone_system_uuid - call ID in external telephony system
 answer_number - called number

get

Added in: 3.16dev3

Description: Call list
Obligatory 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
Obligatory 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
Obligatory parameters:
 id - call id
OR
 phone_system_uuid - call ID in external telephony system
Optional parameters:
 answer_number - called number