Documentation for Developer/Administrators
HomeAccount PortalPricing
  • About this Documentation
  • Overview
    • Table of Content
    • Introduction
    • Welcome Kit
      • Add Balance
      • Buy New Phone Number
      • Voice configuration
      • SMS Configuration
        • SMS Forwarding
      • Reporting
        • CDR
        • SMS
        • FAX
  • DIDforSale Portal
    • Register a new account
    • Dashboard
    • Reporting
      • CDR
      • SMS
      • Inbound Calls
      • FAX
      • Group Usage
      • Voicemails
    • Phone Numbers
      • Phone Numbers
      • Channels
      • E911
      • Porting
      • Send FAX
      • FAX Emails
      • SMS Groups
      • Groups
      • CNAM
    • Interconnection
      • Manage IP
      • SIP Accounts
      • Testing Center
      • Phones and Devices
      • Custom Dialplan
      • Audio Files
    • Tools/Settings
      • Outbound Rates
      • API Control
      • Fraud Control
      • Postcalls
    • Account
      • Profile
      • Change Password
      • Add Balance
      • Payment History
      • Voucher
      • Invoices
      • Auto Refill
      • Charges
      • Contact Us
      • Global Settings
      • Logout
  • SIP Trunking
    • Configuration of Phone Numbers
      • Configuring SIP to IP Account
      • Configuring Custom Dial Plan to a Phone Number
      • Configure SIP to SIP Account
      • Set up Call Forwarding to a Phone Number
      • http URL Forwarding Setup
      • Webhook Setup
      • FAX
        • Receive FAX
        • Fax through SIP Account
        • Send FAX
    • Adding IP Address
    • Creating SIP Account
      • VoiceMails
    • SIP Trunk Interconnection Guide
      • 3CX
        • SIP-based Configuration
        • IP-based Configuration
      • Allworx
      • Asterisk
      • CISCO UCM
      • FreePBX
        • FreePBX PJSIP Configuration
          • IP-based
          • SIP-based
        • FreePBX ChanSIP Configuration
          • IP based
          • SIP based
      • FreeSwitch
      • FusionPBX
      • GoAutoDial
      • Grandstream Devices
        • GrandStream 6102 IPPBX
        • GrandStream 502
        • Grandstream 6104 IPPBX
      • HoduSoft PBX System
      • Microsoft Skype for Business
      • NEC Corporation
      • PBXinaFlash
      • Polycom OBi300
      • ShoreTel PBX
      • Vital PBX
      • Yealink Phones
      • ZYCOO
    • DIDForSale Softphone
    • Zoiper Softphone Application
      • Iphone App
    • Grandstream Wave Mobile Application
    • Enable Call Recording
    • Call Transcription
  • Voice and SMS APIs
    • Getting the API key and Token
    • Voice
      • Big Picture
      • Quick Start
        • Identify Caller
        • Collect Response
      • didML Reference Doc
        • Voice API Request 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>
    • SMS
      • Configure SMS
      • Send/Receive SMS via Email
      • SMS Forwarding
        • SMS forwarding to Phone Number
        • SMS forwarding to Email
        • SMS forwarding to a Webhook
      • SMS/MMS Desktop Application
      • SMS APIs
        • Activate SMS
        • Deactivate SMS API
        • Send SMS
        • SMS CDR
        • Set SMS Forwarding
      • Bulk SMS Feature
        • Creating SMS Campaign
        • Custom or Dynamic Text Sms
  • UC Editor
    • UC Editor
      • Features
      • How to configure/setup the Custom Call Flow
  • FAX via Email
    • Send & Receive FAX via Email
Powered by GitBook
On this page

Was this helpful?

  1. Voice and SMS APIs
  2. Voice
  3. didML Verbs

<dial>

Role: <dial> command is used when call needs to leave the system and connect with another number. For example, forwarding the call on number 1949300360 to another number 19492321402, requires system to dial another number and connect the 2nd leg with original caller. More actions can be taken if the called part does not pickup the call.

Use:

  • Number Masking: You dont want to expose you cell phone number to your contacts. People call the DID number and that number can be forwarded to your cell phone.

  • Multiple Business Numbers: You have many numbers from different sources and want to forward all the call to your main office line.

  • Call tacking and lean generation: Have a dedicated number for each ad or landing page and forward the call to a call center. Later you can generate a report which number was called most often.

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

Attributes

Attribute

Value

Default

action

Callback URL

none

Method

POST/GET

POST

timeout

integer

30 seconds

timelimit

integer value

4 hours

callerid

valid phone number

caller’s caller id

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

<?xml version="1.0" encoding="UTF-8"?> 
<Response>
     <dial>19492321402</dial>
</Response>

In another example, dial will record the sessions and disconnect the call after 60 seconds.

<?xml version="1.0" encoding="UTF-8"?> 
<Response>
     <dial record="on" timeout="60">19492321402</dial>
</Response>

DIDforSale offer many ways you can connect the caller. Some are free and some are paid. For example, forward the call to another sip account or sip based pbx does not cost extra, While forwarding the call to another number might include outbound charges as well as inbound (Depending on what plan and agreement you have in place).

Here are more keyword you can use inside dial to connect the caller to second leg. These keywords can be nested inside dial command.

keyword

description

phone number to dial

get the free SIP client and connect the call to SIP Cleint

Sip URI, spi:bob@example.com

Connect the caller to a conference bridge

Connect the caller to the 1st person waiting in the queue

A simple example to nest <number> keyword to <dial>

<?xml version="1.0" encoding="UTF-8"?> 
<Response>
     <dial record="on" timeout="60"> 
       <number>19492321402</number>
     </dial>
</Response>

Example 2 Call a SIP Trunk using >sip>, here call wil be forwarded to sip.mydomain.com. sip.mydomain.com must accept all calls from our IPs. In the example username part is blank, so dialed number will be appended to the make full uri.

<?xml version="1.0" encoding="UTF-8"?> 
<Response>
     <dial record="on" timeout="60"> 
       <number>sip.mydomain.com</number>
     </dial>
</Response>
PreviousdidML VerbsNext<client>

Last updated 6 months ago

Was this helpful?

<number>
<client>
<sip>
<conference>
<queue>