Skip to main content
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

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-VH-, 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.

​
Setting the caller ID

The caller ID presented to the SIP endpoint is controlled by the callerId attribute on the parent Dial element - not on User itself. Set it to override the number displayed to the called party (for example, to present your own Vobiz number when forwarding or transferring a call): 
<?xml version="1.0" encoding="UTF-8"?>
<Response>
    <Speak>Please hold while we transfer your call.</Speak>
    <Dial callerId="+14155551234">
        <User>sip:john1234@registrar.vobiz.ai</User>
    </Dial>
</Response>
If callerId is omitted, the current caller’s caller ID is used by default. See Transfer a Call for a full walkthrough of using the Dial element to transfer and forward calls.

​
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 version="1.0" encoding="UTF-8"?>
<Response>
    <Dial>
        <User sendDigits="wwww2410">sip:john1234@registrar.vobiz.ai</User>
    </Dial>
</Response>