Dial
Connect the caller to a phone number, several numbers, or a SIP address.
Connect the caller to a phone number, several numbers, or a SIP address.
dial connects the caller to a phone number, a list of numbers, or a SIP address. Set exactly one of number, numbers or sip.
A dialled leg to a phone number is charged at the outbound rate, per second from the moment it is answered.
| Parameter | Type | Required | Description |
|---|---|---|---|
number | string | No | One phone number in E.164 form, for example +254720000000. |
numbers | array of strings | No | Several phone numbers in E.164 form. |
sip | string | No | A SIP address, for example sip:alice@example.com. |
callerId | string | No | The number shown to the person being called. |
timeout | integer | No | Seconds to ring before giving up. |
record | string | No | record-from-answer records from the moment the other side answers. record-from-ringing includes the ringing. Leave it out for no recording. |
sequential | boolean | No | true rings numbers one after another. false rings them all at once. |
first_answer_wins | boolean | No | true connects the first to answer and stops ringing the rest. |
import { sauti } from "@sautikit/node";
res.json(sauti.dial({
number: "+254720000000",
callerId: "+254200000001",
timeout: 30,
record: "record-from-answer",
}));{
"actions": [
{
"dial": {
"number": "+254720000000",
"callerId": "+254200000001",
"timeout": 30,
"record": "record-from-answer"
}
}
]
}<Dial callerId="+254200000001" timeout="30" record="record-from-answer"><Number>+254720000000</Number></Dial>