推送事件回调接口
前置条件
- 座席已签入
场景描述
座席签入后,采用事件推送模式时,第三方需自行开发接口,用于接收推送的事件消息。
接口方法
设置成“POST”。该接口仅支持POST方法,不支持GET、PUT和DELETE等方法。
接口URI
可参考:
https://ip:port/service-cloud/rest/cc-ai/v1/agentevent/pushresult
其中,ip为第三方服务器地址,port为第三方服务器的HTTPS端口号。
日志中的方法名
pushEvent
请求说明
- 消息头
表1 请求头参数说明 序号
名称
参数类型
是否必选
说明
1
Content-Type
string
True
消息主体编码方式,缺省值:application/json; charset=UTF-8
2
Guid
string
True
静态鉴权(AUTHMODE = 1)签入接口返回的Guid;动态鉴权(AUTHMODE = 2)轮询事件接口返回的Guid。
3
service_token
string
False
自定义,最大长度为50,不能包含特殊字符,否则会返回100-001,建议1分钟动态刷新一次。
- 消息体
表2 消息体参数说明 序号
名称
参数类型
是否必选
说明
1
workNo
string
True
座席工号。
2
eventList
array
True
事件列表。
该对象的参数说明请参见表3。
说明:事件列表按照事件产生顺序,从左往右排列,最新的事件放在最右边。
响应说明
序号 |
名称 |
参数类型 |
说明 |
---|---|---|---|
1 |
message |
string |
描述 |
2 |
retcode |
string |
错误码。取值如下:
|
报文样例
- 消息头
Content-Type:application/json; charset=UTF-8 Guid:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1 service_token:******************
- 请求参数
{ "workNo": "", "eventList": [ { "eventType": "", "workNo": "", "content": "" }, { "eventType": "", "workNo": "", "content": "" } ] }
- 响应参数
{ "message": "success", "retcode": "0" }