Sends an info message during an active call. Info messages can carry text and optional structured data.
Signature
await client.sendInfo(text: string, data?: Record<string, any>);
Parameters
| Parameter | Type | Description | Required |
|---|
text | string | The text content of the info message. | Yes |
data | Record<string, any> | Optional key-value data to include with the message. | No |
Returns
Promise<void>
Throws
An error if there is no active session to send the info message on, or if the session is not established.
Example
await client.sendInfo('Hello', { key: 'value' });
Sending Structured Data
await client.sendInfo('custom-action', {
action: 'update',
payload: { key: 'score', value: 42 }
});
Last modified on June 2, 2026
