Flash call — звонки для авторизации, API

Методы для совершения звонков:

1. Метод Call 2fa authorization

   Post /api/protected/api/auth/call_2fa в разделе «Интеграции» → вкладка «Методы API» → меню справа «Платные методы» → «Auth» → «Authorization methods».

   

   Метод позволяет совершить звонок с ПОДКЛЮЧЕННОГО клиентом номера на любой другой номер. Звонок после поднятия трубки сразу будет сброшен, звонок будет бесплатный, но сам вызов метода стоит 1 копейку.

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

   curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' --header 'Authorization: Bearer <ТОКЕН>'

   'https://paidmethods.mcn.ru/api/protected/api/auth/call_2fa'

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

   caller_did — номер телефона, подключенный на ЛС из account_id с которого будет происходит звонок.

   login_did — номер, на который будет совершен звонок.

2. Метод Flash Call authorization

   Post /api/protected/api/auth/flashcall в разделе «Интеграции» → вкладка «Методы API» → меню справа «Платные методы» → «Auth» → «Authorization methods».

   

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

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

   curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' --header 'Authorization: Bearer <ТОКЕН>'

   'https://paidmethods.mcn.ru/api/protected/api/auth/flashcall'

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

   login_did — одержит телефонный номер в формате E.164 (например, "+74951234567"). Используется для указания номера телефона, на который будет совершен вызов flash call; verification_code — параметр verification_code, содержащий код подтверждения (например, "1234"). Используется для указания кода, необходимого для проверки подлинности или какой-либо другой процедуры верификации; is_with_redirect — является логическим значением (true/false). Указывает, нужно ли выполнять перенаправление после отправки flash-сообщения. Если значение is_with_redirect равно false, то перенаправление не будет осуществлено, а если равно true, то будет выполнено перенаправление.

   ⚠️Внимание!	is_with_redirect — включена ли на номере переадрессация (работает только на номерах MCNtelecom).

   После успешного выполнения метода приходит параметр verification_call_uuid — верификационный код. Он выглядит следующим образом (пример) «fa278be48dc2_117793», где первая часть кода до символа “” — идентификатор звонка, а цифры после символа “” — ЛС клиента. Код нужен, чтобы связать данные о звонке (CDR) с конкретным случаем вызова API.

   Чтобы получать данные о звонке, нужно в разделе «Интеграции» подключить веб-хук «Flash call» и тогда на указанный URL будет приходить информация о звонке. В данных о звонке верификационный код, связывающий его с конкретным вызовом API можно по параметру «verification_call_uuid»: «fa278be48dc2_117793».

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

• Отвеченный звонок «q931_status»: 16, «final_status»: «ANSWERED»
• Занято «q931_status»: 17, «final_status»: «NO ANSWER»
• Неотвеченный звонок «q931_status»: 16, «final_status»: «NO ANSWER»
• Не прохождении вызова в системе окс7, вызов отклонил встречный оператор «q931_status»: 31

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

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

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

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