метод REST scope: telephony

voximplant.sip.get

Получить SIP-линии приложения

Кто может выполнять: пользователь с правом Управление номерами — изменение

Описание

Метод voximplant.sip.get возвращает список SIP-линий, созданных текущим приложением.

Параметры

FILTER object необязательный

Объект для фильтрации в формате {"field_1": "value_1", ... "field_N": "value_N"}.

Смотрите ниже список доступных полей для фильтрации.

Поддерживаемые операторы в ключе фильтра:
- ! — не равно
- >= — больше либо равно
- > — больше
- <= — меньше либо равно
- < — меньше
- >< — между (диапазон, включительно)
- !>< — не между (вне диапазона)
- ? — поиск по строке
- = — равно, точное совпадение (используется по умолчанию)
- != — не равно
- % — LIKE, поиск по подстроке
- !% — NOT LIKE, поиск по подстроке

По умолчанию — без фильтрации.

Метод всегда добавляет системный фильтр по APP_ID текущего приложения

SORT string необязательный

Поле сортировки.

Используются поля из списка полей для фильтрации.

По умолчанию — без сортировки

ORDER string необязательный

Направление сортировки.

Возможные значения:
- ASC — сортировка по возрастанию
- DESC — сортировка по убыванию

По умолчанию — без сортировки

start integer необязательный

Параметр постраничной навигации.

Размер страницы результатов — 50 записей.

Чтобы получить вторую страницу, передайте 50; третью — 100 и так далее.

Формула:

start = (N - 1) * 50, где N — номер страницы

Доступные поля для фильтрации

ID integer необязательный

Внутренний идентификатор записи SIP-линии.

В ответе метода поле не возвращается

TYPE string необязательный

Тип АТС.

Возможные значения:

  • cloud — облачная АТС
  • office — офисная АТС
TITLE string необязательный

Название подключения

CONFIG_ID integer необязательный

Идентификатор настройки SIP-линии

REG_ID integer необязательный

Идентификатор SIP-регистрации.

Актуально для облачной АТС

APP_ID string необязательный

Идентификатор приложения.

Фильтр по этому полю принудительно ограничивается текущим приложением

SERVER string необязательный

Адрес сервера SIP-регистрации

LOGIN string необязательный

Логин для подключения к серверу

PASSWORD string необязательный

Пароль для подключения к серверу

INCOMING_SERVER string необязательный

Адрес сервера для входящих звонков.

Актуально для офисной АТС

INCOMING_LOGIN string необязательный

Логин для входящих звонков.

Актуально для офисной АТС

INCOMING_PASSWORD string необязательный

Пароль для входящих звонков.

Актуально для офисной АТС

AUTH_USER string необязательный

Имя пользователя для авторизации

OUTBOUND_PROXY string необязательный

Адрес SIP-прокси для исходящего подключения к оператору или АТС

DETECT_LINE_NUMBER string необязательный

Признак определения номера линии.

Возможные значения:

  • Y — определение номера линии включено
  • N — определение номера линии выключено
LINE_DETECT_HEADER_ORDER string необязательный

Порядок заголовков для определения номера линии

REGISTRATION_STATUS_CODE integer необязательный

Код статуса SIP-регистрации

REGISTRATION_ERROR_MESSAGE string необязательный

Текст ошибки SIP-регистрации

Примеры запроса

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"FILTER":{"CONFIG_ID":[3,7,9]},"SORT":"CONFIG_ID","ORDER":"ASC"}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/voximplant.sip.get

Ответ

HTTP-статус: 200

{
    "result": [
        {
        "TYPE": "cloud",
        "CONFIG_ID": "3",
        "REG_ID": "150907",
        "SERVER": "sipnet.ru",
        "LOGIN": "0045281811",
        "PASSWORD": "N7K4mCG9",
        "AUTH_USER": "",
        "OUTBOUND_PROXY": "",
        "DETECT_LINE_NUMBER": "N",
        "LINE_DETECT_HEADER_ORDER": "diversion;to",
        "REGISTRATION_STATUS_CODE": "200",
        "REGISTRATION_ERROR_MESSAGE": "",
        "TITLE": "SIP line"
        },
        {
        "TYPE": "office",
        "CONFIG_ID": "7",
        "SERVER": "office.provider.local",
        "LOGIN": "office_user",
        "PASSWORD": "secret",
        "INCOMING_SERVER": "ip.b24-6068-1537535782.bitrixphone.com",
        "INCOMING_LOGIN": "sip7",
        "INCOMING_PASSWORD": "71747523265mb091225eb31996a4a225",
        "AUTH_USER": null,
        "OUTBOUND_PROXY": null,
        "DETECT_LINE_NUMBER": "N",
        "LINE_DETECT_HEADER_ORDER": "diversion;to",
        "REGISTRATION_STATUS_CODE": "0",
        "REGISTRATION_ERROR_MESSAGE": null,
        "TITLE": "Office PBX 1"
        },
        {
        "TYPE": "cloud",
        "CONFIG_ID": "9",
        "REG_ID": "151083",
        "SERVER": "sip.provider.com",
        "LOGIN": "sip_user",
        "PASSWORD": "secret",
        "AUTH_USER": null,
        "OUTBOUND_PROXY": null,
        "DETECT_LINE_NUMBER": "N",
        "LINE_DETECT_HEADER_ORDER": "diversion;to",
        "REGISTRATION_STATUS_CODE": "502",
        "REGISTRATION_ERROR_MESSAGE": "Unable to resolve hostname",
        "TITLE": ""
        }
    ],
    "total": 3,
    "time": {
        "start": 1773662224,
        "finish": 1773662224.187874,
        "duration": 0.18787407875061035,
        "processing": 0,
        "date_start": "2026-03-16T14:57:04+03:00",
        "date_finish": "2026-03-16T14:57:04+03:00",
        "operating_reset_at": 1773662824,
        "operating": 0
    }
}

Возвращаемые данные

result object[]

Массив записей SIP-линий, созданных текущим приложением. Состав записей зависит от условий FILTER.

Пустой массив означает, что записи, соответствующие условиям FILTER, отсутствуют

total integer

Общее количество записей в выборке

next integer

Смещение следующей страницы (если есть)

time time

Информация о времени выполнения запроса

Обработка ошибок

HTTP-статус: 403

{
    "error": "ACCESS_DENIED",
    "error_description": "Access denied!"
}
Код Описание Значение
ACCESS_DENIED Access denied! Недостаточно прав для получения списка SIP-линий

Что будем искать? Например,Продвижение

Этот сайт использует куки-файлы. Оставаясь на сайте, Вы соглашаетесь на их использование. Для получения дополнительной информации, пожалуйста, ознакомьтесь с политикой в отношении персональных данных.