Создать SIP-линию voximplant.sip.add

Scope: telephony

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

Метод voximplant.sip.add создает новую SIP-линию с привязкой к приложению.

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

Обязательные параметры отмечены *

Название `тип`	Описание
SERVER* `string`	Адрес сервера SIP-регистрации
LOGIN* `string`	Логин для подключения к серверу
PASSWORD `string`	Пароль для подключения к серверу. Максимальная длина — 100 символов. Необязателен для вызова метода, но необходим для рабочей регистрации у оператора
TYPE `string`	Тип АТС. Возможные значения: `cloud` - облачная АТС `office` - офисная АТС По умолчанию: `cloud`
TITLE `string`	Название подключения. Если параметр не передан, в интерфейсе для линии будет отображаться системное название по типу подключения: для `cloud` — Облачная АТС (ID) для `office` — Офисная АТС (ID) где `ID` — внутренний идентификатор записи SIP-линии. Поле `TITLE` в ответе метода при этом будет пустым

Можно подключить не более 10 облачных SIP-линий. При превышении лимита метод возвращает ошибку MAX_CLOUD_PBX

Примеры кода

Как использовать примеры в документации

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"TYPE":"cloud","TITLE":"SIP line 1","SERVER":"sip.provider.com","LOGIN":"sip_user","PASSWORD":"secret"}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/voximplant.sip.add

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"TYPE":"cloud","TITLE":"SIP line 1","SERVER":"sip.provider.com","LOGIN":"sip_user","PASSWORD":"secret","auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/voximplant.sip.add

try
        {
            const response = await $b24.callMethod(
                'voximplant.sip.add',
                {
                    TYPE: 'cloud',
                    TITLE: 'SIP line 1',
                    SERVER: 'sip.provider.com',
                    LOGIN: 'sip_user',
                    PASSWORD: 'secret'
                }
            );
        
            const result = response.getData().result;
            console.log('Data:', result);
        }
        catch (error)
        {
            console.error('Error:', error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'voximplant.sip.add',
                    [
                        'TYPE' => 'cloud',
                        'TITLE' => 'SIP line 1',
                        'SERVER' => 'sip.provider.com',
                        'LOGIN' => 'sip_user',
                        'PASSWORD' => 'secret',
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error: ' . $e->getMessage();
        }

BX24.callMethod(
            'voximplant.sip.add',
            {
                TYPE: 'cloud',
                TITLE: 'SIP line 1',
                SERVER: 'sip.provider.com',
                LOGIN: 'sip_user',
                PASSWORD: 'secret'
            },
            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.add',
            [
                'TYPE' => 'cloud',
                'TITLE' => 'SIP line 1',
                'SERVER' => 'sip.provider.com',
                'LOGIN' => 'sip_user',
                'PASSWORD' => 'secret',
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

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

HTTP-статус: 200

Пример ответа при создании облачной АТС

{
            "result": {
                "ID": "5",
                "TYPE": "cloud",
                "CONFIG_ID": "5",
                "REG_ID": 151082,
                "TITLE": "SIP line 1",
                "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": null,
                "REGISTRATION_ERROR_MESSAGE": null
            },
            "time": {
                "start": 1773654128,
                "finish": 1773654129.048472,
                "duration": 1.0484719276428223,
                "processing": 1,
                "date_start": "2026-03-16T12:42:08+03:00",
                "date_finish": "2026-03-16T12:42:09+03:00",
                "operating_reset_at": 1773654728,
                "operating": 0.2883341312408447
            }
        }

Пример ответа при создании офисной АТС

{
            "result": {
                "ID": "7",
                "TYPE": "office",
                "CONFIG_ID": "7",
                "SERVER": "office.provider.local",
                "LOGIN": "office_user",
                "PASSWORD": "secret",
                "INCOMING_SERVER": "ip.b24-6058-1587535982.bitrixphone.com",
                "INCOMING_LOGIN": "sip7",
                "INCOMING_PASSWORD": "71747503265fb091223eb31776a4a225",
                "AUTH_USER": null,
                "OUTBOUND_PROXY": null,
                "DETECT_LINE_NUMBER": "N",
                "LINE_DETECT_HEADER_ORDER": "diversion;to",
                "REGISTRATION_STATUS_CODE": null,
                "REGISTRATION_ERROR_MESSAGE": null,
                "TITLE": "Office PBX 1"
            },
            "time": {
                "start": 1773654928,
                "finish": 1773654928.708338,
                "duration": 0.7083380222320557,
                "processing": 0,
                "date_start": "2026-03-16T12:55:28+03:00",
                "date_finish": "2026-03-16T12:55:28+03:00",
                "operating_reset_at": 1773655528,
                "operating": 0.24362492561340332
            }
        }

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

Название `тип`	Описание
result `object`	Объект с созданной SIP-линией
ID `string`	Внутренний идентификатор записи SIP-линии
TYPE `string`	Тип АТС
CONFIG_ID `string`	Идентификатор настройки SIP-линии
REG_ID `integer`	Идентификатор SIP-регистрации. Возвращается при создании облачной АТС
TITLE `string`	Название подключения
SERVER `string`	Адрес сервера SIP-регистрации
LOGIN `string`	Логин для подключения к серверу
PASSWORD `string`	Пароль для подключения к серверу
AUTH_USER `string`	Пользователь для SIP-авторизации
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-регистрации
INCOMING_SERVER `string`	Адрес сервера для входящих звонков. Возвращается при создании офисной АТС
INCOMING_LOGIN `string`	Логин для входящих звонков. Возвращается при создании офисной АТС
INCOMING_PASSWORD `string`	Пароль для входящих звонков. Возвращается при создании офисной АТС
time `time`	Информация о времени выполнения запроса

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

HTTP-статус: 400, 403

{
            "error": "CHECK_FIELDS_ERROR",
            "error_description": "Не указан адрес сервера"
        }

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

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

Код	Описание	Значение
`CHECK_FIELDS_ERROR`	`Не указан адрес сервера`	Не указан обязательный параметр `SERVER`
`CHECK_FIELDS_ERROR`	`Не указан логин для подключения к серверу`	Не указан обязательный параметр `LOGIN`
`CHECK_FIELDS_ERROR`	`Пароль для подключения к серверу не может быть более 100 символов`	Превышен лимит значения для параметра `PASSWORD`
`TITLE_EXISTS`	`Указанное название подключения уже зарегистрировано в системе`	Линия с таким названием уже существует
`MAX_CLOUD_PBX`	`Вы не можете подключить более 10 виртуальных АТС.`	Превышен лимит облачных SIP-линий
`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.add

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

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

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

Пример ответа при создании облачной АТСПример ответа при создании облачной АТС

Пример ответа при создании офисной АТСПример ответа при создании офисной АТС

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

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

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

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

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