The User Element

The User element is used 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 of the dialed users are hung up.

!!! note “Note: When dialing multiple numbers simultaneously, if confirmSound and confirmKey are specified for the Dial element, the phone which confirms the key correctly will be bridged while all others will fail.”

Attributes

sendDigits string

The sendDigits attribute tells the Plivo API to play DTMF tones when the call is answered. This is useful when dialing a phone number and an extension. Plivo will dial the number, and when the automated system picks up, the DTMF tones are sent to connect to the extension.

Allowed values - any digits and the w character. Each w character tells the Plivo API to wait 0.5 seconds instead of playing a digit. No default value.

sendOnPreanswer boolean

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

Allowed values - true or false. Defaults to false.

sipHeaders string

List of SIP headers to send separated by comma. E.g. head1=val1,head2=val2,head3=val3,...,headN=valN. The SIP headers are always prefixed with X-PH-. For each HTTP Request called by the dialed leg, the SIP headers will be present.

Allowed values - Only [A-Z], [a-z] and [0-9] characters are allowed for SIP headers key. Only [A-Z], [a-z], [0-9] and '%' characters are allowed to ensure so you can encode this value in a URL.