HLR HTTP API¶

Отправка HLR-cообщения на несколько номеров (POST)¶

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

https://integrationapi.net/rest/v2/Hlr/SendBulk?Login=<Логин>&Password=<Пароль>&DestinationAddresses=<Номерполучателя>&Validity=<Время жизни сообщения>

Вместо комбинации логина и пароля можно передавать параметр SessionID.

https://integrationapi.net/rest/Hlr/SendBulk?SessionID=<ID сессии>&DestinationAddresses=<Номер получателя>&Validity=<Время жизни сообщения>

Пример:

https://integrationapi.net/rest/Hlr/SendBulk?SessionID=4E1C44388AB54B38B097C17D5F949ECA4005&DestinationAddresses=+70000000001&DestinationAddresses=80000000002&Validity=5

Параметры POST-запроса на отправку HLR-сообщения на несколько номеров¶

Параметр	Тип данных	Описание
Login обязательный	string	Логин, полученный при регистрации
Password обязательный	string	Пароль, соответствующий логину
DestinationAddresses обязательный	string	Номера получателей сообщения, в международном формате: код страны и код сети плюс номер телефона. Максимум 200 номеров. Пример формата: `79031234567`; `+79031234567`; `89031234567`
Validity обязательный	integer	Время жизни сообщения в минутах

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

HTTP/1.1 200 OK       
Cache-Control: private       
Connection: Keep-Alive      
Content-Type: application/json; charset=utf-8      
["703112828852109312", "703112828852109313"]

Запрос статуса по HLR-сообщениям (GET)¶

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

https://integrationapi.net/rest/v2/Hlr/State?Login=<Логин>&Password=<Пароль>&messageIds=<IDы сообщений>

Вместо комбинации логина и пароля можно передавать параметр SessionID.

https://integrationapi.net/rest/Hlr/State?SessionID=<ID сессии>&messageIds=<IDы сообщений>

Пример:

https://integrationapi.net/rest/Hlr/State?SessionID=4E1C44388AB54B38B097C17D5F949ECA4005&messageIds=703112828852109312&messageIds=703112828852109313

Поля ответа на статус сообщения¶

Параметр	Тип данных	Описание
DestinationAddress	string	Номер получателей сообщения, в международном формате: код страны и код сети плюс номер телефона. Максимум 200 номеров. Пример формата: `79031234567`; `+79031234567`; `89031234567`
StateCode	integer	Код статуса сообщения
StateDesc	string	Краткое описание ошибки
Country	string	Страна получателя
MobileOperator	string	Мобильный оператор получателя

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

[
  {
    "messageId" : "703112828852109314", 
    "DestinationAddress": "+79001234567",
    "StateCode" : 1,
    "StateDesc" : "Отправляется",
    "Country" : "Россия",
    "MobileOperator" : "ОАО Вымпел-Коммуникации(Москва)",   
  }
]

Статусы сообщений¶

StateCode	Описание
0	Отправляется
1	Абонент доступен
2	Абонент временно недоступен
3	Абонента не существует
4	Ошибка запроса
99	Неизвестная ошибка