Getting Meeting Data

Your webhook URL will receive two types of data:

1. Live meeting events during the meeting
2. Final meeting data after completion

These events will start flowing in after sending a bot to a meeting.

1. Live Meeting Events

POST /your-endpoint
x-meeting-baas-api-key: YOUR-API-KEY
 
{
  "event": "bot.status_change",
  "data": {
    "bot_id": "123e4567-e89b-12d3-a456-426614174000",
    "status": {
      "code": "joining_call",
      "created_at": "2024-01-01T12:00:00.000Z"
    }
  }
}

Status Event Fields

• event: The key-value pair for bot status events. Always bot.status_change.
• data.bot_id: The identifier of the bot.
• data.status.code: The code of the event. One of:
  • joining_call: The bot has acknowledged the request to join the call.
  • in_waiting_room: The bot is in the "waiting room" of the meeting.
  • in_call_not_recording: The bot has joined the meeting, however it is not recording yet.
  • in_call_recording: The bot is in the meeting and recording the audio and video.
  • recording_paused: The recording has been temporarily paused.
  • recording_resumed: The recording has resumed after being paused.
  • call_ended: The bot has left the call.
  • bot_rejected: The bot was rejected from joining the meeting.
  • bot_removed: The bot was removed from the meeting.
  • waiting_room_timeout: The bot timed out while waiting to be admitted.
  • invalid_meeting_url: The provided meeting URL was invalid.
  • meeting_error: An unexpected error occurred during the meeting.
• data.status.created_at: An ISO string of the datetime of the event.

When receiving an in_call_recording event, additional data is provided:

• data.status.start_time: The timestamp when the recording started.

For meeting_error events, additional error details are provided:

• data.status.error_message: A description of the error that occurred.
• data.status.error_type: The type of error encountered.

2. Final Meeting Data

You'll receive either a complete or failed event.

Success Response (complete)

POST /your-endpoint
x-meeting-baas-api-key: YOUR-API-KEY
 
{
  "event": "complete",
  "data": {
    "bot_id": "123e4567-e89b-12d3-a456-426614174000",
    "mp4": "https://bots-videos.s3.eu-west-3.amazonaws.com/path/to/video.mp4?X-Amz-Signature=...",
    "speakers": ["Alice", "Bob"],
    "transcript": [{
      "speaker": "Alice",
      "words": [{
        "start": 1.3348110430839002,
        "end": 1.4549110430839003,
        "word": "Hi"
      }, {
        "start": 1.4549110430839003,
        "end": 1.5750110430839004,
        "word": "Bob!"
      }]
    }, {
      "speaker": "Bob",
      "words": [{
        "start": 2.6583010430839,
        "end": 2.778401043083901,
        "word": "Hello"
      }, {
        "start": 2.778401043083901,
        "end": 2.9185110430839005,
        "word": "Alice!"
      }]
    }]
  }
}

Complete Response Fields

• bot_id: The identifier of the bot.
• mp4: A private AWS S3 URL of the mp4 recording of the meeting. Valid for two hours only.
• speakers: The list of speakers in this meeting. Currently requires transcription to be enabled.
• transcript (optional): The meeting transcript. Only given when speech_to_text is set when asking for a bot. An array containing:
  • transcript.speaker: The speaker name.
  • transcript.words: The list of words, each containing:
    • transcript.words.start: The start time of the word
    • transcript.words.end: The end time of the word
    • transcript.words.word: The word itself

Failure Response (failed)

POST /your-endpoint
x-meeting-baas-api-key: YOUR-API-KEY
 
{
  "event": "failed",
  "data": {
    "bot_id": "123e4567-e89b-12d3-a456-426614174000",
    "error": "CannotJoinMeeting"
  }
}

Error Types

Recording End Reasons