Запрос для проверки номеров телефонов на существование (отправка HLR-запроса)

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

Ответ в случае успешной отправки запроса →

Ответ в случае ошибки обработки запроса →

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

чёрный — обязательные параметры
серый — необязательные параметры

Тело запроса

{
    "login":"username",
    "password":"password",
    "command":"hlr_send",
    "webhook_url":"http://callback.yourdomain.by/",
    "message":{
	    "msg":[
		    "+375295363600",
		    "80295363600",
		    "295363600"
		]
	}
}

Описание параметров и тегов в запросе

ваш логин, для доступа в Личный кабинет (ЛК)

password

ваш пароль к API, который генерируется на странице «SMS-рассылка» — «Рассылка по API»

webhook_url

адрес (URL) вашего сайта, на который будет отправлен отчёт о выполнении HLR-запроса

msg

тег-массив с номерами телефонов, по которым происходит проверка существования (по которым отправляется HLR-запрос). Номера телефонов должны быть записаны в допустимых форматах

Ответ в случае успешной отправки запроса

Тело ответа

{
    "message":{
	    "msg":[
			{"hlr_code":123456,"error_code":"0","recipient":"375295363600"},
			{"hlr_code":123457,"error_code":"0","recipient":"375295363600"},
			{"hlr_code":123458,"error_code":"0","recipient":"375295363600"}
		]
	}
}

Описание тегов в ответе

msg

массив с информацией HLR-запроса. Может содержать следующие параметры:

hlr_code

числовой идентификатор HLR-запроса, который вы получили в момент его отправки

error_code

код ошибки. В случае успешного ответа значение 0

recipient

номер телефона, по которому осуществляется проверка на существование (HLR-запрос) в допустимом формате

Ответ в случае ошибки обработки запроса

Тело ответа