IVR 会议命令

应用服务器侧向云通讯平台发送的命令,包括创建会议加入会议。会议中其他的会议命令请参考Rest 会议管理,包括退出会议静音取消静音会议放音停止会议放音会议录音停止会议录音调节会议音量、等。

1. 创建会议

  • 创建会议,创建成功结果通知发到action指定的URL地址,创建失败则执行跳转命令,可作为主命令使用。命令名称<CreateConf>。
  • 注意:会议创建后需要在10分钟内有人加入,否则会议会被自动删除。当会议人有人加入变成无人时,会议自动被删除。

属性

名称属性值默认值说明
action
相对URL

会议创建成功的回调URL,创建失败则执行后续副命令中的呼转命令。
maxmember
正整数
3
最大会议人数,不能大于300,大于等于3,默认值为3
dtmfreporturl
相对URL
会议中按键的回调URL
delreporturl
 相对URL

会议被删除的回调URL
autojoin
false or truefalse是否自动加入会议通过IVR响应命令调用时有效默认为false
joinurl相对URL
加入会议成功的回调URL默认值为空
confduration大于0正整数0
此次会议时长单位是秒小于等于0时则不限时,到时后会议自动结束。第一个成员加入后开始计时,默认值为0
autohangupfalse or truefalse会议自动结束后是否自动挂断用户电话,默认值为false
confendprompt文件名
会议自动结束前的提示音,为空则不播放
autorecordfalse or truefalse是否自动录音,true或false。默认值为false
quiturl相对URL
用户退出会议的回调URL。
mediaopturl相对URL会议媒体操作结果通知回调URL。
voicemod0、1、2
1
0没有提示音有背景音、1全部提示音、2无提示音无背景音 默认值为1
autodelete
true or false
true是否自动删除默认值为true
shortconf
true or false
false
是否是短会议ID,表示短会议ID;当用户想要创建永久会议则将此参数设置为false,然后将autodelete设置为false即可。

  • 嵌套规则
  • 示例

  • <?xml version="1.0" encoding="UTF-8"?>
  • <Response>
  •     <CreateConf action="createok"/>
  •     <Redirect>createconffail</Redirect>
  • </Response>
  • 示例说明
    • 主持人会议,普通成员加入是可听不可讲状态,只有主持人加入是可听可讲,自动加入时默认以主持人身份加入,后续人员也以主持人身份加入则前面的主持人自动变为普通成员。

1. 加入会议

  • 加入会议,通过callid参数将用户加入会议。可作为主命,加入失败后执行跳转命令。命令名称<JoinConf>。

属性

名称属性值默认值说明
action
相对URL

加入会议成功通知的回调URL。加入失败则执行后续副命令中的呼转命令。
confid
一个由16位数字、字符组成的串。
必填
会议id
role
0普通成员,1主持人
0
加入会议的角色。会议中只有一个主持人,以最后一个为准
speak
0不可讲,1可讲
1
是否可讲
callid
十六进制串
必填
呼叫id,IVR响应命令中无效
listen
0不可听  1可听
1
是否可听,默认值为1可听

  • 嵌套规则

  • 示例

  • <?xml version="1.0" encoding="UTF-8"?>
  • <Response>
  •     <JoinConf confid="8002" action="joinok"/>
  •     <Redirect>joinconffail</Redirect>
  • </Response>