Sub codes are a field (sub_code) added to certain bot status change events to provide extra context.

Here's an example of a status change object structure:

{
  "code": "call_ended",
  "sub_code": "bot_kicked_from_call", // machine readable
  "message": "The bot was kicked from the call.", // human readable description of the sub_code
  "created_at": "2023-04-28T08:51:37.741790Z"
}

Here, we can interpret this status change as follows:

• Code: call_ended - The status change event category (Call Ended)
• Sub Code: bot_kicked_from_call - The underlying reason for the status change (sub code

Sub Code Types

Currently there are 3 distinct sub code categories:

• Call Ended Sub Codes
• Fatal Sub Codes
• Recording Permission Denied (Zoom only)

Note: Platform specific sub_codeis prefixed with platform name (e.g zoom_sdk_credentials_missing)

🚧

We may add additional sub_codes

You should not treat the sub_code as an enum, as we may add values in the future without prior notice. We will never remove values without notifying all our customers and a long depreciation period, as we consider removing values a breaking change.

Recording Permission Denied Sub Codes

Since Zoom bots have a few extra requirements to meet for recording, there are more places that bots can run into trouble.

When a bot fails to record in a Zoom call, the recording_permission_denied webhook event will include a Zoom-specific sub code that provides more context into the reason it failed.

These sub_code will be added to the recording_permission_denied event.

Call Ended Sub Codes

The call_ended event signifies that a bot left, or was removed from, the call.

Recall attaches a sub_code to these events to expose the underlying reason why the bot is no longer in the call. This can be for obvious reasons such as the host ending the call (call_ended_by_host), but sometimes its less obvious why a bot left a call.

Below is a list of all call ended sub codes and what they mean.

Fatal Sub Codes

When a bot hits a fatal error, a fatal event is emitted with an attached sub_code that provides more context. Below is a list of possible fatal sub codes, their meaning, and any recommended action to take, if any.