Confirmation: звонки для авторизации, API

Изменено Чт, 3 Окт на 9:01 AM

Confirmation call совершается с помощью Метода:

POST /api/protected/api/auth/confirmationCall в разделе «Интеграции» >> «Методы API» >> «Платные методы».

Метод позволяет совершить звонок для идентификации. Клиенту никаких номеров подключать для этого не нужно, звонки идут с наших номеров. После поднятия трубки будет проигран голосовой файл с сообщением о необходимости нажать цифру 9, звонок будет бесплатный, но сам вызов метода стоит от 50 копеек. Метод связывает запрос API с конкретным звонком с помощью верификационного кода, о нем будет сказано после описания параметров метода.

Пример вызова метода:

curl -X 'POST' \
'https://paidmethods.kompaas.tech/api/protected/api/auth/confirmationCall' \
-H 'accept: application/json' \
-H 'Content-Type: application/json' \
-H 'Sec-Fetch-Mode: cors' \
-H 'Authorization: Bearer <ТОКЕН>' \
-d '{
"phone_number": "4377777777"
}'

Параметры метода:

phone_number - номер клиента, на который проходит вызов.

После успешного выполнения метода приходит ответ формата:

{
"status": "success",
"code": 200,
"object": {
"login_did": "7777777777",
"code": "0000",
"account_id": "777777",
"verification_call_uuid": "119214e015ed_777777"
}
}

Параметр ok — статус запроса. True — успех.
Параметр caller_number — номер, с которого производился звонок.
Параметр verification_call_uuid — верификационный код. Он выглядит следующим образом (пример) «fa278be48dc2_777777», где первая часть кода до символа “_” — идентификатор звонка, а цифры после символа “_” — ЛС клиента. Код нужен, чтобы связать данные о звонке (CDR) с конкретным случаем вызова API. Чтобы получать данные о звонке, нужно в разделе «Интеграции» подключить веб-хук «Flash call» и тогда на указанный URL будет приходить информация о звонке. В данных о звонке верификационный код, связывающий его с конкретным вызовом API можно по параметру «verification_call_uuid»: «fa278be48dc2_777777».

Callback — статусы верификационного звонка

Отвеченный звонок

«q931_status»: 16,

«final_status»: «ANSWER»

Занято

«q931_status»: 17,

«final_status»: «CANCEL»

Неотвеченный звонок

«q931_status»: 16,

«final_status»: «CANCEL»

Не прохождени вызова в системе окс7, вызов отклонил встречный оператор

«q931_status»: 31

Не прохождение звонка из-за проблем биллинга

«q931_status»: 41

Все прочие коды «q931_status», отличные от 31, 16 или 17 — номер недоступен.

Создание веб-хука для получения информации о звонке

Для того, чтобы получить на URL информацию о звонке (CDR) в привязке к вызову API, необходимо в разделе «Интеграции», подразделе «Веб-хуки» создать подписку на событие «Password call».

В поле «Тело запроса» указываются внутри массива JSON список переменных, которые будут передаваться на URL. Просмотр событий также доступен в разделе «Мониторинг».