#Добавить линию

POST /v1/telephony-lines

Регистрирует новую внешнюю линию приложения на портале. После создания линия доступна в `GET /v1/telephony-lines` и может использоваться как fromLine в исходящих звонках. Поля передаются плоско в корне JSON — без обёртки fields.

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

#Примеры

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

curl -X POST "https://vibecode.bitrix24.tech/v1/telephony-lines" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "number": "sip-line-1",
    "name": "Основная линия",
    "crmAutoCreate": false
  }'

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

curl -X POST "https://vibecode.bitrix24.tech/v1/telephony-lines" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "number": "sip-line-1",
    "name": "Основная линия",
    "crmAutoCreate": false
  }'

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

const res = await fetch('https://vibecode.bitrix24.tech/v1/telephony-lines', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    number: 'sip-line-1',
    name: 'Основная линия',
    crmAutoCreate: false,
  }),
})

const { success, data } = await res.json()
console.log('Внутренний ID записи:', data.id)

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

const res = await fetch('https://vibecode.bitrix24.tech/v1/telephony-lines', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    number: 'sip-line-1',
    name: 'Основная линия',
    crmAutoCreate: false,
  }),
})

const { success, data } = await res.json()

#Поля ответа

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

{
  "success": true,
  "data": {
    "id": 17
  }
}

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

422 — поле number не передано:

{
  "success": false,
  "error": {
    "code": "BITRIX_ERROR",
    "message": "NUMBER should not be empty"
  }
}

#Ошибки

Полный список общих ошибок API — Ошибки.

#Известные особенности

serverName объявлено в GET /v1/telephony-lines/fields, но не функционирует. Поле принимается при создании (ответ 201), но не сохраняется, не возвращается в чтении и не обновляется (PATCH с одним serverName отвечает 422 «There are no fields to update»). Не используйте — переданное значение теряется.

Поле crmAutoCreate — camelCase boolean. Передавайте true/false; если поле опущено, линия создаётся со значением по умолчанию true. Ранее принималось только UPPER_SNAKE-имя CRM_AUTO_CREATE строкой "Y"/"N", а crmAutoCreate молча отбрасывался — с 07.2026 канонично camelCase boolean (сырой UPPER-вариант ещё принимается на запись для совместимости).

data.id — внутренний идентификатор, не используется для других операций. Обновление и удаление линии выполняются по number из тела запроса, а не по data.id из ответа. Сохраните переданное number — именно оно подставляется в URL PATCH /v1/telephony-lines/:number и DELETE /v1/telephony-lines/:number. Значения с +, пробелами или / допустимы — при подстановке в URL их нужно кодировать: +79161234567 → %2B79161234567.

#Смотрите также

• Список линий приложения — GET /v1/telephony-lines
• Обновить линию — PATCH /v1/telephony-lines/:number
• Удалить линию — DELETE /v1/telephony-lines/:number
• Исходящие звонки — использование number как fromLine

#Список линий приложения

GET /v1/telephony-lines

Возвращает список внешних линий, добавленных приложением через POST /v1/telephony-lines. Список возвращается целиком — фильтрация, сортировка и offset не поддерживаются, нужную линию отбирайте на стороне клиента.

#Параметры

#Примеры

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

curl "https://vibecode.bitrix24.tech/v1/telephony-lines" \
  -H "X-Api-Key: YOUR_API_KEY"

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

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

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

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

const { success, data, meta } = await res.json()
console.log(`Найдено ${meta.total} линий`)

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

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

const { success, data, meta } = await res.json()

#Поля ответа

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

HTTP 200, пустая выборка:

{"success":true,"data":[],"meta":{"total":0,"hasMore":false}}

HTTP 200, одна линия:

{
  "success": true,
  "data": [
    {
      "number": "doc-test-line-001",
      "name": "Тестовая линия (аудит)",
      "crmAutoCreate": true
    }
  ],
  "meta": {
    "total": 1,
    "hasMore": false
  }
}

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

403 — нет скоупа:

{
  "success": false,
  "error": {
    "code": "SCOPE_DENIED",
    "message": "This endpoint requires 'telephony' scope"
  }
}

#Ошибки

Полный список общих ошибок API — Ошибки.

#Известные особенности

Только линии этого приложения. Список содержит линии, созданные через POST /v1/telephony-lines в рамках текущего API-ключа. Линии, арендованные у Voximplant или подключённые по SIP, доступны через `GET /v1/voximplant-lines`.

Фильтрация, сортировка и offset не работают. Параметры filter, order, offset принимаются без ошибки, но игнорируются — возвращается весь список линий. Работают только limit (ограничивает количество) и select (выбор полей в camelCase). Отбор по номеру или имени делайте на стороне клиента.

Все поля ответа — в camelCase, включая crmAutoCreate (boolean). Ранее это поле приходило в UPPER_SNAKE_CASE строкой "Y"/"N" — с 07.2026 оно нормализовано в camelCase boolean, как и остальные поля.

serverName не возвращается. Поле объявлено в GET /v1/telephony-lines/fields, но в списке не приходит ни при каких условиях — даже если задавалось при создании (детали).

#Смотрите также

• Добавить линию — POST /v1/telephony-lines
• Обновить линию — PATCH /v1/telephony-lines/:number
• Удалить линию — DELETE /v1/telephony-lines/:number
• Линии Voximplant — GET /v1/voximplant-lines
• Синтаксис фильтрации
• Исходящие звонки — линии используются как fromLine