Перейти к основному содержимому

Добавление номеров из CRM

Следующие методы Calls API представляют собой упрощенные методы для добавления в обзвон одного номера с параметрами:

  • GET /api/crmCalls/campaign/{token}/addPhone
  • POST /api/crmCalls/campaign/{token}/addPhone

Они отличаются от основного метода для добавления номеров в обзвон POST /addPhones тем, что параметры передаются в строке запроса, а число поддерживаемых параметров ограничено.

подсказка
Методы предназначены для добавления номеров в обзвон из CRM-систем, в частности Битрикс24.

Параметры запроса

Метод поддерживает следующие параметры задания на обзвон:

  • phone — номер телефона абонента, обязательный параметр.
  • gmtZone — часовой пояс абонента, необязательный параметр.
подсказка
На формат часового пояса накладываются те же ограничения, что и для метода POST /addPhones.

Все другие параметры интерпретируются как дополнительные данные payload. Объект с дополнительными данными доступен из сценария бота через метод $dialer.getPayload.

Пример запроса

curl 'https://app.jaicp.com/api/crmCalls/campaign/8231.7056.1b131df1/addPhone?phone=79110000000&gmtZone=+03:30&name=Alex'

Ответом на такой запрос будет идентификатор созданного задания на обзвон в строковом формате.