Для 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"]
Полеfilter Типobject Обяз.нет По умолч.— ОписаниеПринимается только пустой объект {}: отбор по полям линии не поддерживается, любой ключ внутри возвращает 400 UNSUPPORTED_FILTER
ПолеwithTotal Типboolean Обяз.нет По умолч.— ОписаниеДля линий приложения на ответ не влияет: meta.total приходит и при withTotal: false

Примеры

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 ОписаниеМассив линий приложения. Пустой, пока приложение не добавило ни одной линии через POST /v1/telephony-lines
Поле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": [
    {
      "number": "sip-line-1",
      "name": "Основная линия",
      "crmAutoCreate": true
    },
    {
      "number": "sip-line-2",
      "name": "Линия поддержки",
      "crmAutoCreate": false
    }
  ],
  "meta": {
    "total": 2,
    "hasMore": false,
    "durationMs": 62
  }
}

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

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 Код Описание
HTTP400 КодUNSUPPORTED_OFFSET ОписаниеПередано ненулевое смещение offset — постраничного обхода у линий приложения нет
HTTP400 КодUNSUPPORTED_FILTER ОписаниеПередан filter — отбор по полям линии не поддерживается
HTTP400 КодINVALID_SORT_FIELD ОписаниеПередан sort или order — сортировка не поддерживается
HTTP401 КодMISSING_API_KEY ОписаниеНе передан заголовок X-Api-Key
HTTP401 КодINVALID_API_KEY ОписаниеКлюч не опознан: такой строки на платформе нет
HTTP401 КодTOKEN_MISSING ОписаниеУ API-ключа нет настроенных токенов
HTTP401 КодKEY_INACTIVE ОписаниеAPI-ключ неактивен или отозван
HTTP403 КодSCOPE_DENIED ОписаниеAPI-ключ не имеет скоупа telephony
HTTP429 КодRATE_LIMITED ОписаниеПревышен лимит запросов
HTTP502 КодBITRIX_UNAVAILABLE ОписаниеБитрикс24 временно недоступен — повторите запрос позже

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

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

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

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

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