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

Получить подключение

GET /v1/voximplant-sip/:configId

Возвращает SIP-подключение офисной или облачной АТС по ID — например, чтобы после создания проверить регистрацию на SIP-сервере.

Параметры

Параметр	Тип	Обяз.	Описание
`configId` (path)	number	да	ID подключения. Список: `GET /v1/voximplant-sip`

Примеры

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

Terminal

curl "https://vibecode.bitrix24.tech/v1/voximplant-sip/17" \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal

curl "https://vibecode.bitrix24.tech/v1/voximplant-sip/17" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

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

javascript

const res = await fetch('https://vibecode.bitrix24.tech/v1/voximplant-sip/17', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data } = await res.json()
if (success) {
  console.log(data.title, data.server, 'пароль задан:', data.hasPassword)
}

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

javascript

const res = await fetch('https://vibecode.bitrix24.tech/v1/voximplant-sip/17', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

const { success, data } = await res.json()
if (success) {
  console.log(data.title, data.server, 'пароль задан:', data.hasPassword)
}

Поля ответа

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

Поле	Тип	Описание
`success`	boolean	`true` при успехе
`data`	object	SIP-подключение. Его поля — строками `data.*` ниже
`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-сервере, например `502`, когда сервер не найден
`data.registrationErrorMessage`	string \| null	Текст ошибки регистрации. `null`, если ошибки нет
`data.regId`	string	Только облачная АТС: ID регистрации на SIP-сервере
`data.incomingServer`	string	Только офисная АТС: адрес сервера для входящих вызовов, его выдаёт Битрикс24
`data.incomingLogin`	string	Только офисная АТС: логин для входящих вызовов, его выдаёт Битрикс24
`data.hasIncomingPassword`	boolean	Только офисная АТС: задан ли пароль для входящих вызовов

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

JSON

{
  "success": true,
  "data": {
    "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": "0",
    "registrationErrorMessage": null,
    "title": "Офисная АТС"
  }
}

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

404 — подключение не найдено: