Password Call — авторизация по коду

Метод post /api/protected/api/auth/passwordcall в разделе «Интеграции» >> «Методы API» >> «Платные методы» > «Методы работы с авторизацией».

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

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

curl -X 'POST' \
'https://paidmethods.mcn.ru/api/protected/api/auth/passwordcall' \
-H 'accept: application/json' \
-H 'Content-Type: application/json' \
-H 'Sec-Fetch-Mode: cors' \
-H 'Authorization Bearer <ТОКЕН>' \
-d '{
"phone_number": "79777777777",
"verification_code": "1234",
"is_with_redirect": true
}'

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

ТОКЕН - токен, который определяет ЛС клиента. Именно с на этом ЛСе должен быть номер, с которого звоним и именно на нем произойдет списание денег за услугу. Токен находится в разделе "API".

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

verification_code - авторизационный код. 4 цифры, на которые будет заканчиваться номер, с которого происходит звонок ЕСЛИ это поле заполнено. Если поле не заполнено - произойдет звонок со случайного номера.

is_with_redirect - включена ли проверка на переадресацию на номере. True - включена, fasle - выключена.

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

{
"ok": true,
"caller_number": "74951091251",
"verification_code": "1234",
"verification_uuid": "da59bda0a1bb_117793",
"is_redirect": false

}

1. Параметр ok. True, если запрос успешно выполнен, false в ином случае.

2. Параметр caller_number — номер, с которого был произведен звонок.

3. Параметр verification_code — четырехзначный код для авторизации.

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

5. Параметр is_redirect — включена ли переадресация на номере, параметр активен только при значении переменное is_with_redirect = true при вызове метода.

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.

Просмотр событий также доступен в разделе «Мониторинг».