FlashСall API

Flash Call — это современная технология аутентификации, которая использует входящий звонок для подтверждения личности пользователя. В отличие от стандартных SMS-кодов, Flash Call позволяет быстрее и удобнее пройти процесс верификации.

FlashCall запросы

Запрос:

POST https://api.unibell.ru/apps/flash/calls/flash?X-Authorization=AccessKey d8ac9959r12b43545XXXXX

Параметры передаются в теле запроса:

{
   "number": "XXXXXXXXXXXX",
   "code": 1234,
   "timeout": 60000
} 

Пример запросов с использованием CURL:

curl --location 'https://api.unibell.ru/apps/flash/calls/flash?X-Authorization=AccessKey%20d8ac9959r12b43545XXXXX' \
--header 'Content-Type: application/json' \
--data '{
   "number": "XXXXXXXXXXXX",
   "code": 1234,
   "timeout": 60000
} '

curl --location 'https://api.unibell.ru/apps/flash/calls/flash' \
--header 'X-Authorization: AccessKey d8ac9959r12b43545XXXXX' \
--header 'Content-Type: application/json' \
--data '{
   "number": "XXXXXXXXXXXX",
   "code": 1234,
   "timeout": 60000
} '

Параметр	Описание
number	Номер телефона в формате e.164 Поле не должно содержать кириллицы
code	Код, 4-е знака
timeout	Максимальное время вызова в мс

Ответ:

В случае успешной отправки возвращается requestId — идентификатор сообщения на стороне партнера, который потом возвращается в callback.

Пример успешного ответа:

{        
   "requestId": XXXXXX
   "from": "XXXXXXXXXXXX"
}

Пример неуспешного ответа:

{
   "errorCode" : 1,
   "errorReason" : "Authentication required"
}

Описание кодов ошибок

errorCode	errorReason	Описание
1 НТТP 401	Authentication required	Неверный токен аутентификации
2 HTTP 400	Inactive account	Неактивный аккаунт. Свяжитесь с поддержкой
4 HTTP 429	Too many requests	Слишком много запросов за короткий период времени
5 HTTP 401	Inactive token	Неактивный токен
6 HTTP 403	Insufficient funds	Низкий баланс, невозможно выполнить запрос
10 HTTP 400	Invalid request	Неправильно сформированный запрос
11 HTTP 400	Invalid number	Неверный формат номера. Номер должен быть в формате (E.164).
16 HTTP 400	Sender not allowed	Для данного типа запроса недопустим sender id

Получение статусов

Получение статусов должно быть настроено через Callback.

Параметры в callback

Параметр	Описание
requestId	Уникальный идентификатор запроса на стороне партнера
number	Номер абонента
status	Статус (приведены в таблице ниже)
timestamp	Время изменения статуса в формате unixtime
appKey	API ключ приложения

Сопоставление статусов

Статусы, которые может вернуть Партнер	Описание статуса Партнера	Соответствующий статус Message_state
ANSWERED	Вызов пришел, абонент взял трубку	DELIVERED
TERMINATED	Вызов пришел, абонент не взял трубку (звонок прерван по истечении ttl или по команде)
BUSY_HERE	Вызов пришел, абонент сбросил вызов
REJECTED	Звонок не может быть совершен, например если номер еще занят другим звонком или другая SIP-ошибка	UNDELIVERED
UNAVAILABLE	Абонент не доступен, телефон выключен
FORBIDDEN	Возвращается при срабатывании антифрода