IVR 会议通知消息

云通讯平台向应用服务器发送的请求消息,包括会议创建通知加入会议通知退出会议通知会议DTMF上报通知会议邀请结果通知会议媒体控制结果通知会议被删除通知设置(取消)会议计时闹钟结果通知会议状态通知会议闹钟到时后通知解散会议操作结果通知等。

1. 会议创建通知

会议创建成功会发送此请求,URL中<createconfsucc>可通过<CreateConf>命令中的action属性自定义

请求地址

  • POST /<createconfsucc>?appid={appid}&callid={callid}&confid={confid}&createtime={createtime} HTTP/1.1

请求参数

参数名约束说明
callid
必须
创建会议的用户callid, 一个由32位数字、字符组成的唯一通话标识符,若由RestAPI创建的会议此参数为空。
confid
必须
一个由4-8位数字组成标识符。
createtime
必须
会议创建时间,格式yyyymmddhhmm
appid
必须
应用id

2. 加入会议通知

云平台会向应用服务器侧发送此请求消息,包括创建会议加入会议邀请加入会议操作通知。 URL中<custom>可通过<JoinConf>命令中的action属性和<CreateConf>、<InviteJoinConf>命令中的joinurl属性自定义。当<JoinConf>、<InviteJoinConf>命令中有action或joinurl属性,则回调joinurl配置的地址,否则回调<CreateConf>命令中的joinurl属性地址。

请求地址

  • POST /<custom>?appid={appid}&callid={callid}&confid={confid}&jointime={jointime} HTTP/1.1

请求参数

参数名约束说明
callid
必须
一个由32位数字、字符组成的唯一标识符。
confid
必须加入会议的会议id。
jointime
必须
加入会议时间,格式yyyymmddhhmm
number
可选
手机号、座机号或通讯帐号
appid
必须
应用id

3. 退出会议通知

退出会议后会发送此请求,包括在创建会议退出会议都有此通知。URL中<quitconfsucc>可通过<QuitConf>命令中的action属性和<CreateConf>指令中的quiturl属性自定义。当<QuitConf>命令中有action属性,则回调action配置的地址,否则回调<CreateConf>命令中的quiturl属性地址。

请求地址

  • POST /<quitconfsucc>?appid={appid}&callid={callid}&quittime={quittime} HTTP/1.1

请求参数

参数名约束说明
callid
必须
一个由32位数字、字符组成的唯一标识符。
quittime
必须
退出会议时间,格式yyyymmddhhmm。
confid
必须
会议id
appid
必须
应用id

4. 会议DTMF上报通知

向应用服务器上报用户在会议中按键,在创建会议中配置此URL。URL中<customurl>可通过<CreateConf>命令中的dtmfreporturl属性自定义

请求地址

  • POST /<customurl>?appid={appid}&confid={confid}&callid={callid}&digits={digits} HTTP/1.1

请求参数

参数名约束说明
callid
必须
一个由32位数字、字符组成的唯一标识符。
confid
必须
会议id。
digits
必须
用户按键内容。
appid
必须
应用id

5. 会议邀请结果通知

应用服务器侧发起邀请加入会议消息后,结果通过此请求通知应用服务器,和startservice通知消息意义相同。但当用户结束通话后会有stopservice通知消息。URL中custom可通过<InviteJoinConf>命令中的action属性自定义。

请求地址

  • POST /<custom>?appid={appid}&callid={callid}&confid={confid}&result={result}&number={number} HTTP/1.1

请求参数

参数名约束说明
callid
可选
被邀请者呼叫id。result=0时callid才有效。
jointime
可选
加入会议时间,格式yyyymmddhhmm。
confid
必须
 会议ID。
result
必须
操作结果。 0成功 ,其它值为失败。
number
可选
被邀请者号码。
appid
必须
应用id

6. 会议媒体控制结果通知

云平台会向应用服务器侧发送此请求消息,包括静音取消静音会议放音停止会议放音会议录音停止会议录音调节会议音量会议成员禁听取消会议成员禁听创建会议操作通知。当应用服务器侧调用<ConfPlay>、<ConfStopPlay>、<ConfRecord>、<ConfstopRecord>、<ConfVolumeAdjust> 、<ConfMute>、<ConfUnMute>、<ConfMemberPause>、<ConfMemberResume>命令时,若属性action有内容则会上报结果事件,在<CreateConf>命令中的mediaopturl属性也可以设置此回调地址。当发起以上命令(除了创建会议)时,若有action属性,则回调action配置的地址,否则回调<CreateConf>命令中的mediaopturl属性地址。

请求地址

  • POST /<coustom>?appid={appid}&confid={confid}&callid={callid}&notifytype={notifytype}&result={result}&state={state}&recordurl={recordurl}&recordduration={recordduration} HTTP/1.1

请求参数

参数名约束说明
confid
必须
会议ID。
callid
可选
呼叫id。对参会者操作时值有效。
notifytype
必须
操作类型 1放音、2录音、3调大音量、4静音5禁听6收键;11停止放音、12停止录音、13调小音量、14取消静音、15取消禁听。
result
必须
 操作结果。 0成功 ,其它值为失败。
state
可选
会议或用户状态,空值或0无意义。只有result为0时此值才有意义。
会议状态:1放音中、2录音中、11放音完成、12录音完成。
用户状态:4静音、14取消静音5禁听、15取消禁听、6收键中,callid有值有效。
recordurl
可选
录音文件下载地址当notifytype=12、result=0、state=12时,此参数才有内容。
recordduration
可选
录音时长。
appid
必须
应用id

7. 会议被删除通知

当会议中的最一个人退出会议后,会议被自动删除,包括创建会议解散会议操作时会发此请求通知应用侧服务器。URL中<delreporturl>可通过<DismissConf>、<CreateConf> 命令中的delurl属性自定义。当<DismissConf>命令中有delurl属性,则回调delurl配置的地址,否则回调<CreateConf>命令中的delurl属性地址。

请求地址

  • POST /<delreporturl>?appid={appid}&confid={confid}&deltime={deltime}&recordurl={recordurl} HTTP/1.1

请求参数

参数名约束说明
confid必须
一个由4-8位数字组成的标识符
deltime
必须
会议被删除时间,格式yyyymmddhhmm。
appid必须应用id

8. 设置(取消)会议计时闹钟结果通知

设置计时闹钟成功或失败结果会发送此请求。URL中<customurl>可通过<ConfAlarmClock>命令中的action属性自定义

请求地址

  • POST /<customurl>?appid={appid}&confid={confid}&status={status}&time={time}&clockid={clockid} HTTP/1.1

请求参数

参数名约束说明
confid
必须
一个由4-8位数字组成的标识符。
status
必须
结果值0成功,其它值为失败。
appid必须
应用id
time必须
闹钟时长,以秒为单位。若有多个以%23分隔
clockid必须
闹钟时长,以秒为单位。若有多个以%23分隔

9. 会议状态通知

查询会议状态后发送的通知请求。URL中<customurl>可通过<QueryConfState>命令中的action属性自定义

请求地址

  • POST /<customurl>?appid={appid}&confid={confid}&count={count}&createtime={createtime}&state={state} HTTP/1.1

请求参数

参数名约束说明
confid
必须
会议ID,一个由4-8位数字组成的标识符。
count
可选
当前会议人数。
createtime
可选
会议创建时间,格式yyyymmddhhmm。
state
必须
当前会议状态0会议解散,其它值参考会议媒体控制结果通知参数。
appid
必须
应用id

10. 会议闹钟到时后通知

设置计时闹钟时间到后发送的通知请求,URL中<custom>可通过<ConfAlarmClock>命令中的clockurl属性自定义。

请求地址

  • POST /<customurl>?appid={appid}&confid={confid}&clockid={clockid} HTTP/1.1

请求参数

参数名约束说明
confid
必须
会议ID,一个由4-8位数字组成的标识符。
clockid必选由数字字母组成的字符串。
appid必须应用id

11. 解散会议操作结果通知

  • POST /<customurl>?appid={appid}&confid={confid}&status={status} HTTP/1.1

请求参数

参数名约束说明
confid
必须
一个由4-8位数字组成的标识符。
status
必须
结果值0成功,其它值为失败。
appid必须
应用id