REST ClientCalling

ai_message

View as MarkdownOpen in Claude

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.
OR
Fabric Subscriber Device LegobjectRequired

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

Example

1from signalwire.rest import RestClient
2
3client = 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
10client.calling.ai_message(
11    call_id="call-id-xxx",
12    message_text="The caller's account has been verified. You can proceed with the transfer.",
13    role="system",
14)