метод REST scope: telephony

voximplant.sip.add

Создать SIP-линию

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

Описание

Метод 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 в ответе метода при этом будет пустым

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

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

Ответ

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 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

{
    "error": "CHECK_FIELDS_ERROR",
    "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-линии

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

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