aiMessage

Send a message to an active AI session on a call. This injects instructions or context into the AI agent’s conversation without the caller hearing the message directly.

Request

idstringRequiredformat: "uuid"

The unique identifying ID of a existing call.

paramsobjectRequired

An object of parameters that will be utilized by the active command.

Response

Call LegobjectRequired

Returned when the call is a standard PSTN, SIP, or WebRTC call.

Fabric Subscriber Device LegobjectRequired

Returned when the call is a Fabric subscriber device leg. The status field is always null for this type.

Example

1 import { RestClient } from "@signalwire/sdk";
2 
3 const client = new RestClient({
4   project: "your-project-id",
5   token: "your-api-token",
6   host: "your-space.signalwire.com"
7 });
8 
9 // Inject a system instruction into the AI session
10 await client.calling.aiMessage("call-id-xxx", {
11   message_text: "The caller's account has been verified. You can proceed with the transfer.",
12   role: "system",
13 });