inboundCallWaiting

Метод позволяет организовать верификацию номера телефона по входящему звонку

Этот метод можно вызывать с использованием аутентификации

Пример запроса

CURL

curl https://api.ucaller.ru/v1.0/inboundCallWaiting \
  -X "POST" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <Секретный ключ вашего сервиса>.<Идентификатор сервиса>"
  -d '{"callback_url":"https://example.com/callback", "phone":79001000010}'

GET

 https://api.ucaller.ru/v1.0/inboundCallWaiting?phone=79001000010&callback_url=https://example.com/callback&key=<Секретный ключ вашего сервиса>&service_id=<Идентификатор сервиса>

В ходе выполнения могут произойти общие ошибки. Их описание находится на отдельной странице →

Параметры

Метод принимает следующие параметры:

ПАРАМЕТРЫ
ОПИСАНИЕ
phone
number, required
Номер телефона пользователя, которому будет совершен звонок с авторизацией
Цифровой формат номера E.164
callback_url
string, required
Ссылка для оповещения (web-hook) о вызове на номер.

Пример ответа

{
  "status": true,
  "ucaller_id": 103000,
  "phone": "7900***1010",
  "confirmation_number": "79001000011",
}

Результат

Метод возвращает объект, содержащий следующие поля:

ПАРАМЕТРЫ
ОПИСАНИЕ
status
bool
Статус выполнения запроса
ucaller_id
number
Уникальный ID в системе uCaller, который позволит проверять статус и инициализировать метод initRepeat
phone
string
Номер телефона, куда мы совершили звонок, номер телефона замаскирован, мы храним только хеш номера и маску.
confirmation_number
string
Номер, на который нужно совершить звонок для подтверждения

Параметры вызова webhook

При поступлении вызова на номер для верификации, с указанного клиентского номера в период времени жизни запроса, система генерирует POST запрос с данными в формате JSON в теле запроса, на указанный в запросе адрес.

{
  "callId": "10300",
  "callbackLink": "https://example.com/callback",
  "clientNumber": "79001000010",
  "confirmationNumber": "79001000011",
  "isMnp": true,
  "operatorName": "ООО Скартел",
  "operatorNameMnp": "ВымпелКом ПАО",
  "regionName": "Пермский край"
}

Результат

Метод возвращает объект, содержащий следующие поля:

ПАРАМЕТРЫ
ОПИСАНИЕ
callId
string
Уникальный ID в системе uCaller, который позволит проверять статус и инициализировать метод initRepeat
clientNumber
string
Номер для верификации, переданный в запросе.
confirmationNumber
string
Номер, на который нужно совершить звонок для подтверждения.
isMnp
bool
Наличие номера в списках портированных (перенесенных между операторами сотовой связи).
operatorName
string
Оператор согласно реестру нумерации. Поле будет пустое если isMnp=false
operatorNameMnp
string
Если номер портирован, то оператор куда портирован номер. Поле будет пустое если isMnp=false
regionName
string
Регион согласно реестру нумерации.
← getInfo
getService →