Vobiz Logo
Vobiz
|API Documentation
Console

The Number Element

You can use the Number element to specify a phone number to dial.

You can use multiple Number elements within a Dial element to simultaneously call multiple numbers. The first call to pick up is connected to the current call and the rest are hung up.

Use the Number element to

  • Forward an incoming call on a Vobiz number to a mobile or a landline number.
  • Make an outbound call to an agent and then bridge the call to a client's number for call center use cases.
  • Enable click to call, where you input a number on a web-based form and request a connection with another person.

Note: When dialing multiple numbers simultaneously, if confirmSound and confirmKey are specified for the Dial element, the number 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. The API 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 answer state.

Allowed values: true, false

Defaults to false.

Dialing extensions

This code dials the extension 2410 at the number 15671234567. The Number element describes the phone number and gives it the sendDigits attribute. 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>sip:alice1234@registrar.vobiz.ai</User>
      <Number>15671234567</Number>
      <User>sip:john1234@registrar.vobiz.ai</User>
    </Dial>
</Response>
Dial status reporting
Sequential dialing