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

Was this helpful?

  1. API
  2. didML reference doc
  3. didML Verbs

<gather>

Role: <gather>, in simple words collects the user response as the user makes their choice by pressing the keys on the dial pad.

Use: The main use of <gather> is to collect the digits as the user enters them from their phone. Some of the examples stating how gather can be used are :-

  • IVR – When building an IVR for your company <gather> collects the digits that the user enters to direct the call to correct department/individual.

  • Conference – When joining a conference caller enters the “pin”. This pin is collected by <gather> for validating the user.

  • Authentication – Yet another way of using <gather> for security authentication when accessing personal or secured information over phone.

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

Attributes

Attribute

Value

Default

action

Callback URL

none

Method

POST/GET

POST

minDigits

1-200

1

numDigits

1-200

20

Timeout (in seconds)

Integer

4 Seconds

Tries

1-10

3

Audiotype

text to speech (tts)

none

finishOnKey

0-9 ; * ; #

#

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

<?xml version="1.0" encoding="UTF-8"?> 
<Response>
     <Gather timeout="10" finishOnKey="*" action="handle-key.php">
         <Say>Please enter the Extension number you want to dial.</Say>
     </Gather>
 </Response>

Once the user enters the response. It will call http://yourserver/handle-key.php

<?php
echo "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"; 
echo "<Response><Say>You entered ".$_REQUEST['Digits']. "</Say></Response>"; ?>

Previous<fax>Next<hangup>

Last updated 6 years ago

Was this helpful?