Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,13 @@ 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.

<EndpointSchemaSnippet endpoint="POST /api/calling/calls" />
## **Request**

## **Response Example**
<Schema type="Calling.CallHoldRequest" api="signalwire-rest" exclude={["command"]} />

<EndpointResponseSnippet endpoint="POST /api/calling/calls" />
## **Response**

<Schema type="Calling.CallResponse" api="signalwire-rest" />

## **Example**

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,13 @@ 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.

<EndpointSchemaSnippet endpoint="POST /api/calling/calls" />
## **Request**

## **Response Example**
<Schema type="Calling.CallAIMessageRequest" api="signalwire-rest" exclude={["command"]} />

<EndpointResponseSnippet endpoint="POST /api/calling/calls" />
## **Response**

<Schema type="Calling.CallResponse" api="signalwire-rest" />

## **Example**

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,13 @@ max-toc-depth: 3
Stop an active AI session on a call. The AI agent is disconnected but
the call itself remains active, allowing further call control operations.

<EndpointSchemaSnippet endpoint="POST /api/calling/calls" />
## **Request**

## **Response Example**
<Schema type="Calling.CallAIStopRequest" api="signalwire-rest" exclude={["command"]} />

<EndpointResponseSnippet endpoint="POST /api/calling/calls" />
## **Response**

<Schema type="Calling.CallResponse" api="signalwire-rest" />

## **Example**

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,13 @@ max-toc-depth: 3
Resume an AI session that was previously put on hold with
[`ai_hold()`][ai-hold].

<EndpointSchemaSnippet endpoint="POST /api/calling/calls" />
## **Request**

## **Response Example**
<Schema type="Calling.CallUnholdRequest" api="signalwire-rest" exclude={["command"]} />

<EndpointResponseSnippet endpoint="POST /api/calling/calls" />
## **Response**

<Schema type="Calling.CallResponse" api="signalwire-rest" />

## **Example**

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,13 @@ Manually start the input timers for a collection that was started without
automatic timer activation. This is useful when you want to play a prompt
before starting the timer countdown.

<EndpointSchemaSnippet endpoint="POST /api/calling/calls" />
## **Request**

## **Response Example**
<Schema type="Calling.CallCollectStartInputTimersRequest" api="signalwire-rest" exclude={["command"]} />

<EndpointResponseSnippet endpoint="POST /api/calling/calls" />
## **Response**

<Schema type="Calling.CallResponse" api="signalwire-rest" />

## **Example**

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,13 @@ max-toc-depth: 3

Stop an active input collection.

<EndpointSchemaSnippet endpoint="POST /api/calling/calls" />
## **Request**

## **Response Example**
<Schema type="Calling.CallCollectStopRequest" api="signalwire-rest" exclude={["command"]} />

<EndpointResponseSnippet endpoint="POST /api/calling/calls" />
## **Response**

<Schema type="Calling.CallResponse" api="signalwire-rest" />

## **Example**

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,13 @@ max-toc-depth: 3
Start collecting user input on an active call. Supports DTMF digit collection
and speech recognition. Returns a `control_id` for managing the collection.

<EndpointSchemaSnippet endpoint="POST /api/calling/calls" />
## **Request**

## **Response Example**
<Schema type="Calling.CallCollectRequest" api="signalwire-rest" exclude={["command"]} />

<EndpointResponseSnippet endpoint="POST /api/calling/calls" />
## **Response**

<Schema type="Calling.CallResponse" api="signalwire-rest" />

## **Examples**

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,13 @@ max-toc-depth: 3

Disable noise reduction on an active call.

<EndpointSchemaSnippet endpoint="POST /api/calling/calls" />
## **Request**

## **Response Example**
<Schema type="Calling.CallDenoiseStopRequest" api="signalwire-rest" exclude={["command"]} />

<EndpointResponseSnippet endpoint="POST /api/calling/calls" />
## **Response**

<Schema type="Calling.CallResponse" api="signalwire-rest" />

## **Example**

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,13 @@ max-toc-depth: 3
Enable noise reduction on an active call. This applies real-time noise
suppression to the audio stream, improving clarity for both parties.

<EndpointSchemaSnippet endpoint="POST /api/calling/calls" />
## **Request**

## **Response Example**
<Schema type="Calling.CallDenoiseRequest" api="signalwire-rest" exclude={["command"]} />

<EndpointResponseSnippet endpoint="POST /api/calling/calls" />
## **Response**

<Schema type="Calling.CallResponse" api="signalwire-rest" />

## **Example**

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,13 @@ max-toc-depth: 3

Stop an active detector.

<EndpointSchemaSnippet endpoint="POST /api/calling/calls" />
## **Request**

## **Response Example**
<Schema type="Calling.CallDetectStopRequest" api="signalwire-rest" exclude={["command"]} />

<EndpointResponseSnippet endpoint="POST /api/calling/calls" />
## **Response**

<Schema type="Calling.CallResponse" api="signalwire-rest" />

## **Example**

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,13 @@ max-toc-depth: 3
Start a detector on an active call. Detectors can identify answering machines,
fax tones, or DTMF digits. Returns a `control_id` for managing the detector.

<EndpointSchemaSnippet endpoint="POST /api/calling/calls" />
## **Request**

## **Response Example**
<Schema type="Calling.CallDetectRequest" api="signalwire-rest" exclude={["command"]} />

<EndpointResponseSnippet endpoint="POST /api/calling/calls" />
## **Response**

<Schema type="Calling.CallResponse" api="signalwire-rest" />

## **Examples**

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,13 @@ Since `from` is a Python reserved keyword, pass it as `from_=` or use dict
unpacking: `**{"from": "+15551234567"}`.
</Note>

<EndpointSchemaSnippet endpoint="POST /api/calling/calls" />
## **Request**

## **Response Example**
<Schema type="Calling.CallCreateRequest" api="signalwire-rest" exclude={["command"]} />

<EndpointResponseSnippet endpoint="POST /api/calling/calls" />
## **Response**

<Schema type="Calling.CallResponse" api="signalwire-rest" />

## **Example**

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,13 @@ max-toc-depth: 3
Disconnect (unbridge) a connected call. If two call legs are bridged together,
this separates them without ending either leg.

<EndpointSchemaSnippet endpoint="POST /api/calling/calls" />
## **Request**

## **Response Example**
<Schema type="Calling.CallDisconnectRequest" api="signalwire-rest" exclude={["command"]} />

<EndpointResponseSnippet endpoint="POST /api/calling/calls" />
## **Response**

<Schema type="Calling.CallResponse" api="signalwire-rest" />

## **Example**

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,13 @@ max-toc-depth: 3

End an active call.

<EndpointSchemaSnippet endpoint="POST /api/calling/calls" />
## **Request**

## **Response Example**
<Schema type="Calling.CallHangupRequest" api="signalwire-rest" exclude={["command"]} />

<EndpointResponseSnippet endpoint="POST /api/calling/calls" />
## **Response**

<Schema type="Calling.CallResponse" api="signalwire-rest" />

## **Example**

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,13 @@ Start live transcription on an active call. Unlike standard transcription,
live transcription streams partial results in real time as the caller speaks,
enabling display of in-progress speech.

<EndpointSchemaSnippet endpoint="POST /api/calling/calls" />
## **Request**

## **Response Example**
<Schema type="Calling.CallLiveTranscribeRequest" api="signalwire-rest" exclude={["command"]} />

<EndpointResponseSnippet endpoint="POST /api/calling/calls" />
## **Response**

<Schema type="Calling.CallResponse" api="signalwire-rest" />

## **Example**

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,13 @@ max-toc-depth: 3
Start live translation on an active call. Spoken audio is transcribed and
translated in real time to a target language.

<EndpointSchemaSnippet endpoint="POST /api/calling/calls" />
## **Request**

## **Response Example**
<Schema type="Calling.CallLiveTranslateRequest" api="signalwire-rest" exclude={["command"]} />

<EndpointResponseSnippet endpoint="POST /api/calling/calls" />
## **Response**

<Schema type="Calling.CallResponse" api="signalwire-rest" />

## **Example**

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,13 @@ max-toc-depth: 3

Pause an active playback.

<EndpointSchemaSnippet endpoint="POST /api/calling/calls" />
## **Request**

## **Response Example**
<Schema type="Calling.CallPlayPauseRequest" api="signalwire-rest" exclude={["command"]} />

<EndpointResponseSnippet endpoint="POST /api/calling/calls" />
## **Response**

<Schema type="Calling.CallResponse" api="signalwire-rest" />

## **Example**

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,13 @@ max-toc-depth: 3

Resume a paused playback.

<EndpointSchemaSnippet endpoint="POST /api/calling/calls" />
## **Request**

## **Response Example**
<Schema type="Calling.CallPlayResumeRequest" api="signalwire-rest" exclude={["command"]} />

<EndpointResponseSnippet endpoint="POST /api/calling/calls" />
## **Response**

<Schema type="Calling.CallResponse" api="signalwire-rest" />

## **Example**

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,13 @@ max-toc-depth: 3

Stop an active playback immediately.

<EndpointSchemaSnippet endpoint="POST /api/calling/calls" />
## **Request**

## **Response Example**
<Schema type="Calling.CallPlayStopRequest" api="signalwire-rest" exclude={["command"]} />

<EndpointResponseSnippet endpoint="POST /api/calling/calls" />
## **Response**

<Schema type="Calling.CallResponse" api="signalwire-rest" />

## **Example**

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,13 @@ max-toc-depth: 3

Adjust the volume of an active playback.

<EndpointSchemaSnippet endpoint="POST /api/calling/calls" />
## **Request**

## **Response Example**
<Schema type="Calling.CallPlayVolumeRequest" api="signalwire-rest" exclude={["command"]} />

<EndpointResponseSnippet endpoint="POST /api/calling/calls" />
## **Response**

<Schema type="Calling.CallResponse" api="signalwire-rest" />

## **Example**

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,13 @@ used with [`play_pause()`][play-pause],
[`play_volume()`][play-volume] to manage
the playback.

<EndpointSchemaSnippet endpoint="POST /api/calling/calls" />
## **Request**

## **Response Example**
<Schema type="Calling.CallPlayRequest" api="signalwire-rest" exclude={["command"]} />

<EndpointResponseSnippet endpoint="POST /api/calling/calls" />
## **Response**

<Schema type="Calling.CallResponse" api="signalwire-rest" />

## **Examples**

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,13 @@ This method stops a fax receive that is already in progress. To initiate fax rec
use the RELAY client's [`receive_fax()`][receive-fax] method.
</Note>

<EndpointSchemaSnippet endpoint="POST /api/calling/calls" />
## **Request**

## **Response Example**
<Schema type="Calling.CallReceiveFaxStopRequest" api="signalwire-rest" exclude={["command"]} />

<EndpointResponseSnippet endpoint="POST /api/calling/calls" />
## **Response**

<Schema type="Calling.CallResponse" api="signalwire-rest" />

## **Example**

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,13 @@ max-toc-depth: 3
Pause an active recording. The recording can be resumed later with
[`record_resume()`][record-resume].

<EndpointSchemaSnippet endpoint="POST /api/calling/calls" />
## **Request**

## **Response Example**
<Schema type="Calling.CallRecordPauseRequest" api="signalwire-rest" exclude={["command"]} />

<EndpointResponseSnippet endpoint="POST /api/calling/calls" />
## **Response**

<Schema type="Calling.CallResponse" api="signalwire-rest" />

## **Example**

Expand Down
Loading
Loading