Показать карточку звонка

POST /v1/calls/:callId/show

Отображает карточку активного звонка поверх открытых окон Битрикс24 у указанного пользователя. Вызывайте после POST /v1/calls/register, пока звонок не завершён.

Параметры

Параметр В Тип Обяз. Описание
callId path string да CALL_ID из ответа POST /v1/calls/register

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

Параметр Тип Обяз. По умолч. Описание
userId number да — ID пользователя Битрикс24, которому показывается карточка. Положительное целое число, принимается также числовая строка "42". Список пользователей

Примеры

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

Terminal 
curl -X POST https://vibecode.bitrix24.tech/v1/calls/CALL_ID/show \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"userId": 1}'

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

Terminal 
curl -X POST https://vibecode.bitrix24.tech/v1/calls/CALL_ID/show \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"userId": 1}'

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

javascript 
const callId = 'externalCall.00b1e735843c558431be668e3687a58b.1777974304'

const res = await fetch(`https://vibecode.bitrix24.tech/v1/calls/${callId}/show`, {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ userId: 1 }),
})

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

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

javascript 
const callId = 'externalCall.00b1e735843c558431be668e3687a58b.1777974304'

const res = await fetch(`https://vibecode.bitrix24.tech/v1/calls/${callId}/show`, {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ userId: 1 }),
})

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

Поля ответа

Поле Тип Описание
data boolean true — карточка показана успешно, false — карточка не показана: звонок не найден или уже завершён

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

JSON 
{
  "success": true,
  "data": true
}

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

400 — не передан обязательный параметр:

JSON 
{
  "success": false,
  "error": {
    "code": "MISSING_PARAMS",
    "message": "Required: userId (positive integer)"
  }
}

Ошибки

HTTP Код Описание
400 MISSING_PARAMS userId не передан или не распознан как положительное целое число
401 MISSING_API_KEY Не передан заголовок X-Api-Key
401 INVALID_API_KEY Неверный API-ключ
401 TOKEN_MISSING Ключ не имеет настроенных токенов Битрикс24
401 KEY_INACTIVE API-ключ неактивен или отозван
403 SCOPE_DENIED Ключу не хватает скоупа telephony
422 BITRIX_ERROR Битрикс24 вернул ошибку (текст в error.message)
429 RATE_LIMITED Превышен лимит запросов
502 BITRIX_UNAVAILABLE Битрикс24 недоступен

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

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

Признак успеха — поле data, не HTTP-статус. При несуществующем или уже завершённом callId Битрикс24 возвращает HTTP 200 с data: false. Проверяйте значение поля, а не код ответа.

userId не обязан совпадать с тем, кто регистрировал звонок. Карточку можно показать любому пользователю портала — например, супервизору или замещающему оператору.

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