XML: <StartGather>

The StartGather verb is used to get asynchronous notifications of DTMF digits collected in the call while other verbs are executed.

It can, for instance, listen for DTMF digits while a call is in a <Conference>, in a <Transfer>, in a <Bridge>, or while executing other verbs.

It cannot be used with the <Forward> verb.

It is paused during the execution of a <Gather> verb; digits pressed during a <Gather> will not be duplicated as DTMF events.

The StartGather verb can be cancelled by the <StopGather> verb.


Attribute Description
dtmfUrl URL to send the DTMF event to. May be a relative URL.
dtmfMethod (optional) The HTTP method to use for the request to dtmfUrl. GET or POST. Default value is POST.
username (optional) The username to send in the HTTP request to dtmfUrl.
password (optional) The password to send in the HTTP request to dtmfUrl.
tag (optional) A custom string that will be sent with this and all future callbacks unless overwritten by a future tag attribute or <Tag> verb, or cleared.

May be cleared by setting tag=""

Max length 256 characters.

Callbacks Received

Callback Can reply with more BXML
dtmf No

Example 1 of 1: Gather digits during a Conference

This example shows how to use the StartGather verb to listen for digits pressed while the call is in a Conference. Whenever a digit is entered, a dtmf event is sent with the detected digit.

<?xml version="1.0" encoding="UTF-8"?>
    <StartGather dtmfUrl="https://startgather.url/callback" />

results matching ""

    No results matching ""