conversation.connected.connection_limit_exceeded

Maximum concurrent connections exceeded error

Triggered when the maximum number of concurrent connections is exceeded during connection setup or during an active session. Handle this event to inform users about the connection limit and suggest closing other active connections.

Event Properties

type · string

Event type. Always "conversation.connected.connection_limit_exceeded" for this event.

data · object

Event data object. May be empty or contain additional metadata.

message · string

Error message describing the connection limit.

Example: "Maximum concurrent connections (5) exceeded. Please close other connections and try again."

Example

{
  "type": "conversation.connected.connection_limit_exceeded",
  "data": {},
  "message": "Maximum concurrent connections (5) exceeded. Please close other connections and try again."
}

Usage Example

const NavTalkMessageType = Object.freeze({
    CONNECTED_CONNECTION_LIMIT_EXCEEDED: "conversation.connected.connection_limit_exceeded",
    // ... other event types
});

async function handleReceivedMessage(data) {
    switch (data.type) {
        case NavTalkMessageType.CONNECTED_CONNECTION_LIMIT_EXCEEDED:
            const errorMessage = data.message || "Connection limit exceeded";
            showError(errorMessage);
            // Suggest closing other connections
            stopRecording();
            break;
    }
}

When this event is received, the connection limit has been exceeded. You should inform the user and suggest closing other active connections before retrying.