ChatterBox Client

The ChatterBox Client is an easy-to-use JavaScript/TypeScript package that allows you to integrate your applications with popular video conferencing platforms like Zoom. With this package, you can deploy bots to meetings, retrieve real-time meeting events, and access live transcripts with just a few lines of code.

Features

• Send Bots to Meetings: Easily deploy a bot to your video conferencing meetings (e.g., Zoom).
• Real-Time Transcription: Receive live transcripts of ongoing meetings.
• WebSocket Integration: Get real-time meeting events such as meeting start, finish, and transcript updates.
• Customizable: Set your own bot names and optionally customize API and WebSocket base URLs.

Installation

You can install the ChatterBox Client via npm:

npm install @chatterboxio/bot

Usage

Basic Example

To use the ChatterBox client, initialize it with your authorization token and deploy a bot to a meeting:

const { ChatterBox } = require('@chatterboxio/bot');

const client = ChatterBox({
  authorizationToken: 'YOUR_ACCESS_TOKEN',
});

async function startBot() {
  try {
    const { id } = await client.sendBot({
      platform: 'zoom',
      meeting_id: '1234567890',
      meeting_password: 'your-meeting-password',
      bot_name: 'MyCustomBot', // Optional bot name
    });

    console.log('Bot started, session ID:', id);

    // Connecting to the WebSocket for real-time events
    const socket = client.connectSocket(id, {
      onMeetingStarted: (data) => console.log('Meeting started:', data),
      onMeetingFinished: (data) => console.log('Meeting finished:', data),
      onTranscriptReceived: (data) => console.log('Transcript:', data),
    });

    // Close the socket when the process exits
    process.on('exit', () => socket.close());

  } catch (error) {
    console.error('Error:', error.message);
  }
}

startBot();

Parameters for sendBot

• platform: The platform to send the bot to (e.g., 'zoom').
• meeting_id: The ID of the meeting.
• meeting_password: (Optional) The meeting password.
• bot_name: (Optional) Customize the name of the bot. Default is 'ChatterBox'.

WebSocket Event Callbacks

• onMeetingStarted: Triggered when the meeting starts.
• onMeetingFinished: Triggered when the meeting ends.
• onTranscriptReceived: Triggered when a transcript update is received.

Getting Your Access Token

To use the ChatterBox client, you need an access token. You can request your access token by signing up at our website: https://chatter-box.io/.

Once you have your token, you can use it to initialize the ChatterBox client as shown in the examples above.

License

This project is licensed under the MIT License - see the LICENSE.md file for details.