Vobiz Logo
Vobiz
|API Documentation
Console

The User Element

You can use the User element to specify a SIP endpoint (user) to dial.

You can use multiple User elements within a Dial element to simultaneously call multiple SIP endpoint users. The first user to answer is connected to the current call and the rest are hung up.

Note: When dialing multiple numbers simultaneously, if confirmSound and confirmKey are specified for the Dial element, the phone that confirms the key correctly is bridged and all others fail.

Attributes

AttributeDescription
sendDigits
string

Tells the API to play DTMF tones when the call is answered. This is useful when dialing a phone number and an extension. Vobiz dials the number, and when the automated system picks up, it sends DTMF tones to connect to the extension.

Allowed values: any digits and the w character. Each w character tells the Vobiz API to wait 0.5 seconds.

No default value.

sendOnPreanswer
boolean

If set to true, sendDigits is executed when the called party is in early media instead of the answer state.

Allowed values: true, false

Defaults to false.

sipHeaders
string

List of SIP headers to send, separated by commas. For example, head1=val1,head2=val2,head3=val3,…,headN=valN. The SIP headers are always prefixed with X-PH-, and are always present for each HTTP request called by the dialed leg.

Allowed values: Only [A-Z], [a-z] and [0-9] characters are allowed for SIP header names and values to ensure you can encode them in a URL.

Dialing extensions

This code calls the 2410 extension at sip:john1234@registrar.vobiz.ai. The User element describes the SIP endpoint and gives it the attribute sendDigits. To dial the extension a couple of seconds after the number is dialed, we add a few leading w characters, telling Vobiz to wait 0.5 seconds for each w.

Response

XML Response
<Response>
    <Dial>
        <User sendDigits="wwww2410">sip:john1234@registrar.vobiz.ai</User>
    </Dial>
</Response>
Simultaneous dialing
DTMF