Asterisk1.4 AGI Command 翻译（一）

AGI Command Reference

                                                                   中文版

                                                                              

ANSWER

用  法：ANSWER

说  明：接通处于未接通状态的通道。

返回值：

-1      失败

0       成功

                                                                              

CHANNEL STATUS

用  法：CHANNEL STATUS [channel_name]

说  明：查看通道状态。通道名可以指定，若不指定，则默认当前通道。

返回值：

0       通道未使用，并可用

1       通道未使用，已预订

2       通道挂断

3       通道正被拨打

4       通道（线路）正响铃

5       通道（线路）正在使用

6       通道（线路）正忙

                                                                              

DATABASE DEL

用  法：DATABASE DEL <family> <key>

说  明：从Asterisk数据库中删除指定字段和行的记录。

返回值：

0       失败

1       成功

                                                                              

DATABASE DELTREE

用  法：DATABASE DELTREE <family> [keytree]

说  明：从Asterisk数据库中删除指定字段和行序列的记录

返回值：

0       失败

1       成功

                                                                               

 

 

 

DATABASE GET

用  法：DATABASE GET <family> <key>

说  明：从Asterisk数据库中取得指定字段和行的记录

返回值：

0       无结果集

1       (结果集)

                                                                              

DATABASE PUT

用  法：DATABASE PUT <family> <key> <value>

说  明：Asterisk数据库中，在指定的字段和行的位置插入值。

返回值：

0       失败

1       成功

                                                                              

EXEC

用  法：EXEC application oprions

说  明：执行指定Asterisk拨号方案的application(应用)，optopms是application(应用)的参数。

返回值：

-2      未能找到指定的应用

value 返回应用的值

例  子：EXEC Dial Zap/g1/123456

EXEC Dial "IAX2/alice|20"

                                                                              

GET DATA

用  法：GET DATA filename [timeout] [max_digits]

说  明：播放由filename参数指定的音频文件，同时接收DTMF(双音多频)的键值。接收键值个数由

max_digits参数决定。与拨号方案应用Backgroud()类似。

返回值：拨打按键值

                                                                              

GET FULL VARIABLE

用  法：GET FULL VARIABLE variablename [channelname]

说  明：取得变量值。此命令支持复杂变量和内置变量。variablename参数指定变量名，channelname可   选，指定通道名。

返回值：

0       无指定通道，或变量未设置。

1(value)     取得的变量值，放在value的位置。

                                                                              

 

 

 

GET OPTION

用  法：GET OPTION <filename> <escape_digits> [timeout]

说  明：功能和STREAM FILE相同，只是增加了timeout超时选项。可以设置超时时间，时间以秒为单位。

返回值：十进制表示的DTMF键值的ASCII码值。

                                                                              

GET VARIABLE

用  法：GET VARIABLE <variablename>

说  明：取得变量值。此命令不支持复杂变量和内置变量。variablename参数指定变量名。

返回值：

0       无指定通道，或变量未设置。

1(value)     取得的变量值，放在value的位置。

                                                                              

HANGUP

用  法：HANGUP [channelname]

说  明：挂断当前通道，或挂断指定的通道。

返回值：

-1      指定的通道不存在

1       挂断成功

                                                                               

NoOp

用  法：NoOp [text]

说  明：执行空操作。可以通过text参数向Asterisk控制台打印信息。此命令通常用于调试目的。

返回值：

0       无通道，或变量为设置

                                                                              

RECEIVE CHAR

用  法：RECEIVE CHAR <timeout>

说  明：接收一个通道上的文本字符。指定一个毫秒为单位的超时时间作为等待输入的最大时长，或者设置“0”做无限时等待接收。注意大多数通道时不支持文本接收。

返回值：

-1(hangup)          接收失败，或通道挂断

char(timeout)     超时

十进制表示的字符ASCII码值

                                                                              

 

 

 

 

 

RECORD FILE

用  法：RECORD FILE <filename> <format> <escape_digits> <timeout> [offset_samples] [BEEP] [s=<silence>]

说  明：将通道上的音频录到指定的文件(filename)中。escape_digits参数是结束录音的DTMF键值，通常为#号键。format参数是指定录音文件的格式，可以是wav，gsm等。timeout参数是以毫秒为单位的录音的持续时间，也可设置“-1”为无超时时间。offset_samples参数可选，限制录音文件大小。BEEP参数可选，给用用一个“哔”开始录音提示。s=<silence>参数可选，当没有设置escape_digits和timeout参数时，设置这个值，静音几秒停止录音。silence参数单位为妙，前面要加“s=”。

返回值：

-1      失败

0       成功录音

                                                                              

SAY ALPHA

用  法：SAY ALPHA <number> <escape_digits>

说  明：反复诵读一个给定的数字，直到按下设定的推出DTMF键后停止。

返回值：

-1      错误或挂断

0       不带退出键的完整回放

         十进制表示的已按键值的ASCII码值

                                                                              

SAY DATE

用  法：SAY DATE <date> <escape_digits>

说  明：反复诵读一个给定的日期，直到按下设定的推出DTMF键后停止。这里的date参数是协调世界时

UTC。

返回值：

-1      错误或挂断

0       不带退出键的完整回放

         十进制表示的已按键值的ASCII码值

                                                                              

SAY DATETIME

用  法：SAY DATETIME <datetime> <escape_digits> [format] [timezone]

说  明：反复诵读一个给定的日期时间，直到按下设定的推出DTMF键后停止。这里的date参数是协调世界时UTC。format参数可选，规定诵读格式(详见voicemail.conf 中对此参数的完整描述)。此参数默认为”AbdY ‘digits/at’ IMp”。timezone参数可选，参数值设定可以查看/usr/share/zoneinfo/。此参数默认值为Asterisk服务器的时区。

返回值：

-1      错误或挂断

0       不带退出键的完整回播

         十进制表示的已按键值的ASCII码值

                                                                               

 

SAY DIGITS

用  法：SAY DIGITS <number> <escape_digits>

说  明：反复诵读一个给定的数字串，直到按下设定的推出DTMF键后停止。

返回值：

-1      错误或挂断

0       不带退出键的完整回播

         十进制表示的已按键值的ASCII码值

                                                                              

SAY NUMBER

用  法：SAY NUMBER <number> <escape_digits>

说  明：反复诵读一个给定的号码，直到按下设定的推出DTMF键后停止。

返回值：

-1      错误或挂断

0       不带退出键的完整回播

         十进制表示的已按键值的ASCII码值

                                                                              

SAY PHONETIC

用  法：SAY PHONETIC <string> <escape_digits>

说  明：反复诵读字符串(根据音标法则来诵读，即不是一个个字符读出来)，直到按下设定的推出DTMF键后停止。

返回值：

-1      错误或挂断

0       不带退出键的完整回播

         十进制表示的已按键值的ASCII码值

                                                                              

SAY TIME

用  法：SAY TIME <time> <escape_digits>

说  明：反复诵读指定的时间，直到按下设定的推出DTMF键后停止。

返回值：

-1      错误或挂断

0       不带退出键的完整回播

         十进制表示的已按键值的ASCII码值

                                                                              

SEND IMAGE

用  法：SEND IMAGE <image>

说  明：在当前通道上发送给定的图片，图片名不带扩展名。大多数通道不支持图片传输。

返回值：

-1      错误或挂断

0       图片已发送，或者通道不支持发送图片

                                                                               

SEND TEXT

用  法：SEND TEXT <“text_to_send”>

说  明：在当前通道上发送给定的文本，大多数通道不支持文本传输。传输的文本写在引号之间。

返回值：

-1      错误或挂断

0       文本已发送，或者通道不支持发送文本