Dial

DialAction connects the caller to one or more numbers/SIP endpoints. Number/SIP URIs are subject to the same destination authorisation as POST /v1/calls.

2026-06-27

DialAction connects the caller to one or more numbers/SIP endpoints. Number/SIP URIs are subject to the same destination authorisation as POST /v1/calls. URL must be on the allow-list when dialling SIP.

Parameter	Type	JSON key	Required	Description
`Number`	`string`	`number`	No	Number is the E.164 destination to dial. Required unless SIP is set.
`SIP`	`string`	`sip`	No	SIP is the SIP URI to dial (e.g. "sip:alice@example.com"). Mutually exclusive with Number.
`CallerID`	`string`	`callerId`	No	CallerID is the caller ID presented to the callee. Optional.
`Timeout`	`int`	`timeout`	No	Timeout is the number of seconds to ring before giving up.
`Record`	`string`	`record`	No	Record requests recording of the connected leg ("record-from-answer", "record-from-ringing", etc.). Optional.

{"actions":[{"dial":{}}]}

<Dial callerId="+254200000001" timeout="30" record="true"><Number>+254712345678</Number></Dial>