Метод API для получения информации об операторах

10 июня 2024

Метод предназначен для получения информации о мобильных операторах по номерам телефона.

  1. Отправьте запрос в службу технической поддержки support@edna.ru, чтобы подключить сервис.
  2. Получите URL-адрес подключения.
  3. Отправьте на платформу запрос provideAddressOperatorRequest с указанием номеров.
  4. Получите от платформы ответ provideAddressOperatorResponse с информацией о мобильных операторах.

Запрос

В секции payload запроса provideAddressOperatorRequest укажите как минимум один целочисленный параметр address с номером телефона абонента в формате 7ХХХХХХХХХХ без пробелов.

Пример запроса provideAddressOperatorRequest:

<provideAddressOperatorRequest>
    <header>
        <auth>
            <login>test</login>
            <password>test</password>
        </auth>
    </header>
    <payload>
        <address>79031234567</address>
        <address>79345</address>
        <address>79161234567</address>
    </payload>
</provideAddressOperatorRequest>

Ответ

В ответ на запрос платформа возвращает пакет provideAddressOperatorResponse. Секция payload содержит результаты:

  • статус выполнения запроса;
  • телефонные номера и данные о мобильных операторах.

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

ПараметрХарактерТипОписание
codeОбязательныйstringСтатус обработки всего запроса. Возможные значения:
• ok — запрос выполнен;
• error-system — сервис недоступен, обратитесь в
службу технической поддержки;
• error-auth — ошибка авторизации;
• error-syntax — неверный синтаксис запроса.
addressInfoОбязательныйobjectСтруктура с информацией по номеру телефона.
codeОбязательныйstringСтатус обработки запроса по номеру телефона. Возможные значения:
• ok — запрос выполнен;
• error-address-format — некорректный формат номера
телефона;
• error-address-unknown — в конфигурации платформы
запрещена работа с номерной емкостью, к которой
относится номер.
addressОбязательныйintegerНомер телефона абонента.
countryОбязательныйobjectСтруктура с информацией о стране оператора, к которому
относится номер абонента.

Параметры, входящие в country:

ПараметрХарактерТипОписание
codeОбязательныйstringКодовое обозначение страны в базе данных.
nameНеобязательныйstringНазвание страны.
descriptionНеобязательныйstringОписание страны.
operatorОбязательныйobjectСтруктура с данными оператора, к которому
относится номер абонента.

Параметры, входящие в operator:

ПараметрХарактерТипОписание
codeОбязательныйstringКод оператора в базе данных.
nameНеобязательныйstringНазвание оператора. Пример: МТС.
descriptionНеобязательныйstringДополнительная информация об операторе.
unitОбязательныйobjectСтруктура с данными конкретного территориального
подразделения оператора, к которому относится номер
абонента.

Параметры, входящие в unit:

ПараметрХарактерТипОписание
codeОбязательныйstringКодовое обозначение подразделения в базе данных.
nameНеобязательныйstringНазвание подразделения (юридического лица). Пример:
ОАО «Мобильные ТелеСистемы».
descriptionНеобязательныйstringДополнительная информация о подразделении.
regionОбязательныйobjectСтруктура с данными региона, к которому относится номер
абонента.

Параметры, входящие в region:

ПараметрХарактерТипОписание
codeОбязательныйstringКодовое обозначение региона в базе данных.
nameНеобязательныйstringНазвание региона. Пример: Саратовская область.
descriptionНеобязательныйstringДополнительная информация о регионе.
timeZoneОбязательныйstringЧасовой пояс региона. Пример: Europe/Samara.

Пример пакета consumeOutMessageResponse:

<?xml version="1.0" ?>
<provideAddressOperatorResponse>
    <header></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>
In this article
Разделы статьи