Добавление номеров из CRM
Следующие методы Calls API представляют собой упрощенные методы для добавления в обзвон одного номера с параметрами:
GET /api/crmCalls/campaign/{token}/addPhone
POST /api/crmCalls/campaign/{token}/addPhone
GET /api/crmCalls/campaign/{token}/test/addPhone
Они отличаются от основного метода для добавления номеров в обзвон POST /addPhones
тем, что параметры передаются в строке запроса, а число поддерживаемых параметров ограничено.
Параметры запроса
Метод поддерживает следующие параметры задания на обзвон:
phone
— номер телефона абонента, обязательный параметр.gmtZone
— часовой пояс абонента, необязательный параметр.
POST /addPhones
.Все другие параметры интерпретируются как дополнительные данные payload
. Объект с дополнительными данными доступен из сценария бота через метод $dialer.getPayload
.
Дублирование номеров в обзвонах
Номера телефонов считаются дубликатами:
- Если у них одинаковые значения
phone
и одинаковые объектыpayload
. - Если у них одинаковые значения
phone
, а поляpayload
не указаны.
Ограничения на дубликаты действуют в методах:
GET /api/crmCalls/campaign/{token}/addPhone
POST /api/crmCalls/campaign/{token}/addPhone
Если вы используете звонки на один и тот же номер для тестирования обзвона, воспользуйтесь методом GET /api/crmCalls/campaign/{token}/test/addPhone
.
Ограничения на добавление дубликатов
Предположим, вы уже добавили номер в обзвон. Далее вы выполняете второй запрос, чтобы добавить дубликат. Результат второго запроса различается в следующих случаях:
-
Оба запроса выполняются без ключа идемпотентности:
- Если не прошло 24 часа с первого запроса — второй запрос вернет ошибку.
- Если уже прошло 24 часа — будет создано новое задание для этого номера.
-
Оба запроса имеют одинаковый ключ идемпотентности:
- Если не прошло 24 часа с первого запроса — второй запрос выполнится успешно, но задание на обзвон не будет создано. Запрос вернет ID того же задания, которое ранее создал первый запрос.
- Если уже прошло 24 часа — будет создано новое задание для этого номера, так как срок действия ключа идемпотентности — 1 сутки со времени первого использования.
-
У запросов разные ключи идемпотентности или у одного из них нет ключа:
Запрос выполнится успешно, будет создано новое задание на обзвон.
Пример запроса
curl 'https://app.jaicp.com/api/crmCalls/campaign/8231.7056.1b131df1/addPhone?phone=79110000000&gmtZone=+03:30&name=Alex&Idempotence-Key=d5f41bd4'
Ответом на такой запрос будет идентификатор созданного задания на обзвон в строковом формате.