# Zoom meeting

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

## Create a meeting

`POST /v1/chats/:dialogId/zoom`

The v2 messenger method `im.v2.Call.Zoom.create`.

## Parameters

| Parameter | Type | Required | Description |
|----------|-----|:-----:|----------|
| `dialogId` (path) | string | yes | Dialog ID: `chat123` for a group chat, a user ID for a private chat, `me` for the chat with yourself |

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

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

### curl — OAuth application

```bash
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 |
|------|-----|---------|
| `success` | boolean | Always `true` on success |
| `data.link` | string | Link to join the meeting — the same one as in the invitation |
| `data.messageId` | number | ID 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 |
|------|-----|---------|
| 400 | `INVALID_PARAMS` | A body field or query parameter was passed — the operation accepts none |
| 401 | `TOKEN_MISSING` | The API key has no Bitrix24 tokens configured |
| 403 | `SCOPE_DENIED` | The API key does not have the `im` scope |
| 403 | `WRITE_BLOCKED_READONLY_KEY` | The key is read-only |
| 403 | `BITRIX_ACCESS_DENIED` | No permission to write to the chat |
| 404 | `ENTITY_NOT_FOUND` | Bitrix24 returned "not found"; the portal code is in `error.b24Code` |
| 422 | `BITRIX_ERROR` | Bitrix24 returned an error; the portal 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, `ZOOM_CREATE_ERROR` — Zoom did not create the meeting |
| 502 | `ME_ALIAS_RESOLUTION_FAILED` | Failed to resolve the current user for `me` |
| 502 | `BITRIX_UNAVAILABLE` | Bitrix24 is unavailable or returned a server error |

The full list of common API errors — [Errors](/docs/errors).

## Known specifics

- The meeting is created in the caller's Zoom account. The response carries only the participant link: it has neither the host link nor the Zoom token.
- The invitation is sent to the chat on behalf of the caller.

## See also

- [Send a message](/docs/chats/messages/send)
- [Service methods](/docs/chats/service)