conversation.connected.insufficient_balance

Insufficient account balance error

Triggered when the account balance is insufficient to establish or continue the connection. This event is sent during connection setup or during an active session when balance runs out.

Event Properties

type · string

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

data · object

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

message · string

Optional message describing the insufficient balance error.

Example: "Insufficient balance to continue service"

Example

{
  "type": "conversation.connected.insufficient_balance",
  "data": {},
  "message": "Insufficient balance to continue service"
}

Usage Example

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

async function handleReceivedMessage(data) {
    switch (data.type) {
        case NavTalkMessageType.INSUFFICIENT_BALANCE:
            const errorMessage = data.message || "Insufficient balance";
            showError(errorMessage);
            // Stop service and prompt user to recharge
            stopRecording();
            showRechargePrompt();
            break;
    }
}

When this event is received, the service will stop. You should inform the user and provide a clear path to recharge their account.