События звонка на добавочный: HTTP hook

В документации мы постарались ответить на частые вопросы по работе TesLab, с которыми сталкиваются пользователи.
Если Вы не нашли ответ на свой вопрос, напишите нам.

Личный кабинет

События звонка на добавочный: HTTP hook

HTTP hook передаёт в TesLab начало и завершение звонка на добавочный сотрудника. Он помогает показать входящий вызов и убрать уведомление после отбоя. Звук передаёт отдельное SIP-подключение, сам hook разговор не соединяет.

Что подготовить

  1. Определите, какая АТС сообщает события и на какой добавочный поступает звонок.
  2. Проверьте персональное подключение сотрудника к этой станции.
  3. Получите адрес hook и ключ доступа в настройках TesLab.
  4. Поручите администратору АТС настроить два события с одним идентификатором разговора: начало и завершение.
  5. Проведите контрольный звонок на учебный добавочный и проверьте оба события.

Если станция уже передаёт нужные события через AMI, сначала согласуйте с её администратором необходимость дополнительного hook. Два канала должны сообщать одинаковые идентификатор разговора и адрес станции.

Телефон: событие и звук различаются. Согласуйте один идентификатор вызова и правильный добавочный.

Где взять параметры

Откройте Настройки → АТС → Уведомления о звонках. В блоке «Строка для дайлплана» находится пример подключения с адресом сервера и ключом.

Настройка hook: пример для дайлплана, копирование и смена ключа

1. Пример для администратора АТС. 2. Скопировать пример. 3. Сменить ключ. Для обычного просмотра и копирования менять ключ не нужно: после его смены прежний перестанет подходить станции.

Пример содержит начало, обработчик завершения и ограничения времени HTTP-запроса. Администратор должен подключить эти части к подходящему контексту своей АТС. Не заменяйте готовым фрагментом весь действующий дайлплан.

Ключ даёт доступ внешнему источнику событий. Не публикуйте его, рабочий URL и полный дайлплан в общедоступных сообщениях.

Как связать сотрудника со станцией

В списке сотрудников откройте меню нужной записи и выберите «Виртуальная АТС». Сверьте сервер и SIP-логин, который используется как добавочный.

Учебная настройка сотрудника: сервер АТС и добавочный 105

1. Адрес станции. 2. SIP-логин сотрудника. В примере событие должно относиться к станции ats.example.ru и добавочному 105.

Для включения софтфона в этой форме нужны все четыре поля. Событие hook не создаёт SIP-аккаунт на станции и не заменяет его настройку. Подробнее: Виртуальная АТС сотрудника: назначение подключения.

Какие данные передавать

ПолеНазначение
eventstart или end. При отсутствии поля используется start. Другие значения отклоняются.
extДобавочный получателя. Допустимы цифры и символы *, #, +, не более 64 знаков.
fromНомер звонящего. Передавайте строкой.
callidОдин строковый ID разговора для всех его событий, не более 64 знаков. Для end обязателен. Для start без ID сервер создаст собственный, поэтому такой вариант неудобен для последующего завершения.
serverАдрес АТС для сопоставления с карточкой сотрудника. Передавайте явно, особенно если добавочные повторяются на разных станциях.

Числоподобный ID тоже является строкой, например "1787070849.762581". Не округляйте его. Адрес станции и ID должны совпадать в начале и завершении.

Начало и завершение

Предпочтителен POST с JSON либо телом формы. Ниже условный пример начала, без действующего ключа:

POST /api/system/ats/hook
Access-Code: YOUR_HOOK_KEY
Content-Type: application/json

{
  "event": "start",
  "ext": "105",
  "from": "70000000000",
  "callid": "1787070849.762581",
  "server": "ats.example.ru"
}

После завершения той же ветви передайте:

{
  "event": "end",
  "ext": "105",
  "callid": "1787070849.762581",
  "server": "ats.example.ru"
}

В теле формы кодируйте значения как URL-параметры. Особенно это важно для плюса, амперсанда и символа #. Не рассчитывайте на сохранность параметров GET при любой настройке веб-сервера.

Групповой звонок и AMI

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

События start и end сами по себе не подтверждают, что человек ответил. Для факта ответа и точного сопоставления каналов используйте согласованную интеграцию станции, например события AMI. При совместной настройке hook и AMI нужен один источник и один ID разговора.

Как проверить результат

  1. Позвоните на учебный добавочный. Проверьте, что уведомление получил нужный сотрудник.
  2. Завершите вызов. Уведомление должно исчезнуть.
  3. Для группы проверьте завершение одной ветви, пока другая ещё звонит.
  4. Проверьте журнал звонков и отдельно установление разговора по SIP.

Ответ {"ok":true} означает, что hook обработан. Он возможен и при подавленном повторе, отсутствии подходящего сотрудника или номере из чёрного списка. Это не подтверждение доставки push, работы микрофона или соединения со станцией.

Если уведомление не появилось

  • 403: проверьте ключ именно этого hook и его передачу.
  • 400: проверьте событие, типы полей, добавочный и длину ID.
  • 409: одинаковый добавочный найден на разных станциях без однозначного server.
  • Успех без уведомления: проверьте работающего сотрудника, его добавочный, станцию, чёрный список и повтор уже завершённого вызова.
  • Уведомление есть, разговора нет: отдельно проверьте SIP, сеть и настройки приёма звонков.

Связанные материалы