GenerateActivityScoreReport

Метод GenerateActivityScoreReport

Примените метод GenerateActivityScoreReport для получения оценки телеком-доступности множества номеров любых операторов РФ. Метод аналогичен GetActivityScore, но позволяет за один запрос проверить не 1, а до 50 000 номеров. Последовательность действий:

  1. Отправьте номера на проверку с помощью метода GenerateActivityScoreReport. В ответе на запрос вы получите идентификатор отчёта с результатами проверки
  2. Используйте полученный идентификатор, чтобы с помощью метода GetHLRReport получить этот отчёт. В нём по каждому проверенному номеру будет доступен коэффициент активности на сети (от 0 до 1). Благодаря ему вы сможете актуализировать вашу клиентскую базу перед отправкой рассылки или запуска обзвона, убрав из неё неактивные номера.

Точка подключения: Выполните POST-запрос с входными параметрами к точке подключения:

POST: https://api.exolve.ru/hlr/v1/GenerateActivityScoreReport

Авторизация

Передайте следующие Заголовки HTTP для успешной авторизации.

ИмяТипОписание
AuthorizationstringAPI-ключ приложения с Bearer перед ним. Пример: Bearer e***s0, где e***s0 замените на API-ключ вашего приложения

Входные параметры

Передайте следующие параметры в теле запроса в JSON-формате. Параметры, отмеченные жирным шрифтом, являются обязательными.

ПараметрТипОписание
numberstringсписок номеров, по которым нужно получить оценку активности; формат файла — base64, формат номера — 7ХХХХХХХХХХ

Выходные параметры

ПараметрТипОписание
file_uuidstringидентификатор отчёта

Примеры

Входные параметры:

{
    "numbers": "NzkwNTc3MTM1ODAKNzkwNTc3MTM1ODEKNzkwNTc3MTM1ODIKNzkwNTc3MTM1ODMKNzkwNTc3MTM1ODQKNzkwNTkK=="
}

Выходные параметры:

{
    "file_uuid": "89363af6-45c8-4961-9f4a-06fa363b5fdc=="
}

Возможные ошибки

КодСтатусПример сообщенияОписание
400Bad Requestat least one number is requiredфайл не может быть пустым — передайте хотя бы 1 номер на проверку
400Bad Requestinvalid GenerateActivityScoreReportRequest.Numbers: value length must be at least 1 bytes
400Bad Requestinvalid value for bytes field numbers
400Bad Requestunexpected token
400Bad Requestinvalid value
400Bad Requestunknown field
401Unauthorizedincorrect authorization tokenневалидный API-ключ
403Forbiddenнет доступа к данными с предоставленным API-ключом
404Not Foundнекорректно введен URL запроса