REST ClientCalling

ai_hold

View as MarkdownOpen in Claude

Put an active AI session on hold. The AI agent stops processing speech while the call remains connected. This is useful for transferring the caller to a human agent or performing background operations.

Request

idstringRequiredformat: "uuid"
The unique identifying ID of an 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

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
9client.calling.ai_hold(call_id="call-id-xxx")