IVR 坐席通知消息
- 云通讯平台向应用服务器侧发送的请求通知，包括座席状态通知、座席操作结果通知、用户进入排队成功通知、用户退出排队通知、座席与用户通话结束通知、用户与座席通话结束后的录音完成通知、座席外呼用户应答通知、队列排队人数溢出通知、班长监听结束通知、座席外呼用户振铃通知、用户输入数据通知等。
1. 座席状态通知
- 当座席的状态发生变化后，云平台会向应用服务器侧发送此请求消息，其中“agentstate”相对url地址段是固定内容不可变。
- 请求地址
- POST /agentstate?appid={appid}&callid={callid}&agentid={agentid}&agentstate={agentstate}&number={number}&time={time}&queuetype={queuetype}&alertingtime={alertingtime}&isqueue={isqueue} HTTP/1.1
- 请求参数
| 参数名 | 类型 | 说明 |
| agentid | 整数 | 座席ID，4位正整数，由应用侧管理。 |
| agentstate | 整数 | 座席状态：0坐席准备中不能接电话 ；1坐席准备就绪可以接听来电； 2坐席锁定中，锁定中是云通讯平台在转接到坐席的时候先对坐席进行锁定操作，以避免其他用户呼入后分配到同一个坐席； 3坐席通话中不能接听其他来电；4座席线路忙，如果用云通讯的网络坐席可能是坐席不在线或者占线中，如果用落地电话则是在占线中(占线中不是通过云通讯平台的坐席进行呼叫)。默认值为0。</span> |
| callid | 字符串 | 用户呼叫id，当座席状态agentstate为2、3、由3变为0时，此值不为空。默认值为空。 |
| time | 字符串 | 状态切换时间，yyyymmddHHmiss。 |
| queuetype | 整数 | 用户排队类型，当agentstate变为2、3时此值有效。只有呼入进入排队制定队列时为有效值，坐席外呼和进入排队制定坐席时无效为默认值0。 |
| number | 整数 | 与座席通话的用户号码，当状态为2、3时值有效。 |
| appid | 字符串 | 应用id。 |
| alertingtime | 日期串 | 座席振铃时间，格式yyyymmddHHmiss，agentstate值为3时此参数有效 |
| isqueue | 0、1 | 是否有排队，agentstate值为2时此参数有效；0表示未排队、1表示有排队 |
- 请求回复
- 可回复空指令。当座席状态为“准备中”时，AS侧可根据实际设置座席状态自动切换为“准备就绪”，此时可复座席准备就绪命令，让座席立刻进入准备接电话的状态中。
2. 座席操作结果通知
- 请求地址
- POST /<customurl>?appid={appid}&agentid={agentid}&type={type}&reason={reason}&time={time} HTTP/1.1
- 请求参数
| 参数名 | 类型 | 说明 |
| agentid | 整数 | 座席ID，4位正整数。 |
| type | 整数 | 操作类型1班长监听、2呼叫转接、3准备就绪、4座席咨询、5呼叫转移、6咨询反回、7三方通话、8用户静音操作、9取消静音操作、10 座席主动外呼、11座席内呼、12|强插、13强拆、14 获取用户数据。 |
| result | 整数 | 0表示成功，其它值则失败。 |
| callid | 十六进制串 | 用户的callid。 |
| appid | 字符串 | 应用id。 |
| time | 字符串 | 操作时间；type值为1、2、4、5、6、7、8、9、10、11、12、13时有效。 |
- 请求回复
- 回复空指令。
3. 用户进入排队成功通知
- 座席呼叫转接时用户进入排队队列的通知请求。URL中“<customurl>”可通过<Transfer>命令中的enterurl属性自定义
- 请求地址
- POST /<customurl>?appid={appid}&callid={callid}&queuetype={queuetype}&count={count}&entertime={entertime} HTTP/1.1
- 请求参数
| 参数名 | 类型 | 说明 |
| callid | 字符串 | 一个由32位数字、字符组成的唯一呼叫标识符。 |
| queuetype | 整数 | 用户进入的队列类型。 |
| count | 整数 | 进入后当前队列的排队人数。 |
| entertime | 字符串 | 进入队列的时间,yyyymmddHHmiss。 |
| appid | 必须 | 应用id |
- 请求回复
- 回复空指令。
4. 用户退出排队通知
- 座席呼叫转接当排队超时用户选择退出队列时发送此请求消息。URL中“<customurl>”可通过<Transfer>命令中的quiturl属性自定义
- 请求地址
- POST /<quitccs>?appid={appid}&callid={callid}&type={type}&queuetype={queuetype}&count={count}&quittime={quittime} HTTP/1.1
请求参数
| 参数名 | 类型 | 说明 |
| callid | 字符串 | 一个由32位数字、字符组成的唯一呼叫标识符。 |
| type | 整数 | 退出排队类型：0超时主动退出 1达到最大排队次数强制退出 2用户挂机退出 3用户转接坐席正常退出 |
| queuetype | 整数 | 退出队列的类型。 |
| count | 整数 | 退出后队列当前的排队人数。 |
| quittime | 字符串 | 退出队列的时间，yyyymmddHHmiss |
| appid | 必须 | 应用id |
- 请求回复
- 可回复其它IVR命令，进入相关的业务逻辑。
5. 座席与用户通话结束通知
- 当调用座席结束通话命令或座席或用户挂机，云平台会向应用侧发送此通知请求，成功结束，应用侧可以回复其它IVR命令。当非用户挂机时，进入后续的业务逻辑，座席结束通话命令失败则用户与座席的通话将继续，URL中“<customurl>”可通过用户进入排队命令中的agenthangupurl属性自定义。
- 请求地址
- POST /<customurl>?appid={appid}&callid={callid}&agentid={agentid}&duration={duration}&recordurl={recordurl}&endtype={endtype} HTTP/1.1
- 请求参数
| 参数名 | 类型 | 说明 |
| callid | 字符串 | 一个由32位数字、字符组成的唯一呼叫标识符。 |
| agentid | 整数 | 与其通话的座席id。 |
| endtime | 字符串 | 用户与座席通话结束时间,格式：yyyymmddHHmiss。 |
| endtype | 整数 | 通话结束类型：0座席结束通话、1座席挂机、2强拆结束、3用户挂机、4咨询反回结束通话、5座席咨询后转移呼叫、6座席转接呼叫、7咨询过程中咨询侧主动挂机、8咨询过程中用户挂机。 |
| recordurl | 字符串 | 录音下载地址。 |
| appid | 字符串 | 应用id。 |
- 请求回复
- 可回复其它IVR命令，进入相关的业务逻辑。
6. 用户与座席通话结束后的录音完成通知
- 用户进入排队或座席呼叫转接命令中座席与用户通话结束后，云通讯平台向应用侧发送此通知。URL中“<customurl>”可通过<EnterCCS>或<Transfer>命令中的recordurl属性自定义
- 请求地址
- POST /<customurl>?appid={appid}&callid={callid}&agentid={agentid}&duration={duration}&recordurl={recordurl} HTTP/1.1
- 请求参数
| 参数名 | 类型 | 说明 |
| callid | 字符串 | 一个由32位数字、字符组成的唯一呼叫标识符。 |
| agentid | 整数 | 与其通话的座席id。 |
| duration | 整数 | 用户与座席通话时长。 |
| recordurl | 字符串 | 录音文件下载地址。 |
| appid | 必须 | 应用id |
- 请求回复
- 回复空指令。
7. 座席外呼用户应答通知
- 座席主动外呼用户，当用户接听后云平台会向AS侧发送此通知。
- 请求地址
- POST /<customurl>?appid={appid}&callid={callid}&agentid={agentid}&number={number} HTTP/1.1
- 请求参数
| 参数名 | 类型 | 说明 |
| callid | 字符串 | 一个由32位数字、字符组成的唯一呼叫标识符。 |
| agentid | 整数 | 与其通话的座席id。 |
| appid | 必须 | 应用id |
| number | 用户号码 | 手机号码，座机号码或者通讯账号 |
- 请求回复
- 回复空指令。
8. 队列排队人数溢出通知
- 用户进入排队时，若队列已经达到最大等待人数，且设置了后会发出此通知。URL中“<customurl>”可通过<EnterCCS>命令中的overflowurl属性自定义
- 请求地址
- POST /<customurl>?appid={appid}&callid={callid}&queuetype={queuetype} HTTP/1.1
- 请求参数
| 参数名 | 类型 | 说明 |
| callid | 字符串 | 一个由32位数字、字符组成的唯一呼叫标识符。 |
| queuetype | 整数 | 队列类型。 |
| appid | 必须 | 应用id。 |
- 请求回复
- 回复空指令。
9. 班长监听结束通知
- 座席班长监听时班长挂机后会收到此通知请求。URL中“<customurl>”可通过<Monitor>命令中的notifyurl属性自定义
- 请求地址
- POST /<customurl>?appid={appid}&callid={callid}&agentid={agentid} HTTP/1.1
- 请求参数
| 参数名 | 类型 | 说明 |
| callid | 字符串 | 一个由32位数字、字符组成的唯一呼叫标识符。 |
| agentid | 整数 | 与其通话的座席id。 |
| appid | 必须 | 应用id |
- 请求回复
- 回复其它IVR命令，让用户执行后续业务流程。
10. 座席外呼用户振铃通知
- 座席外呼用户或座席后，当被叫有回音铃音时发送此通知，URL中“<customurl>”可通过坐席外呼中的action属性设置
- 请求地址
- POST /<customurl>?appid={appid}&callid={callid}&agentid={answertime}&answertime={answertime} HTTP/1.1
- 请求参数
| 参数名 | 类型 | 说明 |
| callid | 字符串 | 一个由32位数字、字符组成的唯一呼叫标识符。 |
| agentid | 整数 | 与其通话的座席id。 |
| appid | 必须 | 应用id |
| answertime | 字符串 | 应答时间。 |
- 请求回复
- 回复空指令。
11. 用户输入数据通知
- 座席调用命令获取用户输入数据<GetUserData＞命令后发送此通知。
- 请求地址
- POST /<customurl>?appid={appid}&callid={callid}&agentid={answertime}&data={data}&type={type}&downloadurl={downloadurl}&result={result} HTTP/1.1
- 请求参数
| 参数名 | 类型 | 说明 |
| callid | 字符串 | 一个由32位数字、字符组成的唯一呼叫标识符。 |
| agentid | 整数 | 与其通话的座席id。 |
| appid | 必须 | 应用id |
| data | 字符串 | 用户按键内容。 |
| type | 整数 | 0按键内容。 |
| result | 字符串 | 0正常；1 按键超时。 |
- 请求回复
- 回复IVR空命令。