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
  • DIDforSale Collects Response
  • Here is an example

Was this helpful?

  1. Voice and SMS APIs
  2. Voice
  3. didML Reference Doc

Voice API Response

Our system expect a response from your application in didML formate.

PreviousVoice API Request ParamsNextdidML Verbs

Last updated 6 years ago

Was this helpful?

DIDforSale Collects Response

In the you saw how DIDforSale makes HTTP request to your URL as soon as your phone number is called. Now as a result the server is trying to access the <didML> file which stores all the instructions that have been programmed by you. In other words system is figuring out what the next step is? Whether to greet the caller by name, or play music on hold or connect the call etc. Whatever is being stated in the file is the Response from your URL to the that was sent by DIDforSale.

Here is an example

If someone calls your number, DIDforSale will look up for the URL specified for that number and make a request. Web server will then send the instructions on what to do with that call. Say you want to play a Company Greeting, or Forward the call to a cell phone etc.

<?xml version="1.0" encoding="UTF-8"?>
<Response>
    <Say>Please hold while we connect your call.</Say>
    <Dial>19499300366<dial/>
    <hangup/>
</Response>

As soon as DIDforSale gets access to <didML> document, phone system will convert the text to audio and play the messages to the caller. Once the message is played it will forward the call to another number as specified in the instructions. Please Note: Only one document can be served at one time, but you can link other documents based on input from the user. This way you can build a complex voice application. Like if Press 1 to do this, or Press 2 to do that else hangup.

Learn more about all the verbs you can use in the application.

<didML> collects the response from the URL and DIDforSale executes the instructions. Within the code any instruction that is passed within the <response> parameter is what <didML> looks for. With the use of various , you can create a complex dial plan to meet your unique needs.

Verbs
previous Step
Request
Response collected from the application