h1. HTTP интерфейс hlr

Выполняет [[HLR запрос]] и возвращает результат.

{{>toc}}

h2. Аргументы

|*аргумент*|*обязательный*|*описание*|
|_login|да|совпадает с логином пользователя/компании к личному кабинету|
|_password|да|совпадает с паролем пользователя/компании к личному кабинету|
|number|да|номер в формате E.164|
|request_id|нет|назначаемый клиентом ID запроса, будет возвращен клиенту в ответе|

h2. Возвращаемые данные

Сервер возвращает ответ в формате "JSON API":https://jsonapi.org/format/.
В ответе может присутствовать одно из:

* *errors*.
  Массив ошибок, возникших при обработке запроса.
* *data*.
  JSON объект, содержащий результаты запроса, если запрос от клиента содержит 1 номер.
  Массив JSON объектов, если запрос от клиента содержит несколько номеров.

*errors* и *data* не присутствуют в 1 ответе одновременно.
Каждый ответ содержит либо *errors*, либо *data*.
  
*data* может содержать следующие атрибуты:
|*атрибут*|*обязательный*|*описание*|
|id|да|назначенный сервером ID запроса|
|type|да|"hlr"|
|number|да|запрошенный номер|
|status|да|ок - успешно получили информацию, за запрос списались деньги
error - не получили информацию, за запрос не списались деньги|
|mcc|нет|MCC запрошенного номера|
|mnc|нет|MNC запрошенного номера|
|imsi|нет|IMSI запрошенного номера|
|reachable|нет|достижимость абонента для запрошенного номера (true - достижим, false - не достижим)|
|roaming|нет|статус роуминга абонента для запрошенного номера (true - абонент в роуминге, false - абонент не в роуминге)|
|request_id|да, если клиент передал request_id в запросе|переданный клиентом аргумент|

*errors* может содержать следующие атрибуты:
|*атрибут*|*обязательный*|*описание*|
|code|да|Короткий код ошибки.
Может использоваться клиентом для условной обработки ошибки.
Не зависит от локали клиента.|
|detail|да|Детали ошибки.
Может использоваться клиентом для отображения в содержимом диалогового окна ошибки.
Может быть выдано сервером в локали клиента.|
|title|да|Заголовок ошибки.
Может использоваться клиентом для отображения в заголовке диалогового окна ошибки.
Может быть выдано сервером в локали клиента.|

h2. Примеры

h3. Запрос 1 номера

|*запрос*|GET "https://имя.вашего.сервера/api/hlr?number=79183035536&request_id=1&_login=LOGIN&_password=PASSWORD"|
|*ответ*|<pre>
{
	"data" : {
		"attributes" : {
			"mcc" : "250",
			"mnc" : "001",
			"number" : "79183035536",
			"status" : "ok"
		},
		"id" : "1561370632513",
		"meta" : {
			"request_id" : "1"
		},
		"type" : "hlr"
	}
}
</pre>|

h3. Запрос 2 номеров

|*запрос*|GET "https://имя.вашего.сервера/api/hlr?number=79183035536&request_id=1&number=79183035537&request_id=2&_login=LOGIN&_password=PASSWORD"|
|*ответ*|<pre>
{
	"data" : [
		{
			"attributes" : {
				"mcc" : "250",
				"mnc" : "001",
				"number" : "79183035536",
				"status" : "ok"
			},
			"id" : "1561371433517",
			"meta" : {
				"request_id" : "1"
			},
			"type" : "hlr"
		},
		{
			"attributes" : {
				"mcc" : "250",
				"mnc" : "001",
				"number" : "79183035537",
				"status" : "ok"
			},
			"id" : "1561371433518",
			"meta" : {
				"request_id" : "2"
			},
			"type" : "hlr"
		}
	]
}
</pre>|

h3. Ошибка

|*запрос*|GET "https://имя.вашего.сервера/api/hlr?number=79183035536&request_id=1&_login=LOGIN&_password=PASSWORD"|
|*ответ*|<pre>
{
	"errors" : [
		{
			"code" : "authentication",
			"detail" : "Please check your login and password",
			"title" : "Authentication error"
		}
	]
}
</pre>|

[[HTTP API hlr|English translation]]