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
  • <didML>
  • <didML> Verbs

Was this helpful?

  1. Voice and SMS APIs
  2. Voice

didML Reference Doc

DIDforSale cPaaS is designed to provide a platform to do API development in your application using <didML> which is an acronym for DIDforSale Mark up Language.

<didML>

DIDforSale API is designed to provide you with a comprehensive tool set to make API development breeze for you. <didML> which is an acronym for DIDforSale Mark up Language puts together set of instructions to be used when programming your inbound calls. These instructions lay down step by step process as to what to do when someone calls your DIDforSale(DFS) phone number. As soon as the number is dialed DFS will read the instructions from the URL where <didML> has listed actions that can be performed. These actions are defined as <didML> verb. Some of the examples are, Say caller name, play music, prompt for user input by pressing key.

<didML> Verbs

<didML> Verbs is the list of actions verbs that have a specific function. When programming with choice of your programming language you can include these verbs to compile your set of instructions for inbound calls. These verbs can be used by themselves or can be used in combination. This list below lists all the verbs included in <didML>. The description of the verb defines the role of the verb.

Verb

Description

<Conference>

Create a dynamic conference bridge and put the caller in that conference

<Dial>

Connect the existing call to another party

<EnQueue>

Put the caller in the queue.

<Fax>

Receive the fax. System will give the fax tone to the caller and receive the fax.

<Forward>

Same as dial. Connect the existing call to another party

<Gather>

Collect the digits pressed from caller phone. (collect user response)

<Hangup>

Disconnect the call

<Pause>

Stop the call for some time before executing next instruction.

<Play>

Play a mp3/wav audio file from the web server.

<Postcall>

URL can be supplied to collect all the details of the call.

<Queue>

Pickup the call from the queue.

<Record>

Caller is given the option to record the message

<Recording>

Record the complete call. Caller and the called party do not know if the call is being recorded unless mentioned.

<Redirect>

Redirect the call flow to different URL to access another set instructions included in another didML document.

<Reject>

Reject the incoming call.

<Say>

Read the text, convert that to audio and play to the caller.

Lets looks at the information we send you when we receive call on any of your phone numbers.

PreviousCollect ResponseNextVoice API Request Params

Last updated 6 years ago

Was this helpful?