name: zoom-team-chat
description: |
Zoom Team Chat API integration guide. Covers sending messages to users and channels,
creating and managing channels, sharing files, and building chat integrations.
Use when building notification systems, chatbots, workflow automation, or integrating
external tools with Zoom's messaging platform.

Zoom Team Chat API

Build messaging integrations with Zoom Team Chat. Send messages, manage channels, and automate team communication.

Overview

Zoom Team Chat (formerly Zoom Chat) is Zoom's messaging platform. The API allows you to:
- Send messages to users and channels
- Create and manage channels
- Share files and attachments
- Manage contact lists
- Build chat integrations and bots
- Receive real-time events via webhooks

Key Features

Choose Your Integration

Core Endpoints

Messages

Channels

Contacts

Common Operations

Send Message to User

const response = await fetch(
  'https://api.zoom.us/v2/chat/users/me/messages',
  {
    method: 'POST',
    headers: {
      'Authorization': `Bearer ${accessToken}`,
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      to_jid: '[email protected]',  // Recipient JID
      message: 'Hello from the API!'
    })
  }
);

const result = await response.json();
// { "id": "msg_123", "date_time": "2024-01-15T10:30:00Z" }

Send Message to Channel

const response = await fetch(
  'https://api.zoom.us/v2/chat/users/me/messages',
  {
    method: 'POST',
    headers: {
      'Authorization': `Bearer ${accessToken}`,
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      to_channel: 'channel_id_123',
      message: 'Team announcement!'
    })
  }
);

Send Rich Message with Formatting

const response = await fetch(
  'https://api.zoom.us/v2/chat/users/me/messages',
  {
    method: 'POST',
    headers: {
      'Authorization': `Bearer ${accessToken}`,
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      to_channel: 'channel_id_123',
      message: 'New deployment completed!',
      rich_text: [
        {
          start_position: 0,
          end_position: 3,
          format_type: 'Bold'
        }
      ],
      at_items: [
        {
          at_type: 1,  // 1 = @mention user
          at_contact: '[email protected]',
          start_position: 25,
          end_position: 30
        }
      ]
    })
  }
);

Create Channel

const response = await fetch(
  'https://api.zoom.us/v2/chat/users/me/channels',
  {
    method: 'POST',
    headers: {
      'Authorization': `Bearer ${accessToken}`,
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      name: 'Project Alpha',
      type: 1,  // 1 = private, 2 = public
      members: [
        { email: '[email protected]' },
        { email: '[email protected]' }
      ]
    })
  }
);

const channel = await response.json();
// { "id": "channel_123", "jid": "[email protected]", "name": "Project Alpha" }

List Messages in Channel

const params = new URLSearchParams({
  to_channel: 'channel_id_123',
  from: '2024-01-01T00:00:00Z',
  to: '2024-01-31T23:59:59Z',
  page_size: 50
});

const response = await fetch(
  `https://api.zoom.us/v2/chat/users/me/messages?${params}`,
  {
    headers: { 'Authorization': `Bearer ${accessToken}` }
  }
);

const messages = await response.json();
// { "messages": [...], "next_page_token": "..." }

Share File

const formData = new FormData();
formData.append('to_channel', 'channel_id_123');
formData.append('files', fileBlob, 'document.pdf');

const response = await fetch(
  'https://api.zoom.us/v2/chat/users/me/messages/files',
  {
    method: 'POST',
    headers: {
      'Authorization': `Bearer ${accessToken}`
    },
    body: formData
  }
);

Add Members to Channel

const response = await fetch(
  'https://api.zoom.us/v2/chat/channels/channel_id_123/members',
  {
    method: 'POST',
    headers: {
      'Authorization': `Bearer ${accessToken}`,
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      members: [
        { email: '[email protected]' }
      ]
    })
  }
);

Message Types

Channel Types

Webhooks

Team Chat events via webhooks:

Webhook Payload Example

{
  "event": "chat_message.sent",
  "payload": {
    "account_id": "abc123",
    "object": {
      "id": "msg_xyz",
      "type": "to_channel",
      "channel_id": "channel_123",
      "sender": "[email protected]",
      "message": "Hello team!",
      "date_time": "2024-01-15T10:30:00Z"
    }
  }
}

Required Scopes

Limitations

Common Use Cases

Prerequisites

1. Zoom account - Team Chat enabled
2. OAuth app - Create in Zoom App Marketplace
3. Scopes - Request required Team Chat scopes
4. Access token - OAuth 2.0 bearer token

Detailed References

• references/messages.md - Message API guide
• references/channels.md - Channel management
• references/webhooks.md - Webhook setup
• references/scopes.md - Required OAuth scopes

Resources

• Official docs: https://developers.zoom.us/docs/team-chat/
• API Reference: https://developers.zoom.us/docs/api/rest/reference/team-chat/methods/
• Chatbots: https://developers.zoom.us/docs/team-chat/chatbots/
• Webhooks: https://developers.zoom.us/docs/api/webhooks/
• Marketplace: https://marketplace.zoom.us/