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

Статусы участников

GET /v1/call-lists/statuses

Возвращает справочник статусов участников обзвона, по которому код статуса участника переводят в название для показа человеку.

Примеры

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/call-lists/statuses" \
  -H "X-Api-Key: YOUR_API_KEY"

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

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

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

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

const { success, data } = await res.json()
const statusNames = Object.fromEntries(data.map((s) => [s.statusId, s.name]))
console.log(statusNames.IN_WORK)

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

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

const { success, data } = await res.json()
const statusNames = Object.fromEntries(data.map((s) => [s.statusId, s.name]))

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data array Статусы участников
data[].id number Служебный номер записи справочника. С участником не сопоставляется — для этого служит statusId
data[].statusId string Код статуса: IN_WORK, SUCCESS, WRONG_NUMBER, STOP_CALLING. Совпадает с полем status участника из GET /v1/call-lists/:id/items
data[].name string Название статуса для показа человеку, например «В работе». Для сопоставления с участником не используйте
data[].sort number Порядок статуса в списке, по возрастанию

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

JSON 
{
  "success": true,
  "data": [
    {
      "id": 61,
      "name": "В работе",
      "sort": 10,
      "statusId": "IN_WORK"
    },
    {
      "id": 63,
      "name": "Успешно",
      "sort": 20,
      "statusId": "SUCCESS"
    },
    {
      "id": 65,
      "name": "Неверный номер",
      "sort": 30,
      "statusId": "WRONG_NUMBER"
    },
    {
      "id": 67,
      "name": "Больше не звонить",
      "sort": 40,
      "statusId": "STOP_CALLING"
    }
  ]
}

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

400 — передан параметр запроса, а метод их не принимает:

JSON 
{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "This operation has no query parameters"
  }
}

Ошибки

HTTP Код Описание
400 INVALID_PARAMS Передан параметр в строке запроса. Метод не принимает ни одного
422 BITRIX_ERROR Битрикс24 отклонил запрос. Текст причины — в message
502 BITRIX_RESPONSE_INVALID Битрикс24 вернул ответ, который не удалось разобрать
403 SCOPE_DENIED Ключу не хватает скоупа crm
401 TOKEN_MISSING У ключа нет настроенных токенов Битрикс24
401 MISSING_API_KEY Не передан заголовок X-Api-Key

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

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

Справочник общий для всех списков обзвона портала. Один вызов даёт названия статусов для участников любого списка.

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