Добавление номеров в рассылку

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

GET {host_name}/api/calls/campaign/{token}/addPhone
POST {host_name}/api/calls/campaign/{token}/addPhones

GET /addPhone

Метод GET /addPhone — упрощенный метод для добавления единичного номера в рассылку. Настройки задания на обзвон передаются в параметрах строки запроса:

phone — номер телефона абонента, обязательный параметр.
gmtZone — часовой пояс абонента, необязательный параметр.

gmtZone должен удовлетворять одному из следующих форматов:

Z — время UTC.

+h, +hh, ±hhmm или ±hhmmss с опциональными элементами:

разделитель : между часами, минутами и секундами, например +hh:mm:ss;

префикс UTC, GMT или UT, например GMT-hh:mm.

ID часовых поясов, установленных IANA TZDB.

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

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

Номер абонента — 79110000000.
Часовой пояс — московское время.
Имя абонента — Alex.

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

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

POST /addPhones

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

Использовать этот метод также более предпочтительно, если дополнительных параметров слишком много или они содержат длинные строки.

Следующий запрос эквивалентен предыдущему:

curl --request POST 'https://app.jaicp.com/api/calls/campaign/8231.7056.1b131df1/addPhones' \
--header 'Content-Type: application/json' \
--data-raw '[
    {
        "phone": 79110000000,
        "gmtZone": "+03:00",
        "payload": {
            "name": "Alex"
        }
    }
]'

Ответ на запрос — массив идентификаторов всех созданных заданий на обзвон.

Определение политики звонка

При добавлении номера в рассылку при помощи API вы можете также задать индивидуальные настройки для звонка. Для этого при вызове метода POST /addPhones в теле запроса передайте параметры, указанные в схеме CallJobParameters.

Если параметры не были переданы, номер добавляется в очередь, и звонки идут в общем порядке. При добавлении номера с параметрами индивидуальной политики его приоритет относительно других номеров повышается согласно политике звонков.

Подробнее о политике звонков