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

GET /v1/telephony-lines

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

#Параметры

Параметр Тип По умолч. Описание
filter (query) object — Фильтрация по полям. Имена полей в UPPER_SNAKE_CASE: NUMBER, NAME, SERVER_NAME, CRM_AUTO_CREATE. Синтаксис фильтрации. Пример: ?filter[NUMBER]=sip-line-1
select (query) string — Выборка полей: ?select=number,name
order (query) object — Сортировка: ?order[NUMBER]=asc
limit (query) number 50 Количество записей (до 500)
offset (query) number 0 Смещение для пагинации

#Примеры

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

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

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

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

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

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-приложение

javascript 
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()

#Поля ответа

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

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

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

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

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

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

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

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

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

#Ошибки

HTTP Код Описание
401 MISSING_API_KEY Не передан заголовок X-Api-Key
401 INVALID_API_KEY Неверный API-ключ
401 TOKEN_MISSING Ключ не имеет настроенных токенов
401 KEY_INACTIVE API-ключ неактивен или отозван
403 SCOPE_DENIED Ключу не хватает скоупа telephony
429 RATE_LIMITED Превышен лимит запросов
502 BITRIX_UNAVAILABLE Битрикс24 недоступен

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

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

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

Поле CRM_AUTO_CREATE в UPPER_SNAKE_CASE. Остальные поля ответа — в camelCase.

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