Параметры функции

При вызове функции она получает объект с информацией о звонке, настройках и контексте звонка. Вы можете использовать эту информацию для логики ваших функций.

• call_args - поля с информацией о звонке;
• context - информация с результатами других функций;
• settings - актуальные значения настроек основной интеграции;

Пример объекта, передаваемого в качестве аргумента в функцию.

{
    "call_args": {
        "call_id": "1606738715.3334",
        "dst_type": 1,
        "dst_num": "74996470000",
        "src_type": 1,
        "src_num": "74996470001",
        "timestamp": "1606738715",
        "tree_name": "Входящая",
        "tree_number": "000900001"
    },
    "context": {
        "timestamp_start": "1606738715"
    },
    "settings": {
        "domain": "mycompany.amocrm.ru",
        "incoming_create_deal": true,
        "incoming_create_contact": true,
        "incoming_create_task": true,
        "outgoing_create_deal": false,
        "outgoing_create_contact": true
    }
}

Описание полей

call_args

Поле	Пример значения	Описание
call_id	1606738715.3334	Уникальный идентификатор звонка. Не меняется для всех функций обрабатывающих один звонок
dst_num	“74953210000” или “103”	Номер назначения, может быть внешний или внутренний номер.
dst_type	1 или 2	Тип номера назначения, 1-внешний 2-внутрненний.
src_num	“74996470001” или “103”	Номер источника, может быть внешний или внутренний номер
src_type	1 или 2	Тип номера назначения, 1-внешний 2-внутрненний
tree_name	“Тех поддержка”	Название схемы, которая в данный момент обрабатывает событие. См. также first_tree_name в таблице context
tree_number	“000900001”	Номер схемы, которая в данный момент обрабатывает событие.
timestamp	“1606738715”	Время начала события.

Значения полей dst_num и src_num зависят от события, для которого выполняется функция. (Событие выбирается при создании функции) В следующей таблице показаны варианты:

Событие	dst_num	src_num
Входящий звонок на внешний номер	Свой внешний номер	Номер абоненнта
Входящий звонок на внутренний номер	Свой внутренний номер	Номер абоненнта
Исходящий звонок	Номер абонента	Свой внутренний номер

context

Поля в context появляются по мере прохождения звонка. Некоторые поля могут быть недоступны, например contact_id.

Поле	Пример значения	Описание
timestamp_start	“1606738715”	Время поступления звонка. Может быть использовано в событии поднятия трубки, чтобы определить время до подняния трубки.
first_tree_name	“Входящая”	Название первой схемы, на которую поступил звонок.
first_tree_number	“000900021”	Номер первой схемы, на которую поступил звонок.
contact_id	33213	Идентификатор найденного или созданного контакта. Это поле зависит от того разрешено ли создание контакта.

settings

Это поле зависит от crm, для которой вызывается функция. Ниже пример некоторых полей для amocrm. Поля отражают текущие настройки интеграции в личном кабинете.

Поле	Пример значения	Описание
domain	“mycompany.amocrm.ru”	Домен amoCRM, требуется для вызовов API amoCRM
incoming_create_deal	true или false	Создавать ли сделку при входящем
incoming_create_contact	true или false	Создавать ли контакт при входящем
incoming_create_task	true или false	Создавать ли задачу при пропущенном входящем
outgoing_create_deal	true или false	Создавать ли сделку при исходящем
outgoing_create_contact	true или false	Создавать ли контакт при исходящем

Отладка функции с параметрами пробного запуска

Для упрощения отладки функции, до того как она опубликована, в редакторе есть вкладка Параметры пробного запуска. На этой вкладке находится json с параметрами, которые функция получает при пробном запуске (при клике на «Сохранить и выполнить»). Это не настоящие праметры, но они максимально приближены к реальным, которые функция будет получать после публикации.

Вы можете менять значения параметров, например, src_num или tree_name чтобы проверить как работает ваша функция для разных номеров или схем.