查询语音菜单
该API用于查询语音菜单的相关信息,如:配置参数(语音文件、拨号检测长度、按键检查结束符)、转接到该菜单的呼叫信息等。
请求示例
<?xml version="1.0" encoding="utf-8" ?>
<Control attribute="Query">
<menu id="1"/>
</Control>
参数说明
参数名称 | 类型 | 参数说明 | 参数值说明 |
---|---|---|---|
<menu id> | int | 语音菜单的编号 | 1~50,值为空表示列举所有语音菜单 |
响应示例
<?xml version="1.0" encoding="utf-8" ?>
<Status>
<menu id="1">
<voicefile>welcome</voicefile>
<repeat>3</repeat>
<infolength>5</infolength>
<exit>#</exit>
<outer id="44" from="200" to="02167103750" trunk="02161208234"/>
<visitor id="46" from="13012345678" to="02161204000"/>
</menu>
</Status>
解释:来电13012345678和去电02167103750被转接到语音菜单1内,该菜单向它们播放名称为welcome的语音文件。另外,如果通话方的拨号按键长度达到5,或者输入了#号时,则OM会将该按键信息封装在DTMF事件报告中推送给应用服务器。
注:如果当前没有任何呼叫被转接到该菜单,响应包体中将携带XML注释字段:<!-- Empty Waiting List -->,属正常现象。
参数说明
说明:<>表示必选项,[]表示可选项(当参数值为默认值或空时,响应消息可能不携带该参数)
参数名称 | 类型 | 说明 |
---|---|---|
<menu id> | int | 语音菜单的编号,用于查询、配置、转接等操作的判断依据。 |
[voicefile] | string | 语音文件,当呼叫转接到该菜单并接通后,OM会向通话方播放该文件。(只支持dat和pcm格式。) |
[repeat] | int | 语音文件的播放次数,取值范围 0~50,值为0时循环播放。 |
[infolength] | int | 拨号检测长度,当按键长度达到该长度时,OM则将已统计到的按键信息 (DTMF事件)推送给应用服务器,并重新开始统计。 |
[exit] | char | 按键检查结束符,当该菜单的通话方一旦拨了该字符后,OM会立刻将已统计到的按键信息 (DTMF事件)推送给应用服务器,并重新开始统计。 |
[visitor] | object | 来电(从中继呼入的通话),这里指被转接到该语音菜单中的来电 |
<id> | int | 来电的编号:用于查询、转接、挂断等操作的判断依据。 |
<from> | string | 原始主叫号码 |
<to> | string | 原始被叫号码(对于visitor而言,原始被叫为该visitor呼入OM的中继) |
<callid> | int | 通话的相对唯一标识符(注: 其值会循环利用,不可作为永久标识) |
[outer] | object | 去电(从中继呼出的通话),这里指被转接到该语音菜单中的去电 |
<id> | int | 去电的编号,用于查询、转接、挂断等操作的判断依据。 |
<from> | string | 原始主叫号码 |
<to> | string | 原始被叫号码(对于visitor而言,原始被叫为该visitor呼入OM的中继) |
<trunk> | string | 中继号,这里指该路通话通过该中继线路呼出 |
<callid> | int | 通话的相对唯一标识符(注: 其值会循环利用,不可作为永久标识) |