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
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
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
// Shape of the payload returned in result (match the "response handling" section of the page)
type SipAddResult = {
ID: string
TYPE: string
CONFIG_ID: string
REG_ID?: number
TITLE: string
SERVER: string
LOGIN: string
PASSWORD: string
AUTH_USER: string | null
OUTBOUND_PROXY: string | null
DETECT_LINE_NUMBER: string
LINE_DETECT_HEADER_ORDER: string
REGISTRATION_STATUS_CODE: number | null
REGISTRATION_ERROR_MESSAGE: string | null
INCOMING_SERVER?: string
INCOMING_LOGIN?: string
INCOMING_PASSWORD?: string
}
try {
const response = await $b24.actions.v2.call.make<SipAddResult>({
method: 'voximplant.sip.add',
params: {
TYPE: 'cloud',
TITLE: 'SIP line 1',
SERVER: 'sip.provider.com',
LOGIN: 'sip_user',
PASSWORD: 'secret',
},
requestId: Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info('Created SIP line:', result.ID, result.TYPE, result.TITLE)
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function addSipLine() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'voximplant.sip.add',
params: {
TYPE: 'cloud',
TITLE: 'SIP line 1',
SERVER: 'sip.provider.com',
LOGIN: 'sip_user',
PASSWORD: 'secret',
},
requestId: B24Js.Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info('Created SIP line:', result.ID, result.TYPE, result.TITLE)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', addSipLine)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.voximplant.sip.add(
type='cloud',
title='SIP line 1',
server='sip.provider.com',
login='sip_user',
password='secret',
).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Ошибка Bitrix API",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
print(f"Непредвиденная ошибка: {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>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "voximplant.sip.add", b24.Params{
"TYPE": "cloud",
"TITLE": "SIP line 1",
"SERVER": "sip.provider.com",
"LOGIN": "sip_user",
"PASSWORD": "secret",
})
if err != nil {
return fmt.Errorf("voximplant.sip.add: %w", err)
}
var item struct {
ID b24.ID `json:"ID"`
Type string `json:"TYPE"`
ConfigID b24.ID `json:"CONFIG_ID"`
RegID b24.ID `json:"REG_ID"`
Title string `json:"TITLE"`
Server string `json:"SERVER"`
}
if err := json.Unmarshal(res.Result, &item); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.ID, item.Type)
Ответ
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-линии |

