getInfo

Этот метод возвращает развернутую информацию по уже осуществленному uCaller ID.

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

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

CURL

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

GET

 https://api.ucaller.ru/v1.0/getInfo?uid=103000&key=<Секретный ключ вашего сервиса>&service_id=<Идентификатор сервиса>

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

Параметры

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

ПАРАМЕТРЫ
ОПИСАНИЕ
uid
number, required
Идентификатор ucaller_id из метода initCall

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

{
  "status": true,
  "ucaller_id": 103000,
  "init_time": 1556617525,
  "call_status": -1,
  "is_repeated": false,
  "first_ucaller_id":102999,
  "repeatable": false,
  "repeat_times": 2,
  "repeated_ucaller_ids": [103001, 103002],
  "unique": "f32d7ab0-2695-44ee-a20c-a34262a06b90",
  "client": "nickname",
  "phone": "7900***1010",
  "code": "0010",
  "country_code": "RU",
  "phone_info": [
      {
      "operator": "МТС",
      "region": "Республика Татарстан",
      "mnp": "Мегафон"
      }
  ],
  "cost": 0.3,
  "balance": 568.12
}

Результат

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

ПАРАМЕТРЫ
ОПИСАНИЕ
status
bool
Статус выполнения запроса
ucaller_id
number
Уникальный ID в системе uCaller, который позволит проверять статус и инициализировать метод initRepeat
init_time
number
Дата инициализации авторизации Unix Timestamp
call_status
number
Статус звонка, -1 = информация проверяется (от 1 сек до 1 минуты), 0 = дозвониться не удалось, 1 = звонок осуществлен
is_repeated
bool
Является ли этот uCaller ID повтором (initRepeat), если да, будет добавлен first_ucaller_id с первым uCaller ID этой цепочки
first_ucaller_id
number
Идентификатор первой авторизации из сессии повторов
repeatable
bool
Возможно ли инициализировать бесплатные повторы (initRepeat)
repeat_times
number
Остаток бесплатных повторов авторизации, появляется в случае repeatable: true
repeated_ucaller_ids
array
Массив идентификаторов инициализированных повторов (initRepeat)
unique
string
ключ идемпотентности (если был передан)
client
string
Идентификатор пользователя переданный клиентом
phone
string
Номер телефона, куда мы совершили звонок, номер телефона замаскирован, мы храним только хеш номера и маску.
code
string
Код, который был последними цифрами в номере телефона
в ответе код всегда будет строкой так мы поддерживаем коды от 0001 до 9999, если 0001 вернуть в формате number он обрежется до 1
country_code
string
ISO код страны номера телефона на который был совершен звонок
phone_info
object
Информация о номере телефона, может быть пустой

operator
string
Оператор связи
region
string
Регион субъеккта Российской федерации
mnp
string
Текущий оператор связи
cost
bool
Стоимость авторизации
balance
number
Состояние баланса до списания этой операции