Получение информации об операторе
Веб-сервис позволяет получить информацию об операторе, который обслуживает номер абонента, включая данные о регионе и часовом поясе. Сервис основан на HTTP API.
Клиент отправляет запрос, в теле которого содержится пакет provideAddressOperatorRequest в формате XML или JSON с номерами телефонов. Платформа обрабатывает запрос клиента и отправляет ответный пакет provideAddressOperatorResponse, содержащий информацию об операторах, к которым относятся указанные номера.
URL-адрес подключения сообщается клиенту после заключения договора на использование сервиса
Сервис использует данные об обслуживании номеров операторами, учитывающие MNP.
Выбор формата передачи данных
Формат передачи данных определяется заголовком HTTP-запроса Content-Type. Допустимые значения: application/xml или application/json.
Если в запросе не указано значение заголовка Content-Type, заголовок имеет значение application/xml или заголовок имеет значение отличное от application/json — сервер будет ожидать запрос в формате XML. Ответ будет также возвращён в формате XML.
Пакет provideAddressOperatorRequest
В секции payload POST-запроса provideAddressOperatorRequest должен быть указан как минимум один целочисленный параметр address с номером телефона абонента в формате 7ХХХХХХХХХХ (без пробелов).
Примеры пакета
<!-- XML -->
<provideAddressOperatorRequest>
<header>
<auth>
<login>test</login>
<password>test</password>
</auth>
</header>
<payload>
<address>79031234567</address>
<address>79345678901</address>
</payload>
</provideAddressOperatorRequest>
// JSON
{
"provideAddressOperatorRequest": {
"header": {
"auth": {
"login": "test",
"password": "test"
}
},
"payload": {
"address": [
"79031234567",
"79345678901"
]
}
}
}
Пакет provideAddressOperatorResponse
В случае успешной обработки запроса платформа возвращает пакет provideAddressOperatorResponse с результатами в секции payload: статусом выполнения запроса, номерами телефонов и да нными об операторах, которые их обслуживают. При некорректном синтаксисе запроса или недоступности сервиса возвращается пакет errorResponse с кодом error-syntax или error-system, соответственно.
Параметры пакета
| Параметр | Тип | Характер | Описание |
|---|---|---|---|
payload/code | String | Обязательный | Статус обработки всего запроса. Возможные значения: - ok – запрос выполнен;- error-auth – ошибка авторизации;- error-forbidden– недостаточно прав для вызова метода. |
payload/addressInfo | Object | Обязательный | Структура с информацией по номеру телефона. |
.../addressInfo/code | String | Обязательный | Статус обработки запроса по номеру телефона. Возможные значения: - ok – запрос выполнен;- error-address-format– некорректный формат номера телефона;- error-address-unknown– в конфигурации платформы запрещена работа с ном ерной емкостью, к которой относится номер. |
.../addressInfo/address | Int | Обязательный | Номер телефона абонента. |
.../addressInfo/country | Object | Обязательный | Структура с информацией о стране оператора, к которому относится номер абонента. |
.../country/code | String | Обязательный | Кодовое обозначение страны в БД. |
.../country/name | String | Необязательный | Название страны. |
.../country/description | String | Необязательный | Описание страны. |
.../country/operator | Object | Обязательный | Структура с данными оператора связи, к которому относится номер абонента. |
.../operator/code | String | Обязательный | Код оператора в БД. |
.../operator/name | String | Необязательный | Название оператора. Пример: МТС. |
.../operator/description | String | Необязательный | Дополнительная информация об операторе. |
.../operator/unit | Object | Обязательный | Структура с данными конкретного территориального подразделения оператора, к которому относится номер абонента. |
.../unit/code | String | Обязательный | Кодовое обозначение подразделения в БД. |
.../unit/name | String | Необязательный | Название подразделения (юридического лица). Пример: ОАО "Мобильные ТелеСистемы". |
.../unit/description | String | Необязательный | Дополнительная информация о подразделении. |
.../unit/region | Object | Обязательный | Структура с данными региона, к которому относится номер абонента. |
.../region/code | String | Обязательный | Кодовое обозначение региона в БД. |
.../region/name | String | Необязательный | Название региона. Пример: Саратовская область. |
.../region/description | String | Необязательный | Дополнительная информация о регионе. |
.../region/timeZone | String | Обязательный | Часовой пояс региона. Пример: Europe/Samara. |
Примеры пакета
<!-- XML -->
<provideAddressOperatorResponse>
<header/>
<payload>
<code>ok</code>
<addressInfo>
<code>ok</code>
<address>79035289090</address>
<country>
<code>ru-beeline</code>
<name>Билайн</name>
<description>Билайн</description>
<operator>
<code>ru-beeline</code>
<name>Билайн</name>
<description>Билайн</description>
<unit>
<code>ru-beeline-beeline</code>
<name>ОАО "Вымпел-Коммуникации"</name>
<description>ОАО "Вымпел-Коммуникации"</description>
<region>
<code>ru-beeline-beeline-moskva</code>
<name>Москва</name>
<description>Москва</description>
<timeZone>Europe/Moscow</timeZone>
</region>
</unit>
</operator>
</country>
</addressInfo>
<addressInfo>
<code>error-address-format</code>
<address>79345</address>
</addressInfo>
</payload>
</provideAddressOperatorResponse>
// JSON
{
"provideAddressOperatorResponse": {
"header": {},
"payload": {
"code": "ok",
"addressInfo": [
{
"code": "ok",
"address": "79031234567",
"country": {
"code": "ru-beeline",
"name": "Билайн",
"description": "Билайн",
"operator": {
"code": "ru-beeline",
"name": "Билайн",
"description": "Билайн",
"unit": {
"code": "ru-beeline-beeline",
"name": "ОАО \"Вымпел-Коммуникации\"",
"description": "ОАО \"Вымпел-Коммуникации\"",
"region": {
"code": "ru-beeline-beeline-moskva",
"name": "Москва",
"description": "Москва",
"timeZone": "Europe/Moscow"
}
}
}
}
},
{
"code": "error-address-format",
"address": "79345"
},
{
"code": "ok",
"address": "79161234567",
"country": {
"code": "ru-mts",
"name": "МТС",
"description": "МТС",
"operator": {
"code": "ru-mts",
"name": "МТС",
"description": "МТС",
"unit": {
"code": "ru-mts-mts",
"name": "ОАО \"Мобильные ТелеСистемы\"",
"description": "ОАО \"Мобильные ТелеСистемы\"",
"region": {
"code": "ru-mts-mts-moskva",
"name": "Москва",
"description": "Москва",
"timeZone": "Europe/Moscow"
}
}
}
}
}
]
}
}
}
Ответ в случае некорректного формата запроса.
Если провайдер не может обработать запрос, он отправляет в ответ пакет errorResponse с кодом ошибки.
<!-- XML -->
<errorResponse>
<header/>
<payload>
<code>error-syntax</code>
</payload>
</errorResponse>
// JSON
{
"errorResponse": {
"header": {},
"payload": {
"code": "error-system"
}
}
}