sendInfo

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>);

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

Promise<void>

An error if there is no active session to send the info message on, or if the session is not established.

await client.sendInfo('Hello', { key: 'value' });

await client.sendInfo('custom-action', {
  action: 'update',
  payload: { key: 'score', value: 42 }
});

Last modified on April 21, 2026