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

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

POST /v1/telephony-lines/search

Возвращает внешние линии, добавленные приложением, по телу запроса, а не по строке запроса. Коллекция линий приходит целиком одной страницей.

Тот же набор линий отдаёт GET /v1/telephony-lines.

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

Поле Тип Обяз. По умолч. Описание
limit number нет 50 Количество записей, до 5000
select string[] нет — Выборка полей в camelCase: ["number", "name"]

Примеры

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

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/telephony-lines/search" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "limit": 3 }'

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

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/telephony-lines/search" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "limit": 3 }'

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/telephony-lines/search', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ limit: 3 }),
})

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

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/telephony-lines/search', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ limit: 3 }),
})

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

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data array Массив линий приложения
data[].number string Идентификатор линии, заданный при создании
data[].name string | null Отображаемое название. null, если не задано при создании
data[].crmAutoCreate boolean Автосоздание CRM-сущности при исходящем звонке через эту линию: true — создавать, false — не создавать
meta.total number Количество линий приложения
meta.hasMore boolean Есть ли ещё записи за пределами limit
meta.durationMs number Длительность запроса в миллисекундах

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

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

Массив data пуст, когда приложение ещё не добавляло внешних линий через POST /v1/telephony-lines. Ответ с непустой выборкой показан в Списке линий приложения — состав записи там тот же.

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

400 — передано ненулевое смещение:

JSON 
{
  "success": false,
  "error": {
    "code": "UNSUPPORTED_OFFSET",
    "message": "Entity 'telephony-lines' does not support offset — B24 method \"telephony.externalLine.get\" has no pagination and returns the full collection in one page. Remove offset and window the result on your side; limit still applies."
  }
}

Ошибки

HTTP Код Описание
400 UNSUPPORTED_OFFSET Передано ненулевое смещение offset — постраничного обхода у линий приложения нет
400 UNSUPPORTED_FILTER Передан filter — отбор по полям линии не поддерживается
400 INVALID_SORT_FIELD Передан sort или order — сортировка не поддерживается
401 MISSING_API_KEY Не передан заголовок X-Api-Key
401 INVALID_API_KEY Ключ не опознан: такой строки на платформе нет
401 TOKEN_MISSING У API-ключа нет настроенных токенов
401 KEY_INACTIVE API-ключ неактивен или отозван
403 SCOPE_DENIED API-ключ не имеет скоупа telephony
429 RATE_LIMITED Превышен лимит запросов
502 BITRIX_UNAVAILABLE Битрикс24 временно недоступен — повторите запрос позже

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

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

Переход на POST не добавляет условий отбора. Тело этого запроса принимает тот же минимум, что и строка запроса у списка. Нужную линию ищите в полученном массиве по number на своей стороне.

Ключ записи — number, поля id у линии нет. Даже если number не назван в select, он остаётся в каждой записи ответа: без него запись не отличить от соседней и не адресовать в PATCH /v1/telephony-lines/:number.

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