collect | SignalWire

Start collecting user input on an active call. Supports DTMF digit collection and speech recognition. Returns a control_id for managing the collection.

Request

dialobjectRequired

updateobjectRequired

calling.endobjectRequired

calling.disconnectobjectRequired

calling.ai_holdobjectRequired

calling.ai_unholdobjectRequired

calling.ai_messageobjectRequired

calling.ai.stopobjectRequired

calling.playobjectRequired

calling.play.pauseobjectRequired

calling.play.resumeobjectRequired

calling.play.stopobjectRequired

calling.play.volumeobjectRequired

calling.recordobjectRequired

calling.record.pauseobjectRequired

calling.record.resumeobjectRequired

calling.record.stopobjectRequired

calling.collectobjectRequired

calling.collect.stopobjectRequired

calling.collect.start_input_timersobjectRequired

calling.detectobjectRequired

calling.detect.stopobjectRequired

calling.tapobjectRequired

calling.tap.stopobjectRequired

calling.streamobjectRequired

calling.stream.stopobjectRequired

calling.denoiseobjectRequired

calling.denoise.stopobjectRequired

calling.transcribeobjectRequired

calling.transcribe.stopobjectRequired

calling.live_transcribeobjectRequired

calling.live_translateobjectRequired

calling.transferobjectRequired

calling.send_fax.stopobjectRequired

calling.receive_fax.stopobjectRequired

calling.referobjectRequired

calling.user_eventobjectRequired

Response

Call LegobjectRequired

Fabric Subscriber Device LegobjectRequired

Response Example

Response

1 {
2   "id": "0e9c80d7-a149-4917-892d-420043709f45",
3   "from": "+12069708643",
4   "to": "+15550198765",
5   "direction": "outbound-api",
6   "source": "realtime_api",
7   "charge": 0,
8   "created_at": "2024-05-06T12:20:00Z",
9   "charge_details": [
10     {
11       "description": "Outbound Voice",
12       "charge": 0.004
13     }
14   ],
15   "status": "queued",
16   "type": "relay_pstn_call"
17 }

Examples

Collect DTMF Digits

1 import { RestClient } from "@signalwire/sdk";
2 
3 const client = new RestClient({
4   project: "your-project-id",
5   token: "your-api-token",
6   host: "your-space.signalwire.com"
7 });
8 
9 // Collect DTMF digits
10 const result = await client.calling.collect("call-id-xxx", {
11   digits: { max: 4, terminators: "#", digit_timeout: 5.0 },
12   initial_timeout: 10.0,
13 });

Collect Speech

1 import { RestClient } from "@signalwire/sdk";
2 
3 const client = new RestClient({
4   project: "your-project-id",
5   token: "your-api-token",
6   host: "your-space.signalwire.com"
7 });
8 
9 const result = await client.calling.collect("call-id-xxx", {
10   speech: {
11     end_silence_timeout: 1.0,
12     language: "en-US",
13   },
14 });

Collect Both

1 import { RestClient } from "@signalwire/sdk";
2 
3 const client = new RestClient({
4   project: "your-project-id",
5   token: "your-api-token",
6   host: "your-space.signalwire.com"
7 });
8 
9 const result = await client.calling.collect("call-id-xxx", {
10   digits: { max: 1, terminators: "#" },
11   speech: { end_silence_timeout: 2.0 },
12   initial_timeout: 15.0,
13 });