Static API

Static API — это определенный программный интерфейс, который даёт возможность пользователям создавать SIP-транки со статическими IP-адресами (Static IP).

Static IP (Session Initiation Protocol Trunks) – это виртуальный канал связи, используемый для передачи голосовой информации через IP-сеть. С помощью Static IP можно звонить и принимать звонки через SIP-протокол.

Static IP — это метод, который позволяет вашему SIP-провайдеру идентифицировать и аутентифицировать вашу телефонную систему на основе фиксированного IP-адреса и номера порта. Провайдер заранее знает ваш IP-адрес и номер порта и может перенаправлять входящие вызовы в вашу телефонную систему, не требуя каких-либо дополнительных сообщений или учетных данных. Статический IP-адрес полезен, если ваша телефонная система имеет стабильный и безопасный IP-адрес или если вы хотите упростить настройку и избежать потенциальных проблем с регистрацией.

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

  • Create - создаёт ресурс SIP-соединения со статическим IP-адресом;
  • GetAttributes — получает информацию о ресурсе Static IP;
  • GetStaticList — получает список ресурсов Static IP;
  • Delete — удаляет ресурсStatic IP;
  • Update — изменяет определяемый номер Static IP.

Для звонков используются IP-адреса:

  • 80.75.130.99 — звонка с/на Static IP
  • 80.75.130.100 — звонка с/на SIP ID
  • 80.75.130.101 — переадресация на SIP-соединение

Метод Create

Примените этот метод для создания ресурса Static IP — SIP-соединения со статическим IP-адресом.

Точка подключения: Выполните POST-запрос с входными параметрами к точке подключения:

POST: https://api.exolve.ru/static-ip/v1/Create

Авторизация

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

Имя Тип Описание
Authorization string API-ключ приложения с Bearer перед ним. Пример: Bearer e***s0, где e***s0 замените на API-ключ вашего приложения

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

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

Параметр Тип Описание
static_ip_name string наименование Static IP
number uint64 определяемый номер для исходящих звонков с этого Static IP на номера ТфОП
static_ip string ваш статический IP-адрес
port uint32 порт

Примечание
Определяемый номер используется для исходящих звонков при выходе в телефонную сеть общего пользования (ТфОП). В качестве такого номера можно назначить только один из номеров этого же приложения.


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

Параметр Тип Описание
static_resource_id uint64 идентификатор Static IP

Примеры

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

{
    "static_ip_name": "static_ip_name",
    "number": 79991112233,
    "static_ip": "111.112.113.114"
}

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

{
    "static_resource_id": "1111"
}

Метод GetAttributes

Примените метод GetAttributes для получения деталей (атрибутов) конкретного ресурса Static IP.

Точка подключения: Выполните POST-запрос с входными параметрами к точке подключения:

POST: https://api.exolve.ru/static-ip/v1/GetAttributes

Авторизация

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

Имя Тип Описание
Authorization string API-ключ приложения с Bearer перед ним. Пример: Bearer e***s0, где e***s0 замените на API-ключ вашего приложения

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

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

Параметр Тип Описание
static_resource_id uint64 идентификатор Static IP

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

Параметр Тип Описание
status_name string статус активности ресурса Static IP
static_ip_name string название ресурса Static IP
create_date string дата создания ресурса Static IP в формате RFC-3339 / ISO-8601
attributes Attributes атрибуты Static IP
static_resource_id uint64 идентификатор ресурса Static IP
numbers_with_call_forwarding repeated uint64 номера, с которых переадресуются входящие звонки на этот ресурс Static IP

Attributes

Параметр Тип Описание
static_ip string статический IP-адрес
port uint32 порт
cli string определяемый номер для исходящих звонков с этого Static IP на номера ТфОП

Примеры

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

{
    "static_resource_id": 1111
}

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

{
    "status_name": "Active",
    "static_ip_name": "static_ip_name",
    "create_date": "2025-03-09T15:07:16.343019Z",
    "attributes": {
        "static_ip": "111.112.113.114",
        "port": 5060,
        "cli":  "79991234455"
               },
    "static_resource_id": "1111",
    "numbers_with_call_forwarding": [
        "79998887766"
    ]
}

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

Код Статус Пример сообщения Описание
400 Bad Request “error”: “Error getting sip static info: sip static is missing in the application” искомый Static IP не принадлежит этому приложению
400 Bad Request invalid value for uint64 type [value] значение поля static_resource_id невалидно
400 Bad Request Error adding SIP: customer is not active аккаунт пользователя неактивен
400 Bad Request “error”: “invalid value *” невалидное значение поля
400 Bad Request “error”: “unknown field *” невалидное значение поля
401 Unauthorized malformed token отсутствует API-ключ
401 Unauthorized Unauthorized невалидный API-ключ

Метод Delete

Примените метод Delete для удаления ресурса Static IP.

Точка подключения: Выполните POST-запрос с входными параметрами к точке подключения:

POST: https://api.exolve.ru/static-ip/v1/Delete

Авторизация

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

Имя Тип Описание
Authorization string API-ключ приложения с Bearer перед ним. Пример: Bearer e***s0, где e***s0 замените на API-ключ вашего приложения

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

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

Параметр Тип Описание
static_resource_id uint64 идентификатор ресурса Static IP

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

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

Примеры

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

{
    "static_resource_id": 1111
}

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

{}

Метод Update

Примените метод Update для изменения определяемого номера ресурса Static IP для исходящих звонков на номера телефонной сети общего пользования (ТфОП).

Точка подключения: Выполните POST-запрос с входными параметрами к точке подключения:

POST: https://api.exolve.ru/static-ip/v1/Update

Авторизация

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

Имя Тип Описание
Authorization string API-ключ приложения с Bearer перед ним. Пример: Bearer e***s0, где e***s0 замените на API-ключ вашего приложения

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

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

Параметр Тип Описание
static_resource_id uint64 идентификатор ресурса Static IP
number uint64 определяемый номер для исходящих звонков с этого Static IP на номера ТфОП

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

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

Примеры

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

{
    "ip_static_resource_id": 1111,     
    "number": 79991112233
}

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

{}