AudioCodes Mediant 600 - Page 432

SIP User's Manual 432 Document #: LTRT-83310
Mediant 600 & Mediant 1000
20.1.2.2.4 Playing Announcements and Collecting Digits
The <PlayCollect> request is used to play an announcement to the caller and to then
collect entered DTMF digits. The play part of the <PlayCollect> request is identical to the
<Play> request. The collect part includes an expected digit map. The collected digits are
continuously compared to the digit map. Once a match is found, the collected digits are
sent in a <PlayCollect> response. The digit map should be in MGCP format (the type value
must be set to ‘mgcpdigitmap’).
For example:
<regex type="mgcpdigitmap" value="(
[0-
1]xxx)">
</regex>
Each <PlayCollect> request contains the following request-specific parameters in addition
to the Prompt block (all parameters are optional):

id: an optional random number used to synchronize request and response.

prompturl: a specific audio file URL that is used in addition to the references in the
prompt block. This audio file is the first to be played.

barge: if set to ‘NO’, DTMF digits received during announcement playback are
ignored. If set to ‘YES’, DTMF digits received during announcement playback stop the
playback and start the digit collection phase.

firstdigittimer: defines the amount of time (in milliseconds) the user does not enter any
digits, after which a response is sent indicating timeout.

interdigittimer: defines the amount of time (in milliseconds) the user does not enter any
digits after the first DTMF digit is received, after which a response is sent indicating
timeout.

extradigittimer: used to enable the following:
• Detection of command keys (ReturnKey and EscapeKey).
• Not report the shortest match. MGCP Digitmap searches for the shortest possible
match. This means that if a digitmap of (123 | 1234) is defined, once the user
enters 123, a match is found and a response is sent. If ExtraDigitTimer is defined,
the match can also be 1234 because the device waits for the next digits. To use
ExtraDigitTimer, it must be defined in the request and you must add a “T” to the
Digitmap (for example, 'xxT'). The ExtraDigitTimer is only used when a match is
found. Before a match is found, the timer used is the InterDigitTimer. Therefore, if
the ExtraDigitTimer expires, a “match” response reason is reported -- never a
“timeout”.

maxdigits: defines the maximum number of collected DTMF digits after which the
device sends a response.

cleardigits: defines whether or not the device clears the digit buffer between
subsequent requests.

returnkey: defines a specific digit (including ‘*’ and ‘#’) which (when detected during a
collection) stops the collection and initiates a response (that includes all digits
collected up to that point) to be sent.

escapekey: defines a specific digit (including ‘*’ and ‘#’) which (when detected during a
collection) stops the collection and initiates a response (with no collected digits) to be
sent.