initCall

Данный метод позволяет инициализировать авторизацию для пользователя вашего приложения.

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

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

CURL

curl https://api.ucaller.ru/v1.0/initCall \
  -X "POST" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <Секретный ключ вашего сервиса>.<Идентификатор сервиса>"
  -d '{"phone":79001000010, "code":1000, "client":"nickname", "unique":"f32d7ab0-2695-44ee-a20c-a34262a06b90", "voice":true}'

GET

 https://api.ucaller.ru/v1.0/initCall?phone=79001000010&code=1000&client=nickname&unique=f32d7ab0-2695-44ee-a20c-a34262a06b90&voice=true&key=<Секретный ключ вашего сервиса>&service_id=<Идентификатор сервиса>

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

Параметры

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

ПАРАМЕТРЫ
ОПИСАНИЕ
phone
number, required
Номер телефона пользователя, которому будет совершен звонок с авторизацией
Цифровой формат номера E.164
code
number, string
Уникальный 4-х значный код
На эти 4 цифры будет заканчиваться исходящий от нас звонок к вашему пользователю.
Если `code` не передан, он будет автоматически сгенерирован нами
client
string, До 64 символов
Информацию о пользователе
Можете передать информацию о вашем пользователе, например его никнейм, E-mail и так далее. В статистике сервиса сможете найти ту или иную авторизацию по этому параметру.
unique
string, До 64 символов
Для активации идемпотентности запроса.
Сгенерированный UUID V4 уникальный идентификатор, идемпотетность предотвращает повторное списание средств с баланса клиента. В случае переданного ключа идемпотентности, наше API, при повторном обращении к нему с тем же ключом идемпотентности в методе initCall, вернет тот же самый результат, что был получен при первом обращении, без повторной инициализации авторизации и списания средств.
voice
bool
Авторизация с использованием голосового робота (только для Казахстана и России).
Голосовая авторизация это когда робот проговаривает код голосом

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

{
  "status": true,
  "ucaller_id": 103000,
  "phone": "7900***1010",
  "code": "1000",
  "client": "nickname",
  "unique_request_id": "f32d7ab0-2695-44ee-a20c-a34262a06b90",
  "exists": true
}

Результат

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

ПАРАМЕТРЫ
ОПИСАНИЕ
status
bool
Статус выполнения запроса
ucaller_id
number
Уникальный ID в системе uCaller, который позволит проверять статус и инициализировать метод initRepeat
phone
string
Номер телефона, куда мы совершили звонок, номер телефона замаскирован, мы храним только хеш номера и маску.
code
string
Код, который будет последними цифрами в номере телефона
в ответе код всегда будет строкой так мы поддерживаем коды от 0001 до 9999, если 0001 вернуть в формате number он обрежется до 1
client
string
Идентификатор пользователя переданный клиентом
unique_request_id
string
Появляется только если вами был передан параметр `unique`
exists
bool
Появляется при переданном параметре `unique`, если такой запрос уже был инициализирован ранее