ai_stop | SignalWire

Stop an active AI session on a call. The AI agent is disconnected but the call itself remains active, allowing further call control operations.

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 from signalwire.rest import RestClient
2 
3 client = RestClient(
4     project="your-project-id",
5     token="your-api-token",
6     host="your-space.signalwire.com",
7 )
8 
9 # Stop AI and then play a goodbye message
10 client.calling.ai_stop(call_id="call-id-xxx", control_id="ctrl-id")
11 client.calling.play(
12     call_id="call-id-xxx",
13     play=[{"type": "tts", "text": "Thank you for calling. Goodbye!"}]
14 )
15 client.calling.end(call_id="call-id-xxx", reason="hangup")