Rest 会议管理
会议管理是云通讯平台提供的关于IVR会议的一系列REST API,包括创建会议,解散会议,邀请加入会议,退出会议,静音,取消静音,会议放音,停止会议放音,会议录音,停止会议录音,调节会议音量,会议成员禁听,取消会议成员禁听,会议计时闹钟,会议状态查询,接收会议按鍵等16个接口。开发者在开发会议功能时需实现IVR会议通知的接收,并结合IVR基本命令同时使用,即可实现功能全面的语音会议。
1创建会议
- 注意:会议创建后需要在10分钟内有人加入,否则会议会被自动删除。当会议人有人加入变成无人时,会议自动被删除。创建永久会议只有主动调用会议解散才可以删除会议。
1.1 请求地址
- 注:此接口URL上在拼接sig的同时还需拼接maxmember
- /{SoftVersion}/Accounts/{accountSid}/ivr/createconf?maxmember={maxmember}
1.2 请求包头
- 请参阅统一请求包头,使用主账户进行验证
1.3 请求包体
属性 | 类型 | 约束 | 说明 |
Appid | String | 必选 | 应用Id主节点 |
CreateConf | String | 必选 | 创建会议主节点 |
action | String | 可选 | 相对url,会议创建通知的回调url地址,默认值为空 |
maxmember | String | 可选 | 最大会议人数,不能大于300。默认值为3 |
passwd | String | 可选 | 加入会议密码,默认为空,不需要密码。如果设置了密码,用户在加入会议前会自动提示用户输入密码。目前仅支持直呼会议,检查密码。 |
dtmfreporturl | String | 可选 | 会议DTMF上报通知的回调url地址。默认值为空,只有调用接收会议按键此参数才生效。 |
delreporturl | String | 可选 | 会议被删除通知的回调url地址。默认值为空。 |
confduration | String | 可选 | 此次会议时长单位是秒,小于等于0时则不限时,到时后会议自动结束。第一个成员加入后开始计时,默认值为0 |
autohangup | String | 可选 | 会议自动结束后是否自动挂断用户电话,默认值为false |
confendprompt | String | 可选 | 会议自动结束前的提示音,为空则不播放。默认值为空 |
autorecord | String | 可选 | 是否自动录音,true或false。默认值为false |
quiturl | String | 可选 | 退出会议通知的回调url地址。默认值为空 |
mediaopturl | String | 可选 | 会议媒体控制结果通知的回调url地址。默认值为空 |
autojoin | String | 可选 | 是否自动加入会议。通过IVR响应命令调用时有效。默认为false |
joinurl | String | 可选 | 加入会议通知的回调url地址。默认值为空 |
voiceMod | String | 可选 | 0没有提示音只有背景音、1有加入退出提示音及背景音、2无提示音无背景音、3有提示音无背景音。默认值为1; |
autodelete | String | 可选 | 是否自动删除。默认值为true |
shortconf | String | 可选 | 是否是短会议ID;默认值为true,表示短会议ID;当用户想要创建永久会议则将此参数设置为false,然后将autodelete设置为false即可。 |
autopassword | String | 可选 | 生成通过统一会议接入号加入会议的密码 0:否 1:是 默认0 |
1.4 请求示例
POST /2013-12-26/Accounts/abcdefghijklmnopqrstuvwxyz012345/ivr/createconf?sig=155EAA68C5DFB6B762A42D88F406ABCD&maxmember=5 HTTP/1.1 Accept:application/xml; Host:192.168.0.1:8883 content-length: 139 Content-Type:application/xml;charset=utf-8; Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyMDExNTABCDE= <?xml version='1.0' encoding='utf-8'?> <Request> <Appid>111222333444555666777888</Appid> <CreateConf action="createconfresult.jsp" maxmember="5"/> </Request> |
1.5 响应包体
属性 | 类型 | 约束 | 说明 |
statusCode | String | 必选 | 请求状态码,取值000000(成功),可参考Rest 错误代码。 |
confid | String | 必选 | 会议Id |
voiptoconfid | String | 必选 | 直呼加入的会议Id,用于电话邀请加入会议时呼叫的Id。 |
password | String | 可选 | 呼叫统一会议接入号加入会议时需要输入的密码,当创建会议填写参数autopassword并设置为1时生成。 |
1.6 响应示例
HTTP/1.1 200 OK Content-Length: 641 <?xml version="1.0" encoding="UTF-8" standalone="yes"?> <Response> <statusCode>000000</statusCode> <confid>50001001</confid> <voiptoconfid>conf400123456750001001</voiptoconfid> </Response> |
2 解散会议
2.1 请求地址
- 注:此接口URL上在拼接sig的同时还需拼接confid
- /{SoftVersion}/Accounts/{accountSid}/ivr/conf?confid={confid}
2.2 请求包头
- 请参阅 统一请求包头,使用主账户进行验证
2.3 请求包体
属性 | 类型 | 约束 | 说明 |
Appid | String | 必选 | 应用Id主节点 |
DismissConf | String | 必选 | 解散会议主节点 |
confid | String | 必选 | 会议Id |
action | String | 可选 | 解散会议操作结果通知回调url,默认值为空 |
delurl | String | 可选 | 会议被删除通知的相对url地址,默认值为空 |
autohangup | String | 可选 | 会议自动解散后是否自动挂断用户,true表示挂断,false不挂断。默认值为false |
quiturl | String | 可选 | 解散时参会者退出会议通知的回调url地址。若自动挂断则不发送。默认值为空 |
recordurl | String | 可选 | 录音控制结果通知的回调url地址。默认值为空 |
2.4 请求示例
POST /2013-12-26/Accounts/abcdefghijklmnopqrstuvwxyz012345/ivr/conf?sig=155EAA68C5DFB6B762A42D88F406ABCD&confid=80021234567890 HTTP/1.1 Accept:application/xml; Host:192.168.0.1:8883 content-length: 139 Content-Type:application/xml;charset=utf-8; Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyMDExNTABCDE= <?xml version='1.0' encoding='utf-8'?> <Request> <Appid>111222333444555666777888</Appid> <DismissConf confid="12345678"/> </Request> |
2.5 响应包体
属性 | 类型 | 约束 | 说明 |
statusCode | String | 必选 | 请求状态码,取值000000(成功),可参考Rest 错误代码。 |
2.6 响应示例
HTTP/1.1 200 OK Content-Length: 641 <?xml version="1.0" encoding="UTF-8" standalone="yes"?> <Response> <statusCode>000000</statusCode> </Response> |
3 邀请加入会议
3.1 请求地址
- 注:此接口URL上在拼接sig的同时还需拼接confid
- /{SoftVersion}/Accounts/{accountSid}/ivr/conf?confid={confid}
3.2 请求包头
- 请参阅 统一请求包头,使用主账户进行验证
3.3 请求包体
属性 | 类型 | 约束 | 说明 |
Appid | String | 必选 | 应用Id主节点 |
InviteJoinConf | String | 必选 | 邀请加入会议主节点 |
confid | String | 必选 | 会议Id |
number | String | 必选 | 被邀请者的手机号、座机号或通讯帐号,支持多个号码,用英文#隔开。单次提交最大限制为20个号码。如果邀请自定义方式登录的账号需传sip前缀$自定义账号,sip前缀的获取请联系技术支持。 |
action | String | 可选 | 会议邀请结果通知的回调url地址,默认值为空 |
role | String | 可选 | 加入会议的角色。会议中只有一个主持人,以最后一个为准。0:普通成员,1:主持人,默认值为0 |
speak | String | 可选 | 是否可讲,0:不可讲,1:可讲,默认值为1 |
joinurl | String | 可选 | 加入会议通知的回调url地址 |
joinafteranswer | String | 可选 | 是否接听后加入会议,默认值为true,表示接听后加入,听不到被叫回铃音 |
disnumber | String | 可选 | 被邀请方的显号号码,根据平台侧显号规则控制 |
displayname | String | 可选 | 被邀请方账号是通讯账号的显号号码,根据平台侧显号规则控制 |
3.4 请求示例
POST /2013-12-26/Accounts/abcdefghijklmnopqrstuvwxyz012345/ivr/conf?sig=155EAA68C5DFB6B762A42D88F406ABCD&confid=80021234567890 HTTP/1.1 Accept:application/xml; Host:192.168.0.1:8883 content-length: 139 Content-Type:application/xml;charset=utf-8; Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyMDExNTABCDE= <?xml version='1.0' encoding='utf-8'?> <Request> <Appid>111222333444555666777888</Appid> <InviteJoinConf confid="12345678" number="13800138000"/> </Request> |
3.5 响应包体
属性 | 类型 | 约束 | 说明 |
statusCode | String | 必选 | 请求状态码,取值000000(成功),可参考Rest 错误代码。 |
callSid | String | 必选 | 呼叫Id |
3.6 响应示例
HTTP/1.1 200 OK Content-Length: 641 <?xml version="1.0" encoding="UTF-8" standalone="yes"?> <Response> <statusCode>000000</statusCode> <callSid>1409092132132132132132121</callSid> </Response> |
4 退出会议
4.1 请求地址
- 注:此接口URL上在拼接sig的同时还需拼接confid
- /{SoftVersion}/Accounts/{accountSid}/ivr/conf?confid={confid}
4.2 请求包头
- 请参阅 统一请求包头,使用主账户进行验证
4.3 请求包体
属性 | 类型 | 约束 | 说明 |
Appid | String | 必选 | 应用Id主节点 |
QuitConf | String | 必选 | 退出会议主节点 |
callid | String | 必选 | 呼叫Id |
confid | String | 必选 | 会议Id |
action | String | 可选 | 退出会议通知的回调url地址,默认值为空 |
4.4 请求示例
POST /2013-12-26/Accounts/abcdefghijklmnopqrstuvwxyz012345/ivr/conf?sig=155EAA68C5DFB6B762A42D88F406ABCD&confid=001000000000009 HTTP/1.1 Accept:application/xml; Host:192.168.0.1:8883 content-length: 139 Content-Type:application/xml;charset=utf-8; Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyMDExNTABCDE= <?xml version='1.0' encoding='utf-8'?> <Request> <Appid>111222333444555666777888</Appid> <QuitConf callid ="123456789123456789" confid="12345678"/> </Request> |
4.5 响应包体
属性 | 类型 | 约束 | 说明 |
statusCode | String | 必选 | 请求状态码,取值000000(成功),可参考Rest 错误代码。 |
4.6 响应示例
HTTP/1.1 200 OK Content-Length: 641 <?xml version="1.0" encoding="UTF-8" standalone="yes"?> <Response> <statusCode>000000</statusCode> </Response> |
5 静音
5.1 请求地址
- 注:此接口URL上在拼接sig的同时还需拼接confid
- /{SoftVersion}/Accounts/{accountSid}/ivr/conf?confid={confid}
5.2 请求包头
- 请参阅 统一请求包头,使用主账户进行验证
5.3 请求包体
属性 | 类型 | 约束 | 说明 |
Appid | String | 必选 | 应用Id主节点 |
ConfMute | String | 必选 | 静音主节点 |
callid | String | 必选 | 呼叫Id |
confid | String | 必选 | 会议Id |
action | String | 可选 | 会议媒体控制结果通知的回调url地址,默认值为空 |
5.4 请求示例
POST /2013-12-26/Accounts/abcdefghijklmnopqrstuvwxyz012345/ivr/conf?sig=155EAA68C5DFB6B762A42D88F406ABCD&confid=80021234567890 HTTP/1.1 Accept:application/xml; Host:192.168.0.1:8883 content-length: 139 Content-Type:application/xml;charset=utf-8; Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyMDExNTABCDE= <?xml version='1.0' encoding='utf-8'?> <Request> <Appid>111222333444555666777888</Appid> <ConfMute callid ="123456789123456789" confid="12345678"/> </Request> |
5.5 响应包体
属性 | 类型 | 约束 | 说明 |
statusCode | String | 必选 | 请求状态码,取值000000(成功),可参考Rest 错误代码。 |
5.6 响应示例
HTTP/1.1 200 OK Content-Length: 641 <?xml version="1.0" encoding="UTF-8" standalone="yes"?> <Response> <statusCode>000000</statusCode> </Response> |
6 取消静音
6.1 请求地址
- 注:此接口URL上在拼接sig的同时还需拼接confid
- /{SoftVersion}/Accounts/{accountSid}/ivr/conf?confid={confid}
6.2 请求包头
- 请参阅 统一请求包头,使用主账户进行验证
6.3 请求包体
属性 | 类型 | 约束 | 说明 |
Appid | String | 必选 | 应用Id主节点 |
ConfUnMute | String | 必选 | 取消静音主节点 |
callid | String | 必选 | 呼叫Id |
confid | String | 必选 | 会议Id |
action | String | 可选 | 会议媒体控制结果通知的回调url地址,默认值为空 |
6.4 请求示例
POST /2013-12-26/Accounts/abcdefghijklmnopqrstuvwxyz012345/ivr/conf?sig=155EAA68C5DFB6B762A42D88F406ABCD&confid=80021234567890 HTTP/1.1 Accept:application/xml; Host:192.168.0.1:8883 content-length: 139 Content-Type:application/xml;charset=utf-8; Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyMDExNTABCDE= <?xml version='1.0' encoding='utf-8'?> <Request> <Appid>111222333444555666777888</Appid> <ConfUnMute callid ="123456789123456789" confid="12345678"/> </Request> |
6.5 响应包体
属性 | 类型 | 约束 | 说明 |
statusCode | String | 必选 | 请求状态码,取值000000(成功),可参考Rest 错误代码。 |
6.6 响应示例
HTTP/1.1 200 OK Content-Length: 641 <?xml version="1.0" encoding="UTF-8" standalone="yes"?> <Response> <statusCode>000000</statusCode> </Response> |
7 会议放音
7.1 请求地址
- 注:此接口URL上在拼接sig的同时还需拼接confid
- /{SoftVersion}/Accounts/{accountSid}/ivr/conf?confid={confid}
7.2 请求包头
- 请参阅 统一请求包头,使用主账户进行验证
7.3 请求包体
属性 | 类型 | 约束 | 说明 |
Appid | String | 必选 | 应用Id主节点 |
ConfPlay | String | 必选 | 会议放音主节点 |
confid | String | 必选 | 会议Id |
filename | String | 必选 | 文件名 |
loop | String | 可选 | 循环次数,正整数值,0不播放 -1无限循环,默认值为1 |
action | String | 可选 | 会议媒体控制结果通知的回调url地址。不论成功与失败只要不为空则发送请求 |
playcompleteurl | String | 可选 | 放音完成通知的回调url地址。为空则不发送 |
7.4 请求示例
POST /2013-12-26/Accounts/abcdefghijklmnopqrstuvwxyz012345/ivr/conf?sig=155EAA68C5DFB6B762A42D88F406ABCD&confid=80021234567890 HTTP/1.1 Accept:application/xml; Host:192.168.0.1:8883 content-length: 139 Content-Type:application/xml;charset=utf-8; Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyMDExNTABCDE= <?xml version='1.0' encoding='utf-8'?> <Request> <Appid>111222333444555666777888</Appid> <ConfPlay confid="12345678" filename="song.wav"/> </Request> |
7.5 响应包体
属性 | 类型 | 约束 | 说明 |
statusCode | String | 必选 | 请求状态码,取值000000(成功),可参考Rest 错误代码。 |
7.6 响应示例
HTTP/1.1 200 OK Content-Length: 641 <?xml version="1.0" encoding="UTF-8" standalone="yes"?> <Response> <statusCode>000000</statusCode> </Response> |
8 停止会议放音
8.1 请求地址
- 注:此接口URL上在拼接sig的同时还需拼接confid
- /{SoftVersion}/Accounts/{accountSid}/ivr/conf?confid={confid}
8.2 请求包头
- 请参阅 统一请求包头,使用主账户进行验证
8.3 请求包体
属性 | 类型 | 约束 | 说明 |
Appid | String | 必选 | 应用Id主节点 |
ConfStopPlay | String | 必选 | 停止会议放音主节点 |
confid | String | 必选 | 会议Id |
action | String | 可选 | 会议媒体控制结果通知的回调url地址。不论成功与失败只要不为空则发送请求 |
8.4 请求示例
POST /2013-12-26/Accounts/abcdefghijklmnopqrstuvwxyz012345/ivr/conf?sig=155EAA68C5DFB6B762A42D88F406ABCD&confid=80021234567890 HTTP/1.1 Accept:application/xml; Host:192.168.0.1:8883 content-length: 139 Content-Type:application/xml;charset=utf-8; Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyMDExNTABCDE= <?xml version='1.0' encoding='utf-8'?> <Request> <Appid>111222333444555666777888</Appid> <ConfStopPlay confid="12345678"/> </Request> |
8.5 响应包体
属性 | 类型 | 约束 | 说明 |
statusCode | String | 必选 | 请求状态码,取值000000(成功),可参考Rest 错误代码。 |
8.6 响应示例
HTTP/1.1 200 OK Content-Length: 641 <?xml version="1.0" encoding="UTF-8" standalone="yes"?> <Response> <statusCode>000000</statusCode> </Response> |
9 会议录音
9.1 请求地址
- 注:此接口URL上在拼接sig的同时还需拼接confid
- /{SoftVersion}/Accounts/{accountSid}/ivr/conf?confid={confid}
9.2 请求包头
- 请参阅 统一请求包头,使用主账户进行验证
9.3 请求包体
属性 | 类型 | 约束 | 说明 |
Appid | String | 必选 | 应用Id主节点 |
ConfRecord | String | 必选 | 会议录音主节点 |
confid | String | 必选 | 会议Id |
action | String | 可选 | 会议媒体控制结果通知回调url地址。不论成功与失败只要不为空则发送请求 |
time | String | 可选 | 录音时间,单位为秒。默认值为0,不限时。 |
timeoutrecordurl | String | 可选 | 录音时间到时的录音结果通知的回调url地址,默认值为空 |
9.4 请求示例
POST /2013-12-26/Accounts/abcdefghijklmnopqrstuvwxyz012345/ivr/conf?sig=155EAA68C5DFB6B762A42D88F406ABCD&confid=80021234567890 HTTP/1.1 Accept:application/xml; Host:192.168.0.1:8883 content-length: 139 Content-Type:application/xml;charset=utf-8; Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyMDExNTABCDE= <?xml version='1.0' encoding='utf-8'?> <Request> <Appid>111222333444555666777888</Appid> <ConfRecord confid="12345678"/> </Request> |
9.5 响应包体
属性 | 类型 | 约束 | 说明 |
statusCode | String | 必选 | 请求状态码,取值000000(成功),可参考Rest 错误代码。 |
9.6 响应示例
HTTP/1.1 200 OK Content-Length: 641 <?xml version="1.0" encoding="UTF-8" standalone="yes"?> <Response> <statusCode>000000</statusCode> </Response> |
10 停止会议录音
10.1 请求地址
- 注:此接口URL上在拼接sig的同时还需拼接confid
- /{SoftVersion}/Accounts/{accountSid}/ivr/conf?confid={confid}
10.2 请求包头
- 请参阅 统一请求包头,使用主账户进行验证
10.3 请求包体
属性 | 类型 | 约束 | 说明 |
Appid | String | 必选 | 应用Id主节点 |
ConfStopRecord | String | 必选 | 停止会议录音主节点 |
confid | String | 必选 | 会议Id |
action | String | 可选 | 会议媒体控制结果通知的回调url地址。不论成功与失败只要不为空则发送请求 |
10.4 请求示例
POST /2013-12-26/Accounts/abcdefghijklmnopqrstuvwxyz012345/ivr/conf?sig=155EAA68C5DFB6B762A42D88F406ABCD&confid=80021234567890 HTTP/1.1 Accept:application/xml; Host:192.168.0.1:8883 content-length: 139 Content-Type:application/xml;charset=utf-8; Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyMDExNTABCDE= <?xml version='1.0' encoding='utf-8'?> <Request> <Appid>111222333444555666777888</Appid> <ConfStopRecord confid="12345678"/> </Request> |
10.5 响应包体
属性 | 类型 | 约束 | 说明 |
statusCode | String | 必选 | 请求状态码,取值000000(成功),可参考Rest 错误代码。 |
10.6 响应示例
HTTP/1.1 200 OK Content-Length: 641 <?xml version="1.0" encoding="UTF-8" standalone="yes"?> <Response> <statusCode>000000</statusCode> </Response> |
11 调节会议音量
11.1 请求地址
- 注:此接口URL上在拼接sig的同时还需拼接confid
- /{SoftVersion}/Accounts/{accountSid}/ivr/conf?confid={confid}
11.2 请求包头
- 请参阅 统一请求包头,使用主账户进行验证
11.3 请求包体
属性 | 类型 | 约束 | 说明 |
Appid | String | 必选 | 应用Id主节点 |
ConfVolumeAdjust | String | 必选 | 调节会议音量主节点 |
confid | String | 必选 | 会议Id |
adjusttype | String | 必选 | 增加或减小会议音量。True增加音量 false减小音量 |
action | String | 可选 | 会议媒体控制结果通知的回调url地址。不论成功与失败只要不为空则发送请求 |
11.4 请求示例
POST /2013-12-26/Accounts/abcdefghijklmnopqrstuvwxyz012345/ivr/conf?sig=155EAA68C5DFB6B762A42D88F406ABCD&confid=80021234567890 HTTP/1.1 Accept:application/xml; Host:192.168.0.1:8883 content-length: 139 Content-Type:application/xml;charset=utf-8; Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyMDExNTABCDE= <?xml version='1.0' encoding='utf-8'?> <Request> <Appid>111222333444555666777888</Appid> <ConfVolumeAdjust confid="12345678" adjusttype="true"/> </Request> |
11.5 响应包体
属性 | 类型 | 约束 | 说明 |
statusCode | String | 必选 | 请求状态码,取值000000(成功),可参考Rest 错误代码。 |
11.6 响应示例
HTTP/1.1 200 OK Content-Length: 641 <?xml version="1.0" encoding="UTF-8" standalone="yes"?> <Response> <statusCode>000000</statusCode> </Response> |
12 会议成员禁听
12.1 请求地址
- 注:此接口URL上在拼接sig的同时还需拼接confid
- /{SoftVersion}/Accounts/{accountSid}/ivr/conf?confid={confid}
12.2 请求包头
- 请参阅 统一请求包头,使用主账户进行验证
12.3 请求包体
属性 | 类型 | 约束 | 说明 |
Appid | String | 必选 | 应用Id主节点 |
ConfMemberPause | String | 必选 | 会议成员禁听主节点 |
confid | String | 必选 | 会议Id |
callid | String | 必选 | 呼叫Id |
action | String | 可选 | 会议媒体控制结果通知的回调url地址。默认值为空 |
12.4 请求示例
- 会议成员禁听需通过Play命令播放等待音
POST /2013-12-26/Accounts/abcdefghijklmnopqrstuvwxyz012345/ivr/conf?sig=155EAA68C5DFB6B762A42D88F406ABCD&confid=80021234567890 HTTP/1.1 Accept:application/xml; Host:192.168.0.1:8883 content-length: 139 Content-Type:application/xml;charset=utf-8; Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyMDExNTABCDE= <?xml version='1.0' encoding='utf-8'?> <Request> <Appid>111222333444555666777888</Appid> <ConfMemberPause callid ="123456789123456789" confid="12345678"/> <Play>wait.wav</Play> </ConfMemberPause/> </Request> |
12.5 响应包体
属性 | 类型 | 约束 | 说明 |
statusCode | String | 必选 | 请求状态码,取值000000(成功),可参考Rest 错误代码。 |
12.6 响应示例
HTTP/1.1 200 OK Content-Length: 641 <?xml version="1.0" encoding="UTF-8" standalone="yes"?> <Response> <statusCode>000000</statusCode> </Response> |
13 取消会议成员禁听
13.1 请求地址
- 注:此接口URL上在拼接sig的同时还需拼接confid
- /{SoftVersion}/Accounts/{accountSid}/ivr/conf?confid={confid}
13.2 请求包头
- 请参阅 统一请求包头,使用主账户进行验证
13.3 请求包体
属性 | 类型 | 约束 | 说明 |
Appid | String | 必选 | 应用Id主节点 |
ConfMemberResume | String | 必选 | 取消会议成员禁听主节点 |
confid | String | 必选 | 会议Id |
callid | String | 必选 | 呼叫Id |
action | String | 可选 | 会议媒体控制结果通知的回调url地址。默认值为空 |
speak | String | 可选 | 是否可讲0 不可讲,1 可讲,默认为0 |
13.4 请求示例
POST /2013-12-26/Accounts/abcdefghijklmnopqrstuvwxyz012345/ivr/conf?sig=155EAA68C5DFB6B762A42D88F406ABCD&confid=80021234567890 HTTP/1.1 Accept:application/xml; Host:192.168.0.1:8883 content-length: 139 Content-Type:application/xml;charset=utf-8; Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyMDExNTABCDE= <?xml version='1.0' encoding='utf-8'?> <Request> <Appid>111222333444555666777888</Appid> <ConfMemberResume callid ="123456789123456789" confid="12345678"/> </Request> |
13.5 响应包体
属性 | 类型 | 约束 | 说明 |
statusCode | String | 必选 | 请求状态码,取值000000(成功),可参考Rest 错误代码。 |
13.6 响应示例
HTTP/1.1 200 OK Content-Length: 641 <?xml version="1.0" encoding="UTF-8" standalone="yes"?> <Response> <statusCode>000000</statusCode> </Response> |
14 会议计时闹钟
14.1 请求地址
- 注:此接口URL上在拼接sig的同时还需拼接confid
- /{SoftVersion}/Accounts/{accountSid}/ivr/conf?confid={confid}
14.2 请求包头
- 请参阅 统一请求包头,使用主账户进行验证
14.3 请求包体
属性 | 类型 | 约束 | 说明 |
Appid | String | 必选 | 应用Id主节点 |
ConfAlarmClock | String | 必选 | 会议计时闹钟主节点 |
confid | String | 必选 | 会议Id |
time | String | 必选 | 闹钟计时时长,正整数,单位为秒。 |
action | String | 可选 | 设置会议计时闹钟结果通知的回调url,默认值为空 |
timeraction | String | 可选 | 闹钟到时后的动作类型:0发送通知请求 1播放提示音 2解散会议,默认值为0 |
clockid | String | 可选 | 闹钟标识。若未设置,则采用默认编号,从1开始计编号,命名为ccpclock1 。若设置多个闹钟,但id只有一个,则其余闹钟id也是采用默认编号 |
clockurl | String | 可选 | 会议闹钟到时后通知的请求url地址,使用默认会议通知接口,默认值为alarmclock |
promptfile | String | 可选 | 提示音文件名。 |
autohangup | String | 可选 | 会议自动解散后是否自动挂断用户,true表示挂断,false不挂断 默认false。 |
quiturl | String | 可选 | 会议自动解散但不挂断用户时退出会议通知的回调url。若自动挂断则不发送。默认值为空 |
recordurl | String | 可选 | 录音媒体控制结果通知的回调url,若有录音。 |
delurl | String | 可选 | 会议被删除通知的回调地址 |
14.4 请求示例
POST /2013-12-26/Accounts/abcdefghijklmnopqrstuvwxyz012345/ivr/conf?sig=155EAA68C5DFB6B762A42D88F406ABCD&confid=80021234567890 HTTP/1.1 Accept:application/xml; Host:192.168.0.1:8883 content-length: 139 Content-Type:application/xml;charset=utf-8; Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyMDExNTABCDE= <?xml version='1.0' encoding='utf-8'?> <Request> <Appid>111222333444555666777888</Appid> <ConfAlarmClock time="600" confid="12345678" clockurl ="alarmclock.jsp"/> </Request> |
14.5 响应包体
属性 | 类型 | 约束 | 说明 |
statusCode | String | 必选 | 请求状态码,取值000000(成功),可参考Rest 错误代码。 |
14.6 响应示例
HTTP/1.1 200 OK Content-Length: 641 <?xml version="1.0" encoding="UTF-8" standalone="yes"?> <Response> <statusCode>000000</statusCode> </Response> |
15 会议状态查询
15.1 请求地址
- 注:此接口URL上在拼接sig的同时还需拼接confid
- /{SoftVersion}/Accounts/{accountSid}/ivr/conf?confid={confid}
15.2 请求包头
- 请参阅 统一请求包头,使用主账户进行验证
15.3 请求包体
属性 | 类型 | 约束 | 说明 |
Appid | String | 必选 | 应用Id主节点 |
QueryConfState | String | 必选 | 会议状态查询主节点 |
confid | String | 必选 | 会议Id |
action | String | 可选 | 会议状态通知的回调url地址,默认值为空 |
15.4 请求示例
POST /2013-12-26/Accounts/abcdefghijklmnopqrstuvwxyz012345/ivr/conf?sig=155EAA68C5DFB6B762A42D88F406ABCD&confid=80021234567890 HTTP/1.1 Accept:application/xml; Host:192.168.0.1:8883 content-length: 139 Content-Type:application/xml;charset=utf-8; Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyMDExNTABCDE= <?xml version='1.0' encoding='utf-8'?> <Request> <Appid>111222333444555666777888</Appid> <QueryConfState confid="12345678"/> </Request> |
15.5 响应包体
属性 | 类型 | 约束 | 说明 |
statusCode | String | 必选 | 请求状态码,取值000000(成功),可参考Rest 错误代码。 |
confid | String | 必选 | 会议Id |
state | String | 必选 | 会议状态,0 会议不存在,1 会议存在 |
count | String | 可选 | 当前会议人数 |
createtime | String | 可选 | 会议创建时间 |
15.6 响应示例
HTTP/1.1 200 OK Content-Length: 641 <?xml version="1.0" encoding="UTF-8" standalone="yes"?> <Response> <statusCode>000000</statusCode> <confid>12345678</confid> <state>0</state> <count>3</count> <createtime>20130523181920</createtime> </Response> |
16 接收会议按鍵
16.1 请求地址
- 注:此接口URL上在拼接sig的同时还需拼接confid
- /{SoftVersion}/Accounts/{accountSid}/ivr/conf?confid={confid}
16.2 请求包头
- 请参阅 统一请求包头,使用主账户进行验证
16.3 请求包体
属性 | 类型 | 约束 | 说明 |
confid | String | 必选 | 会议ID |
callid | String | 必选 | 用户呼叫id,指定接收哪个用户的按键。默认值为空,接收所有用户的按键 |
action | String | 可选 | 命令执行结果通知的回调URL,默认值为空 会议DTMF上报通知 |
timeout | String | 可选 | 等待时间 |
finishkey | String | 必选 | 结束符 数字、#、* |
numdigits | String | 可选 | 接收按键个数 正整数,大于0 |
reporturl | String | 可选 | 收键完成通知的回调URL,默认值为confdtmfreport |
promptvoice | String | 可选 | 提示音文件名 |
loop | String | 可选 | 循环次数,正整数值,0不播放 -1无限循环。默认值为1 数字 |
16.4 请求示例
POST /2013-12-26/Accounts/abcdefghijklmnopqrstuvwxyz012345/ivr/conf?sig=155EAA68C5DFB6B762A42D88F406ABCD&confid=80021234567890 HTTP/1.1 Accept:application/xml; Host:192.168.0.1:8883 content-length: 139 Content-Type:application/xml;charset=utf-8; Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyMDExNTABCDE= <?xml version="1.0" encoding="UTF-8"?><Request> <Appid>appid</Appid> <ConfGet confid="8002" callid="4958499394458595000020304394994930223" finishkey="#" numdigits="12"/> </Request> |
16.5 响应包体
属性 | 类型 | 约束 | 说明 |
statusCode | String | 必选 | 请求状态码,取值000000(成功),可参考Rest 错误代码。 |
16.6 响应示例
HTTP/1.1 200 OK Content-Length: 641 <?xml version="1.0" encoding="UTF-8" standalone="yes"?> <Response> <statusCode>000000</statusCode> </Response> |