For AI agents: markdown of this page — /docs-content-en/chats/service/zoom.md documentation index — /llms.txt

Zoom meeting

POST /v1/chats/:dialogId/zoom

Creates a meeting in the caller's Zoom account and, on the caller's behalf, sends an invitation message with the join link to the chat. The caller needs a Zoom account connected to Bitrix24.

Parameters

Parameter Type Required Description
ParameterdialogId (path) Typestring Requiredyes DescriptionDialog ID: chat123 for a group chat, a user ID for a private chat, me for the chat with yourself. chat123 is the id field of a recent dialogs row, a user ID comes from the user list

The operation accepts no body and no query parameters: any body field or query parameter is rejected with 400 INVALID_PARAMS.

Examples

curl — personal key

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

curl — OAuth application

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

JavaScript — personal key

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

const { data } = await res.json()
console.log('Join link:', data.link, 'invitation:', data.messageId)

JavaScript — OAuth application

javascript 
const res = await fetch('https://vibecode.bitrix24.com/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('Join link:', data.link)

Response fields

Field Type Description
Fieldsuccess Typeboolean DescriptionAlways true on success
Fielddata Typeobject DescriptionThe created meeting
Fielddata.link Typestring DescriptionLink to join the meeting — the same one as in the invitation
Fielddata.messageId Typenumber DescriptionID of the invitation message in the chat

Response example

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

Error response example

422 — the Zoom integration is turned off in Bitrix24:

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

Errors

HTTP Code Description
HTTP400 CodeINVALID_PARAMS DescriptionA body field or query parameter was passed — the operation accepts none
HTTP401 CodeTOKEN_MISSING DescriptionThe API key has no Bitrix24 tokens configured
HTTP403 CodeSCOPE_DENIED DescriptionThe API key does not have the im scope
HTTP403 CodeWRITE_BLOCKED_READONLY_KEY DescriptionThe key is read-only
HTTP403 CodeBITRIX_ACCESS_DENIED DescriptionNo permission to write to the chat
HTTP404 CodeENTITY_NOT_FOUND DescriptionBitrix24 returned "not found". The Bitrix24 code is in error.b24Code
HTTP422 CodeBITRIX_ERROR DescriptionBitrix24 returned an error. The Bitrix24 code is in error.b24Code. ZOOM_ACTIVE_ERROR — the Zoom integration is turned off, ZOOM_AVAILABLE_ERROR — Zoom is not available on the current Bitrix24 plan, ZOOM_CONNECTED_ERROR — the caller has not connected a Zoom account
HTTP502 CodeME_ALIAS_RESOLUTION_FAILED DescriptionFailed to resolve the current user for me
HTTP502 CodeBITRIX_UNAVAILABLE DescriptionBitrix24 is unavailable or returned a server error

The full list of common API errors — Errors.

Known specifics

  • The response carries only the participant link: it has neither the host link nor the Zoom token.

See also