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

Пример: перезвоны по исходам

У каждого исхода звонка может быть своя пауза до следующего набора: правило экспертной логики с действием retry_in и параметром params.interval_s. Ниже — готовый запрос и что делает каждая его часть.

Запрос целиком

Кампания создаётся и запускается одним запросом POST /v1/campaigns.
В ответ приходит 201 с campaign_id, status, blockers и warnings. status: "running" — обзвон пошёл; draft — что-то мешает запуску, причина в blockers. Полный ответ — в Создании кампании.

Что делает каждое правило

Каждое правило — пара «если исход → то действие». Интервал считается от конца звонка и для этого контакта заменяет интервал кампании. Правило на voicemail_reached срабатывает и на voicemail_suppressed — когда автоответчик определён, но сообщение оставлять было нельзя. Все значения if — это коды status_reason из Исходов звонка плюс short_call и goal_not_achieved. Исход, под который не подошло ни одно правило, решает общая таблица исходов, как в standard: автоответчик без своего правила перезванивается через interval_s кампании (Исходы звонка). Поэтому в примере на voicemail_reached стоит своё правило; когда его max_matches исчерпан, автоответчик дальше перезванивается по общей таблице, пока есть наборы. Чтобы на автоответчик больше не звонить, нужно stop_calling.

Правила и ограничения

  • attempts — общий потолок наборов на контакт, считая первый, от 1 до 30. Правила его не расширяют: если наборы кончились, контакт закрывается, даже если у правила остались срабатывания.
  • interval_s у retry_in — целые секунды от 60 до 86400 (от 1 минуты до 24 часов). У retry_in он обязателен, у других действий — запрещён, иначе 422 campaign_spec_invalid.
  • max_matches — сколько раз правило может сработать для одного контакта, от 1 до 30, по умолчанию 1. У short_call его нет — сервер откажет с 422 campaign_spec_invalid.
  • max_duration_s у short_call обязателен, не меньше 10 секунд.
  • Перезвон по постоянной причине запрещён. Для invalid_destination и spam_blocked на всех рынках и для user_declined и screener_declined в пакете рынка США можно только stop_calling. На остальных рынках user_declined считается временным и перезвон на него разрешён — в примере мы сознательно ставим stop_calling.
  • Одна пара «условие + действие» — один раз. Дубль отклоняется.
  • Экспертный режим без единого правила не запустится: блокер rules_empty.
  • Окно обзвона, реестр «не звонить» и частотные лимиты действуют на каждый перезвон. Перезвон, который не успевает до конца кампании (ends_at), не назначается.
  • Предупреждение rule_interval_exceeds_end — интервал правила не меньше остатка окна кампании: такой перезвон не состоится. Запуск оно не блокирует.
  • id правила не передаём — его назначает сервер (r-xxxxxxxx) и возвращает в ответе.

Чтобы обзвон начался сразу

  • Idempotency-Key обязателен, для каждой новой кампании — свой. Повтор запроса с тем же ключом после таймаута не создаст вторую кампанию.
  • attestation: {"confirmed": true} — подпись согласия абонентов. Без неё кампания создаётся черновиком с блокером attestation_required. Подробнее — в Согласии, реестре и ответственности.
  • Агент опубликован. Иначе — черновик с блокером agent_not_published. agent_id — это имя агента.
  • У агента включено «Определять автоответчик». Без него исхода voicemail_reached не будет, и правило на автоответчик не сработает ни разу.
  • trunk_id, route_id и from_number не передаём — платформа сама найдёт линию по агенту (Привязка набора).
  • working_hours только сужает окно обзвона организации; шире — 422 working_hours_wider_than_law.

Где ещё посмотреть