Работа с HLR компаниями

Для авторизации используется ApiKey полученный в личном кабинете для соответствующей компании. Пример заголовка:

Точка подключения:

Создание запроса на проверку одного номера (POST)

Сервис создает HLR-задание в соответствии со значениями параметров, передаваемых сервису в POST-запросе следующего формата:

Параметры запроса:

Параметр Тип данных Описание Обязательный
phone String Номер получателя Да

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

Параметры ответа:

Параметр Тип данных Описание Обязательный
id integer Идентификатор запроса Да
campaign_id integer Идентификатор кампании Да
subscriber_id integer Идентификатор получателя Да
status String Статус запроса Да
created_at String Дата создания запроса Да

Проверка нескольих номеров (POST)

Данным запросом можно создать HLR-задание на несколько номеров.

Параметр Тип данных Описание Обязательный
phones Array[string] Номера получателей Да

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

Запустить созданные задания (GET)

Параметр Тип данных Описание Обязательный
page integer Номер страницы Нет
per_page integer Кол-во записей Нет

Получения статуса запроса (GET)

Данным методом можно получить информацию о выполнении запроса по его id.

Параметр Тип данных Описание Обязательный
id integer Идентификатор запроса Да

Получение статистики (GET)

Параметр Тип данных Описание Обязательный
page integer Номер страницы Нет
per_page integer Кол-во записей Нет
start_date date Дата начала выборки. Формат dd.mm.yyyy Да
end_date date Дата конца выборки. Формат dd.mm.yyyy Да