API

Всё, что настраивается в кабинете, доступно и через API. Документация методов открыта без регистрации, ключ создаётся в разделе «API-ключи».

Что доступно через API

  • Номера

    Каталог, покупка и подключение своего номера, привязка сценария, освобождение.

  • Звонки и записи

    Звонок сотруднику и клиенту, журнал по номеру, запись и её удаление.

  • Расшифровка

    Запуск расшифровки, текст с собеседниками, проверка запрещённых фраз.

  • SMS

    Отправка одному получателю и рассылка, история и статусы сообщений.

  • Контакты и актуализация

    Контакты и категории, задания актуализации и их результаты.

  • АТС

    Внутренние номера, сценарии, правила определения номера, рабочее время.

  • Статистика

    Сводка, графики по дням, разбивка по номерам, направлениям и странам.

  • AI-звонки

    Исходящий звонок AI-ассистента с данными клиента, расшифровка и итог.

Документация API

Вебхуки

Подписка задаёт адрес, секрет и события. A3.Telephony отправляет POST-запрос с JSON в момент события.

  1. Звонок начался
  2. Идёт вызов сотрудника
  3. Сотрудник ответил
  4. Звонок завершён
  5. Пришло SMS
  6. SMS доставлено
  7. SMS не отправлено
  8. Новое сообщение голосовой почты
  9. AI-звонок завершён

Безопасность

  • Каждый запрос вебхука подписан HMAC-SHA256, подпись в заголовке X-A3-Signature
  • Адреса внутренней сети для вебхуков отклоняются
  • Ключ API выключается, перевыпускается и удаляется без влияния на другие ключи
  • Действия через API попадают в журнал действий компании

Документация методов открыта

Методы, параметры и примеры ответов собраны в Scalar. Ключ для запросов создаётся в кабинете за минуту.