Для AI-агентов: markdown этой страницы — /docs-content/voximplant-sip/create.md индекс документации — /llms.txt

Создать подключение

POST /v1/voximplant-sip

Создаёт SIP-подключение офисной или облачной АТС, через которое портал принимает и совершает звонки. Тело — плоский JSON-объект.

Поля запроса (body)

Поле	Тип	Обяз.	Описание
`server`	string	да	Адрес SIP-сервера
`login`	string	да	Логин на SIP-сервере
`password`	string	нет	Пароль подключения. В ответах не возвращается — вместо него приходит признак `hasPassword`
`type`	string	нет	Тип АТС: `office` — офисная, `cloud` — облачная. По умолчанию `cloud`. После создания тип не меняется
`title`	string	нет	Название подключения

Все значения — строки. Других полей тело не принимает.

Примеры

curl — личный ключ

Terminal

curl -X POST "https://vibecode.bitrix24.tech/v1/voximplant-sip" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "office",
    "title": "Офисная АТС",
    "server": "sip.example.com",
    "login": "office-line",
    "password": "EXAMPLE_SIP_PASSWORD"
  }'

curl — OAuth-приложение

Terminal

curl -X POST "https://vibecode.bitrix24.tech/v1/voximplant-sip" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "office",
    "title": "Офисная АТС",
    "server": "sip.example.com",
    "login": "office-line",
    "password": "EXAMPLE_SIP_PASSWORD"
  }'

JavaScript — личный ключ

javascript

const res = await fetch('https://vibecode.bitrix24.tech/v1/voximplant-sip', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    type: 'office',
    title: 'Офисная АТС',
    server: 'sip.example.com',
    login: 'office-line',
    password: 'EXAMPLE_SIP_PASSWORD',
  }),
})

const { success, data } = await res.json()
if (success) {
  console.log('Создано подключение', data.configId, 'входящий сервер:', data.incomingServer)
}

JavaScript — OAuth-приложение

javascript

const res = await fetch('https://vibecode.bitrix24.tech/v1/voximplant-sip', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    type: 'office',
    title: 'Офисная АТС',
    server: 'sip.example.com',
    login: 'office-line',
    password: 'EXAMPLE_SIP_PASSWORD',
  }),
})

const { success, data } = await res.json()
if (success) {
  console.log('Создано подключение', data.configId, 'входящий сервер:', data.incomingServer)
}

Поля ответа

Успешный ответ приходит с кодом 201. Пароли в ответ не попадают — вместо них приходят признаки hasPassword и hasIncomingPassword.

Поле	Тип	Описание
`success`	boolean	`true` при успехе
`data.id`	string	ID созданного подключения, совпадает с `configId`
`data.configId`	string	ID подключения — по нему подключение читают, изменяют и удаляют
`data.type`	string	Тип АТС: `office` — офисная, `cloud` — облачная
`data.title`	string	Название подключения
`data.server`	string	Адрес SIP-сервера
`data.login`	string	Логин на SIP-сервере
`data.hasPassword`	boolean	Задан ли пароль подключения
`data.authUser`	string \| null	Имя пользователя для авторизации на SIP-сервере. `null`, если не задано
`data.outboundProxy`	string \| null	Адрес прокси-сервера для исходящих вызовов. `null`, если не задан
`data.detectLineNumber`	string	Определять ли номер линии по SIP-заголовкам входящего вызова: `N` — не определять
`data.lineDetectHeaderOrder`	string	SIP-заголовки, по которым определяется номер линии, в порядке проверки, например `diversion;to`
`data.registrationStatusCode`	string \| null	Код результата регистрации на SIP-сервере. Сразу после создания `null`
`data.registrationErrorMessage`	string \| null	Текст ошибки регистрации. `null`, если ошибки нет
`data.regId`	number	Только облачная АТС: ID регистрации на SIP-сервере. В ответе создания — число, в списке и при получении — строка
`data.incomingServer`	string	Только офисная АТС: адрес сервера для входящих вызовов, его выдаёт Битрикс24
`data.incomingLogin`	string	Только офисная АТС: логин для входящих вызовов, его выдаёт Битрикс24
`data.hasIncomingPassword`	boolean	Только офисная АТС: задан ли пароль для входящих вызовов

Пример ответа

JSON

{
  "success": true,
  "data": {
    "id": "17",
    "type": "office",
    "configId": "17",
    "server": "sip.example.com",
    "login": "office-line",
    "hasPassword": true,
    "incomingServer": "ip.b24-1234-1234567890.bitrixphone.com",
    "incomingLogin": "sip17",
    "hasIncomingPassword": true,
    "authUser": null,
    "outboundProxy": null,
    "detectLineNumber": "N",
    "lineDetectHeaderOrder": "diversion;to",
    "registrationStatusCode": null,
    "registrationErrorMessage": null,
    "title": "Офисная АТС"
  }
}

Пример ответа при ошибке

400 — не передан server или login: