Static API

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

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

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

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

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

Метод Create

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

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

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

Авторизация

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

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

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

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

Примеры

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

{
    "static_ip_name": "Test",
    "number": 79991112233,
    "static_ip": "127.0.0.1"
}

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

{
    "static_resource_id": "111"
}

Метод GetAttributes

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

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

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

Авторизация

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

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

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

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

Attributes

Примеры

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

{
    "static_resource_id": 111
}

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

{
    "status_name": "Active",
    "static_ip_name": "Test",
    "create_date": "2023-03-09T15:07:16.343019Z",
    "attributes": {
        "static_ip": "127.0.0.1",
        "port": 10,
        "cli":  "79991234455"
               }
}

Метод Delete

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

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

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

Авторизация

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

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

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

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

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

Примеры

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

{
    "static_resource_id": 111
}

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

{}

Метод Update

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

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

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

Авторизация

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

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

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

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

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

Примеры

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

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

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

{}