send_fax_stop | SignalWire

Stop an in-progress fax send operation on an active call.

This method stops a fax send that is already in progress. To initiate fax sending, use the RELAY client’s send_fax() method.

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 client.calling.send_fax_stop(call_id="call-id-xxx", control_id="ctrl-id")