Description:
Display the DTMF tone history buffer contents, most recent time of tone arrival, oldest
time of tone arrival, or clear the contents of a buffer. If no argument is given, then all
buffers will be displayed. If the input channel is given the contents of only that buffer
or time will be displayed.
If only the CHANNEL number is given the buffer will be displayed for the given CHANNEL.
To get an ARGUMENT the CHANNEL must be given. When clearing a buffer the CHANNEL must be
given.
Form:
Command Handler: DPID
TONEHISTORY|THS|TN [CHANNEL] [ARGUMENT] [VALUE]
Argument List:
Terse Verbose Description
NONE TIMENEW Get arrival time of most recent tone to DTMF board in buffer.
NONE TIMEOLD Get arrival time of oldest tone to DTMF board in buffer.
NONE CLEAR Clear contents of buffer to empty or fill with certain character [VALUE].
(valid values are ASCII characters)
Response:
MODIFY TONEHISTORY RESPONSE
Verbose- "OK\r\n" to acknowledge receipt of command, or
"ERROR- [Description]\r\n" if error, ending command
Terse- "0\r\n" to acknowledge receipt of command, or
"[NON-ZERO NUMERIC VALUE]\r\n" if error, ending command
"\r\n" concludes modify responses (empty line)
DISPLAY TONEHISTORY RESPONSE
Verbose- "OK\r\n" to acknowledge receipt of command, followed by
"[ARGUMENT] = [VALUE]\r\n", or
"ERROR- [Description]\r\n" if error, ending command
Terse- "0\r\n" to acknowledge receipt of command, followed by
"[TERSE NUMERIC VALUE]\r\n", or
"[NON-ZERO NUMERIC VALUE]\r\n" if error, ending command
"\r\n" concludes display responses (empty line)
Examples:
Verbose command to retrieve all buffers:
*.DPID TONEHISTORY <enter>
Response is: OK\r\n
Input 0 :*658#658\r\n
Input 1 :*658#658\r\n
Input 2 :*658#658\r\n
{etc...}\r\n
\r\n
Terse command to retrieve all buffers:
*.DPID TH <enter>
Response is: 0\r\n
0 *658#658\r\n
1 *658#658\r\n
2 *658#658\r\n
{etc...}\r\n
\r\n
Verbose command to retrieve buffer contents for a given CHANNEL:
*.DPID TONEHISTORY <CHANNEL> <enter>
Response is: OK\r\n
Input 0 :*658#658\r\n
\r\n
Terse command to retrieve buffer contents for a given CHANNEL:
*.DPID TH <CHANNEL> <enter>
Response is: 0\r\n
1 *658#658\r\n
\r\n
Verbose command to retrieve most recent time of last tone to arrive in buffer for a given CHANNEL:
*.DPID TONEHISTORY <CHANNEL> TIMENEW <enter>
Response is: OK\r\n
Time Newest = Thu 13:24:06.935\r\n
\r\n
Terse command to retrieve most recent time of last tone to arrive in buffer for a given CHANNEL:
*.DPID TH <CHANNEL> TIMENEW <enter>
Response is: 0\r\n
Thu 13:24:06.935\r\n
\r\n
Verbose command to retrieve time of oldest tone remaining in the buffer for a given CHANNEL:
*.DPID TONEHISTORY <CHANNEL> TIMEOLD <enter>
Response is: OK\r\n
Time Oldest = Thu 13:24:06.935\r\n
\r\n
Terse command to retrieve time of oldest tone remaining in the buffer for a given CHANNEL:
*.DPID TH <CHANNEL> TIMEOLD <enter>
Response is: 0\r\n
Thu 13:24:06.935\r\n
\r\n
Verbose command to clear buffer contents for given CHANNEL:
*.DPID TONEHISTORY <CHANNEL> CLEAR <enter>
Response is: OK\r\n
\r\n
Terse command to clear buffer contents for given CHANNEL:
*.DPID TH <CHANNEL> CLEAR <enter>
Response is: 0\r\n
0\r\n
? Verbose command to clear and fill buffer contents with a character VALUE for given CHANNEL:
? *.DPID TONEHISTORY <CHANNEL> CLEAR <VALUE> <enter>
? Response is: OK\r\n
? \r\n
? Terse command to clear and fill buffer contents with a character VALUE for given CHANNEL:
? *.DPID TH <CHANNEL> CLEAR <VALUE> <enter>
? Response is: 0\r\n
? 0\r\n
Notes: