collect_start_input_timers

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.

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 }

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 # Start collection without auto-timers, play prompt, then start timers
10 result = client.calling.collect(
11     call_id="call-id-xxx",
12     digits={"max": 4, "terminators": "#"},
13 )
14 control_id = result.get("control_id")
15 
16 # Play a prompt first
17 client.calling.play(
18     call_id="call-id-xxx",
19     play=[{"type": "tts", "text": "Please enter your 4-digit PIN."}]
20 )
21 
22 # Now start the input timers
23 client.calling.collect_start_input_timers(
24     call_id="call-id-xxx",
25     control_id=control_id,
26 )