Skip to main content
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

ParameterTypeDescriptionRequired
textstringThe text content of the info messageYes
dataRecord<string, any>Optional key-value data to include with the messageNo

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

More Information

  • infoSent event — fires when the message is sent
  • infoReceived event — fires when a message is received from the remote party