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

Scope: telephony

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

Метод 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 (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

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

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

try
        {
            const response = await $b24.callMethod(
                'voximplant.sip.get',
                {
                    FILTER: {
                        CONFIG_ID: [3, 7, 9]
                    },
                    SORT: 'CONFIG_ID',
                    ORDER: 'ASC'
                }
            );
            
            const result = response.getData().result;
            console.log('Fetched SIP data:', result);
            processResult(result);
        }
        catch( error )
        {
            console.error('Error:', error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'voximplant.sip.get',
                    [
                        'FILTER' => [
                            'CONFIG_ID' => [3, 7, 9]
                        ],
                        'SORT' => 'CONFIG_ID',
                        'ORDER' => 'ASC'
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error fetching SIP data: ' . $e->getMessage();
        }

BX24.callMethod(
            'voximplant.sip.get',
            {
                FILTER: {
                    CONFIG_ID: [3, 7, 9]
                },
                SORT: 'CONFIG_ID',
                ORDER: 'ASC'
            },
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error(), result.error_description());
                }
                else
                {
                    console.log(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'voximplant.sip.get',
            [
                'FILTER' => [
                    'CONFIG_ID' => [3, 7, 9]
                ],
                'SORT' => 'CONFIG_ID',
                'ORDER' => 'ASC'
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Обработка ответа

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!"
        }

Название `тип`	Описание
error `string`	Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания
error_description `error_description`	Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

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

Код	Описание	Значение
`ACCESS_DENIED`	`Access denied!`	Недостаточно прав для получения списка SIP-линий

Статусы и коды системных ошибок

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус	Код Текст ошибки	Описание
`500`	`INTERNAL_SERVER_ERROR` Internal server error	Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	Превышен лимит на интенсивность запросов
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	Текущий метод не разрешен для вызова с помощью batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	Превышена максимальная длина параметров, переданных в метод batch
`401`	`NO_AUTH_FOUND` Wrong authorization data	Неверный access-токен или код вебхука
`400`	`INVALID_REQUEST` Https required	Для вызовов методов требуется использовать протокол HTTPS
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	REST API доступен только на коммерческих планах
`403`	`INVALID_CREDENTIALS` Invalid request credentials	У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	Манифест недоступен
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	Запрос требует более высоких привилегий, чем предоставляет токен вебхука
`401`	`expired_token` The access token provided has expired	Предоставленный access-токен доступа истек
`403`	`user_access_error` The user does not have access to the application	Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям
`500`	`PORTAL_DELETED` Portal was deleted	Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение

Добавить SIP-подключение

Изменить SIP-подключение

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

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

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

Примеры кодаПримеры кода

Обработка ответаОбработка ответа

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

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

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

Статусы и коды системных ошибокСтатусы и коды системных ошибок

Продолжите изучениеПродолжите изучение