Cebod Telecom
  • Introduction
  • Customer Onboarding
  • FAQs (Frequently Asked Questions)
  • Cebod Telecom Web Portal
    • Dashboard
    • Activities
      • Call records
      • Messages
      • Active calls
      • SMS records
      • Faxes
    • Phone System
      • Phone Numbers
      • IVR (Auto Receptionist)
      • Users (Extensions)
        • Dynamic Caller ID
      • Manage Devices
      • Manage Groups
      • Manage Conferences
      • Postcall Actions
      • Webhooks
      • Time Conditions
      • Call Blocking
      • Call Center
        • Active Calls
        • Agents
        • Queue
        • Agents to queue
        • Agents Status
        • Agent Statistics
    • Tools / Settings
      • Manage Phone Lines
      • Add 911 Address
      • SMS
      • International Calling
      • Outbound Rates
      • Manage Recordings
        • AI Text-to-Speech Feature
      • Global Settings
        • Daily Spent Control
      • Voicemail Greetings
      • CNAM
    • My Account
      • Profile
      • Change Password:
      • Add Balance
      • Payment History
      • Vouchers
      • Invoices
      • Auto Refill
      • Logout
  • How To's
    • Set up BLF
    • Register a New Account
    • Setup Call Forwarding
      • Call Forwarding to an Extension
      • Call Forwarding Manually to a Cell Phone
    • Dial-By-Name Directory
    • Voicemail
      • Setting up the Voicemail Menu
      • Accessing Voicemail
      • Navigate through the Voicemail Menu
    • Provisioning
      • Cisco 8841
    • Setup Speed Dial
    • Cebod Telecom Free Applications
      • MS Windows Desktop Softphone
      • Mac Desktop Softphone
      • Apple IOS Mobile App
      • Android Mobile App
      • Desktop SMS/MMS Application
      • Click to Call Browser Extension
    • GS Wave
    • Setting Up Whisper Announcement
  • Enable Call Recording
  • Features
    • Manage Phone Features
      • Call Block
      • Call transfer
      • Call Queue
      • Call Center
      • Active Call Features
      • Ring Groups
      • Call Forward
      • Call Recording
      • Call Park
      • Paging
      • Voicemail
      • Call Monitoring
      • Hide Caller ID
    • Missed Call SMS
    • Missed Call Email Notification
    • 3-Way Calling
    • Conference Bridge
    • Setting up Time Condition
    • Setup Email FAX - Incoming
    • Sending eFax using email
  • API
    • Voice API
    • Quick Start
      • Identify Caller
      • Collect Response
    • didML reference doc
      • Voice API reference params
      • Voice API response
      • didML Verbs
        • <dial>
          • <client>
          • <conference>
          • <number>
          • <queue>
          • <sip>
        • <enqueue>
        • <fax>
        • <gather>
        • <hangup>
        • <pause>
        • <play>
        • <postcall>
        • <record>
        • <recordcall>
        • <redirect>
        • <reject>
        • <say>
        • <sms>
Powered by GitBook
On this page
  • Attributes
  • Troubleshooting

Was this helpful?

  1. API
  2. didML reference doc
  3. didML Verbs
  4. <dial>

<number>

Role: <number> keyword can be used to dial another number. This keyword can be used independently or it can be nested inside dial. Connecting to call to external number can cost extra depending on the service plan.

Use:

  • Connecting the call to another person based on time and location of the caller.

  • Using it along with IVR, where press 1 can go to sales person and press 1 can go to support number.

While there are no limitation on where <number> can be used, there is set of optional attributes to use with <number>. Below is a list of attributes to be used with <number>, each attribute has a specific function and can use certain values.

Attributes

Attribute

Value

Default

url

Callback URL

none

Method

POST/GET

POST

senddigits

any number digit

none

statusCallbackEvent

initiated, ringing, answered, completed

completed

statusCallback

status call back url

none

statusCallbackMethod

GET/POST

post

maxlength

integer value in seconds

4 hours

callerid

valid phone number

Caller’s ID

timout

Integer in seconds

30 seconds

record

on/off

off

Here is an example of how <number> is used within code.

<?xml version="1.0" encoding="UTF-8"?> 
<Response>
         <number>19499300360</number>
 </Response>

No another example, <number> can be nested inside the <dial> command.

<?xml version="1.0" encoding="UTF-8"?> 
<Response>
    <dial>
         <number maxlength=60 timeout=15>19499300360</number>
    </dial>
 </Response>

Attributes details:

url

If url is detected, phone system will execute the instruction set on the url to the called party. This happens only once the call is answered by the destination number and right before the call is connected to the original caller. This is useful if you want to play a small messaged to the called party. Remember caller is waiting for the call to be connected, so you might not want to make him wait for too long.

Sample callback URL

<?xml version="1.0" encoding="UTF-8"?> 
<Response>
    <dial>
         <number url="https://www.didforsale.com/apidemo/calledurl.xml">19499300360</number>
    </dial>
 </Response>

sendDigits

This attribute, send dtmf digits once the call is answered. For example if you know call is being answered by the IVR and you digits needs to be pressed to connect the call to the destination number. There are two special key ‘w’ and ‘W’. If detect ‘w’ phone system wait for 0.5 seconds and if ‘W’ system wait for 1 second before sending next digits. Example ‘WWWW101’ system will wait for 5 seconds before sending 101.

Sample Send Digits

<?xml version="1.0" encoding="UTF-8"?> 
<Response>
    <dial>
         <number sendDigits="www103">19499300360</number>
    </dial>
 </Response>

statusCallbackEvents

When the system made an outbound call, there are 4 things happens: “initiated”, means system is ready to make a call. “ringing” means end users phone is ringing, “answered”, enduser picked up the call, “completed”, end of the call. statusCallbackEvent event allows you to subscribe for for notifications for these events.

statusCallback

You must specify the users if you want to receive the events. This url will be calls for all the events.

statusCallback Parameters:

Here is list of parameters you receive for each event.

Parameter

Description

Called

Number Dialed

ParentCallSid

Call id of A Leg

CallStatus

One of the event “initiated, ringing, answered, completed”

Direction

Call Direction”Inbound/Outbound”

callSid

Orginal call ID

CallbackSource

call-progress-event

CallDurartion

Only on Completed Event

RecordingURL

If Recording Enabled and only on Completed Event

Example Call Status Events

<?xml version="1.0" encoding="UTF-8"?> 
<Response>
    <dial>
         <Number url="http://www.businessphoneservice.us/phone/index2.xml" 
          statusCallbackEvent="initiated ringing answered completed" 
           statusCallback="http://www.businessphoneservice.us/phone/event.php" 
           statusCallbackMethod="POST">+19499300360</Number>
    </dial>
 </Response>

Advanced Options:

  • With dial and number commands you can call multiple users at the same time. Whoever answers first wins. This is great for simultaneous dialing.

  • If the call is answered automatically answered with a Voicemail, call will be connected to that leg. So need to be careful while using simultaneous calling.

Example Dialing Multiple Numbers Simultaneously

<?xml version="1.0" encoding="UTF-8"?> 
<Response>
    <dial>
         <Number>+19499300360</Number>
         <number>18005797676</number>
    </dial>
 </Response>

Troubleshooting

  • Make sure attributes inside the nodes are in quotes " ".

Previous<conference>Next<queue>

Last updated 6 years ago

Was this helpful?

Running in any Issue? Need Help? team or email us contact-support@didforsale.com.

Contact our support