Numbering API

Numbering API — программный интерфейс, который позволяет пользователям управлять номерами приложения в Личном кабинете: покупать свободные номера, удалять их, настраивать переадресацию и т.д.

Numbering API Exolve предлагает пользователям следующие методы для управления номерами:

• GetList - получает справку о параметрах номеров, доступных в Exolve. Характеристики можно использовать при поиске свободных номеров для покупки;

• GetFree - получает список свободных номеров для покупки по заданным параметрам;

• Lock - бронирует свободный номер для покупки;

• Unlock - отменяет бронирование номера;

• Buy - покупает бронированный номер;

• Delete - удаляет купленный номер;

• GetInfo - получает информацию о купленном номере;

• SetCallForwarding - настраивает переадресацию входящих на номер вызовов;

• DeleteCallForwarding - удаляет переадресацию входящих на номер вызовов;

• GetAttributes - получает информацию о настройках переадресации и записи разговоров на номере.

Решения, где используется Numbering API

Попробовать бесплатно

Метод GetList

Примените этот метод для получения справочника по характеристикам номеров (тип, категория, регион, и проект). Для этого выполните POST запрос с входными параметрами к точке подключения, указанными ниже.

Точка подключения:

POST: https://api.exolve.ru/number/reference/v1/GetList

Авторизация

Передайте следующие Заголовки HTTP для успешной авторизации.

Входные параметры

Передайте пустой JSON в теле запроса.

Выходные параметры

NumberTypes

Categories

Regions

Возможные ошибки

Примеры

Входные параметры:

{}

Выходные параметры:

{
    "regions": [
        {
            "project_id": 10008,
            "region_id": 10257,
            "parent_region_id": 10084,
            "region_code": "SLH",
            "region_name": "Salekhard",
            "description": "Салехард"
        }
     ],
    "types": [
        {
            "type_id": 1104,
            "type_name": "DEF"
        }
     ],
    "categories": [
        {
            "category_id": 10003,
            "type_id": 1107,
            "type_name": "CEN",
            "category_name": "REGULAR"
        }
    ]
}

Метод GetFree

Примените этот метод для получения списка свободных номеров для покупки. Для этого выполните POST запрос с входными параметрами к точке подключения, указанными ниже.

Точка подключения:

POST: https://api.exolve.ru/number/v1/GetFree

Авторизация

Передайте следующие Заголовки HTTP для успешной авторизации.

Входные параметры

Передайте следующие параметры в теле запроса в JSON формате. Параметры, отмеченные жирным шрифтом, являются обязательными.

Выходные параметры

NumberElement

Список типов номеров (type_id)

Список категорий номеров (category_id)

Список регионов (region_id)

Маска

Возможные ошибки

Примеры

Пример получения свободных номеров для региона - Москва, категории- Обычный, тип - Мобильный:

// Входные параметры
{
    "type_id": 1104,
    "region_id": 10230,
    "category_id": 10000,
    "random": true,
    "mask": "7986...5275",
    "limit": 1
}

// Выходные параметры
{
    "numbers": [
        {
            "number_code": "79862285275",
            "type_name": "DEF",
            "region_name": "Moscow",
            "category_name": "REGULAR",
            "subscription_fee": 150,
            "install_fee": 590
        }
    ]
}

Пример получения свободных номеров для региона - Санкт-Петербург, категории- Бронзовый, тип - Городской:

// Входные параметры
{
    "type_id": 1105,
    "region_id": 10182,
    "category_id": 10011,
    "random": true,
    "mask": "781221*",
    "limit": 1
}
// Выходные параметры
{
    "numbers": [
        {
            "number_code": "78122133337",
            "type_name": "ABC",
            "region_name": "St. Petersburg",
            "category_name": "BRONZE",
            "subscription_fee": 200,
            "install_fee": 1000
        }
    ]
}

Пример получения свободных номеров для региона - Россия, категории- Серебряный, тип - 7-800:

// Входные параметры
{
    "type_id": 1106,
    "region_id": 10084,
    "category_id": 10022,
    "random": true,
    "limit": 1
}
// Выходные параметры
{
    "numbers": [
        {
            "number_code": "78003333623",
            "type_name": "KDU",
            "region_name": "Russia",
            "category_name": "SILVER",
            "subscription_fee": 3500,
            "install_fee": 50000
        }
    ]
}

Метод Lock

Примените этот метод для бронирования номера перед его покупкой. Для этого выполните POST-запрос с входными параметрами к точке подключения, указанными ниже.

Точка подключения:

POST: https://api.exolve.ru/number/v1/Lock

Авторизация

Передайте следующие Заголовки HTTP для успешной авторизации.

Входные параметры

Передайте следующие параметры в теле запроса в JSON-формате. Параметры, отмеченные жирным шрифтом, являются обязательными.

Выходные параметры

Возможные ошибки

Примеры

Входные параметры:

{
    "number_code": 74951340002,
    "seconds": 500
}

Выходные параметры:

{
    "Id": 1001884
}

Метод Unlock

Примените этот метод для отмены бронирования номера. Для этого выполните POST запрос с входными параметрами к точке подключения, указанными ниже.

Точка подключения:

POST: https://api.exolve.ru/number/v1/Unlock

Авторизация

Передайте следующие Заголовки HTTP для успешной авторизации.

Входные параметры

Передайте следующие параметры в теле запроса в JSON формате. Параметры, отмеченные жирным шрифтом, являются обязательными.

Выходные параметры

Пустой JSON с 200 OK статусом.

Возможные ошибки

Примеры

Входные параметры:

{
    "number_code": 73412209107,
    "uid": 1000988
}

Выходные параметры:

{}

Метод Lock

Примените этот метод для бронирования номера перед его покупкой. Для этого выполните POST-запрос с входными параметрами к точке подключения, указанными ниже.

Точка подключения:

POST: https://api.exolve.ru/number/v1/Lock

Авторизация

Передайте следующие Заголовки HTTP для успешной авторизации.

Входные параметры

Передайте следующие параметры в теле запроса в JSON-формате. Параметры, отмеченные жирным шрифтом, являются обязательными.

Выходные параметры

Возможные ошибки

Примеры

Входные параметры:

{
    "number_code": 74951340002,
    "seconds": 500
}

Выходные параметры:

{
    "Id": 1001884
}

Метод Buy

Примените этот метод для покупки ранее бронированного номера. Для этого выполните POST запрос с входными параметрами к точке подключения, указанными ниже.

Точка подключения:

POST: https://api.exolve.ru/number/v1/Buy

Авторизация

Передайте следующие Заголовки HTTP для успешной авторизации.

Входные параметры

Передайте следующие параметры в теле запроса в JSON формате. Параметры, отмеченные жирным шрифтом, являются обязательными.

Выходные параметры

Пустой JSON с 200 OK статусом.

Возможные ошибки

Примеры

Входные параметры:

{
    "number_code": 74996480010,
    "reserve_uid": 1000993
}

Выходные параметры:

{}

Метод Delete

Примените этот метод для удаления ранее купленного номера. Для этого выполните POST запрос с входными параметрами к точке подключения, указанными ниже.

Точка подключения:

POST: https://api.exolve.ru/number/v1/Delete

Авторизация

Передайте следующие Заголовки HTTP для успешной авторизации.

Входные параметры

Передайте следующие параметры в теле запроса в JSON формате. Параметры, отмеченные жирным шрифтом, являются обязательными.

Выходные параметры

Пустой JSON с 200 OK статусом.

Возможные ошибки

Примеры

Входные параметры:

{
    "number_code": 74951341115
}

Выходные параметры:

{}

Метод GetInfo

Примените этот метод для получения информации об одном купленном номере. Для этого выполните POST запрос с входными параметрами к точке подключения, указанными ниже.

Точка подключения:

POST: https://api.exolve.ru/number/customer/v1/GetInfo

Авторизация

Передайте следующие Заголовки HTTP для успешной авторизации.

Входные параметры

Передайте следующие параметры в теле запроса в JSON формате. Параметры, отмеченные жирным шрифтом, являются обязательными.

Выходные параметры

Примеры

Входные параметры:

{  
    "number_code": 79011550006
}

Выходные параметры:

{
    "number_name": "79016220127",
    "type_name": "DEF",
    "region_name": "Moscow",
    "application_name": "test data_феекшигеуы",
    "subscription_fee": 150,
    "install_fee": 333,
    "create_date": "2022-12-06T07:37:34.543471Z",
    "application_uuid": "828b86c9-f3e5-4312-aa87-b2cb93f0ded2",
    "category_name": "REGULAR"
}

Метод SetCallForwarding

Примените этот метод для настройки переадресации входящих вызовов. Для этого выполните POST запрос с входными параметрами к точке подключения, указанными ниже.

Точка подключения:

POST: https://api.exolve.ru/number/v1/SetCallForwarding

Авторизация

Передайте следующие Заголовки HTTP для успешной авторизации.

Входные параметры

Передайте следующие параметры в теле запроса в JSON формате. Параметры, отмеченные жирным шрифтом, являются обязательными.

CallForwardingType

CallForwardingData

CallForwardingNumber

RedirectType

CallControl

Period

CallForwardingIpcr

CallForwardingStatic

Выходные параметры

Пустой JSON с 200 OK статусом.

Примеры

Входные параметры для переадресации на номер или SIP ID:

{
    "number_code": 74991112233,
    "call_forwarding_type": 2,
    "call_forwarding_number": {
       "redirect_type": 1,
       "call_control":[
           {
                "timeout": "16",
                "active": true,
                "period": "wd {Mon-Fri} hr {6am-14pm}",
                "period_description": "график будни",
                "name": "звонит клиент",
                "redirect_number": "74992223344" // или 883140XXXXXXXXX (SIP ID)
            }
       ],
        "event_url": "https://example.com/",
        "event_extended": true,
        "client_id": "test",
        "file_to_a": "12345",
        "file_to_b": "54321",
        "masking": true,
        "display_number": "74995556677"
    }
}

Входные параметры для переадресации на URL:

{
    "number_code": 74991112233,
    "call_forwarding_type": 3,
    "call_forwarding_ipcr": {
        "url": "https://example.com/",
        "reserve": "74993334455"
    }
}

Входные параметры для переадресации на SIP-транк (Static IP):

{
    "number_code": 74991112233,
    "call_forwarding_type": 4,
    "call_forwarding_static": {
       "static_ip": "127.0.0.1",
       "port": 10,
       "timeout": 30,
       "did": 111
    }
}

Выходные параметры:

{}

Примечание к отправке уведомлений при входящем звонке

Вы можете настроить отправку уведомлении на URL о ходе входящих звонков двумя способами:

• Установить URL для определённого номера, передав значение в поле “event_url” при выполнения метода SetCallForwarding.

• Установить URL в настройках приложения в блоке “Уведомления о событиях” в Личном кабинете разработчика. Установленный URL применяется ко всем номерам приложения.

При отправке уведомлений о ходе входящего звонка платформа Exolve сначала проверяет, указан ли URL индивидуально на номере вызова. Если URL не указан на номере, проверяет, указан ли в приложении. Подробнее:

1. Если URL указан и на номере, и в приложении, то уведомления будут отправлены на URL из индивидуальных настроек номера.
2. Если URL указан на номере, но пуст в приложении, то уведомления будут отправлены на URL из индивидуальных настроек номера.
3. Если URL не указан на номере, но указан в приложении, то уведомления будут отправлены на URL из приложения

Метод DeleteCallForwarding

Примените этот метод для удаления настроек переадресации входящих вызовов. Для этого выполните POST запрос с входными параметрами к точке подключения, указанными ниже.

Точка подключения:

POST: https://api.exolve.ru/number/v1/DeleteCallForwarding

Авторизация

Передайте следующие Заголовки HTTP для успешной авторизации.

Входные параметры

Передайте следующие параметры в теле запроса в JSON формате. Параметры, отмеченные жирным шрифтом, являются обязательными.

Выходные параметры

Пустой JSON с 200 OK статусом.

Возможные ошибки

Примеры

Входные параметры:

{
    "number_code": 74951341115
}

Выходные параметры:

{}

Метод GetAttributes

Примените этот метод для получения информации о настройке купленного номера (переадресация, запись разговоров). Для этого выполните POST запрос с входными параметрами к точке подключения, указанными ниже.

Точка подключения:

POST: https://api.exolve.ru/number/v1/GetAttributes

Авторизация

Передайте следующие Заголовки HTTP для успешной авторизации.

Входные параметры

Передайте следующие параметры в теле запроса в JSON формате. Параметры, отмеченные жирным шрифтом, являются обязательными.

Выходные параметры

NumberAttributes

ForwardingType

ForwardingNumber

CallControl

ForwardingIpcr

Возможные ошибки

Примеры

Входные параметры:

{
    "number_code": 74996487174
}

Выходные параметры для номера с переадресацией на номер:

{
    "number_resource_id": "94004",
    "status_name": "Active",
    "attributes": {
        "call_record": false,
        "call_forwarding_type": 2,
        "call_forwarding_number": {
            "redirect_type": 1,
            "call_control":[
                {
                    "period": "always",
                    "period_description": "всегда переадресовывать",
                    "timeout": "16",
                    "active": true,
                    "name": "звонит клиент",
                    "redirect_number": "74996480184",
                    "dtmf": "896"
                }
            ],
           "event_url": "https://example.com/",
           "event_extended": true,
           "file_to_a": "12345",
           "file_to_b": "54321",
           "answer": true,
           "masking": true,
           "display_number": "74995557890"
        }
    }
}

Входные параметры для переадресации на URL:

{
    "number_resource_id": "51802",
    "status_name": "",
    "attributes": {
        "call_record": true,
        "call_forwarding_type": "CALL_FORWARDING_TYPE_IPCR",
        "call_forwarding_ipcr": {
            "url": "http://example.com",
            "reserve": "74996482846"
        }
    }
}

Решения, где используется Numbering API

Попробовать бесплатно