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

Конференция Zoom

POST /v1/chats/:dialogId/zoom

Создаёт конференцию в аккаунте Zoom вызывающего и от его имени отправляет в чат сообщение-приглашение со ссылкой для входа. Нужен подключённый к Битрикс24 аккаунт Zoom вызывающего.

Параметры

Параметр Тип Обяз. Описание
dialogId (path) string да ID диалога: chat123 для группового чата, ID пользователя для личного, me — чат с самим собой. chat123 — поле id строки последних диалогов, ID пользователя — из списка пользователей

Тела и параметров запроса нет: любое поле тела или параметр отклоняется с 400 INVALID_PARAMS.

Примеры

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

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/chats/chat42/zoom" \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/chats/chat42/zoom" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/chats/chat42/zoom', {
  method: 'POST',
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})

const { data } = await res.json()
console.log('Ссылка для входа:', data.link, 'приглашение:', data.messageId)

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/chats/chat42/zoom', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

const { data } = await res.json()
console.log('Ссылка для входа:', data.link)

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data object Данные созданной конференции
data.link string Ссылка для входа в конференцию — та же, что в приглашении
data.messageId number ID сообщения-приглашения в чате

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

JSON 
{
  "success": true,
  "data": {
    "link": "https://us05web.zoom.us/j/81234567890?pwd=abc",
    "messageId": 1003
  }
}

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

422 — интеграция с Zoom выключена в Битрикс24:

JSON 
{
  "success": false,
  "error": {
    "code": "BITRIX_ERROR",
    "message": "ZOOM_ACTIVE_ERROR",
    "b24Code": "ZOOM_ACTIVE_ERROR"
  }
}

Ошибки

HTTP Код Описание
400 INVALID_PARAMS Передано поле тела или параметр запроса — операция их не принимает
401 TOKEN_MISSING API-ключ не имеет настроенных токенов Битрикс24
403 SCOPE_DENIED API-ключ не имеет скоупа im
403 WRITE_BLOCKED_READONLY_KEY Ключ работает только на чтение
403 BITRIX_ACCESS_DENIED Нет права писать в чат
404 ENTITY_NOT_FOUND Битрикс24 вернул «не найдено», код портала — в error.b24Code
422 BITRIX_ERROR Битрикс24 вернул ошибку, код портала — в error.b24Code. ZOOM_ACTIVE_ERROR — интеграция с Zoom выключена, ZOOM_AVAILABLE_ERROR — Zoom недоступен на тарифе, ZOOM_CONNECTED_ERROR — вызывающий не подключил аккаунт Zoom
502 ME_ALIAS_RESOLUTION_FAILED Не удалось определить текущего пользователя для me
502 BITRIX_UNAVAILABLE Битрикс24 недоступен или вернул ошибку сервера

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

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

  • В ответе — только ссылка для участников: ссылки организатора и токена Zoom в нём нет.

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