差别
这里会显示出您选择的修订版和当前版本之间的差别。
两侧同时换到之前的修订记录 前一修订版 后一修订版 | 前一修订版 后一修订版 两侧同时换到之后的修订记录 | ||
cs:400systemintegration:20webhook [2020/02/18 07:15] candywang |
cs:400systemintegration:20webhook [2020/02/18 07:22] candywang |
||
---|---|---|---|
行 37: | 行 37: | ||
当前支持以下事件的推送: | 当前支持以下事件的推送: | ||
- | * [[#会话结束|会话结束(ServiceSessionClosedEvent)]] | ||
- | * [[#新消息|新消息(ServiceSessionMessageEvent)]] | ||
* [[#创建坐席|创建坐席(AgentUserCreationEvent)]] | * [[#创建坐席|创建坐席(AgentUserCreationEvent)]] | ||
+ | * [[#坐席信息变更|坐席信息变更(AgentUserChangeEvent)]] | ||
* [[#坐席状态变更|坐席状态变更(AgentUserStateChangedEvent)]] | * [[#坐席状态变更|坐席状态变更(AgentUserStateChangedEvent)]] | ||
* [[#坐席登出|坐席登出(AgentUserLogoutEvent)]] | * [[#坐席登出|坐席登出(AgentUserLogoutEvent)]] | ||
行 46: | 行 45: | ||
* [[#删除访客标签|删除访客标签(VisitorTagRemovedEvent)]] | * [[#删除访客标签|删除访客标签(VisitorTagRemovedEvent)]] | ||
* [[#访客信息变更|访客信息变更(VisitorUserChangeEvent)]] | * [[#访客信息变更|访客信息变更(VisitorUserChangeEvent)]] | ||
- | * [[#坐席信息变更|坐席信息变更(AgentUserChangeEvent)]] | + | * [[#访客来源|访客来源(ServiceSessionAttributesCreateEvent,ServiceSessionAttributesChangeEvent)]] |
* [[#会话创建|会话创建(ServiceSessionCreatedEvent)]] | * [[#会话创建|会话创建(ServiceSessionCreatedEvent)]] | ||
+ | * [[#新消息|新消息(ServiceSessionMessageEvent)]] | ||
+ | * [[#待接入会话结束|待接入会话结束(ServiceSessionAbortedEvent)]] | ||
* [[#会话接起|会话接起(ServiceSessionOpenedEvent)]] | * [[#会话接起|会话接起(ServiceSessionOpenedEvent)]] | ||
* [[#会话转接|会话转接(ServiceSessionTransferedEvent)]] | * [[#会话转接|会话转接(ServiceSessionTransferedEvent)]] | ||
- | * [[#待接入会话结束|待接入会话结束(ServiceSessionAbortedEvent)]] | ||
* [[#视频结束|视频结束(RtcMediaClosedEvent)]] | * [[#视频结束|视频结束(RtcMediaClosedEvent)]] | ||
+ | * [[#会话结束|会话结束(ServiceSessionClosedEvent)]] | ||
* [[#访客完成满意度评价|访客完成满意度评价(ServiceSessionEnquiryEvent)]] | * [[#访客完成满意度评价|访客完成满意度评价(ServiceSessionEnquiryEvent)]] | ||
- | * [[#访客来源|访客来源(ServiceSessionAttributesCreateEvent,ServiceSessionAttributesChangeEvent)]] | ||
- | |||
行 287: | 行 286: | ||
"updated_at": 1489387133493 //访客信息更新时间 | "updated_at": 1489387133493 //访客信息更新时间 | ||
} | } | ||
+ | } | ||
+ | } | ||
+ | </code> | ||
+ | |||
+ | ==== 访客来源 ==== | ||
+ | |||
+ | 事件名称:ServiceSessionAttributesCreateEvent | ||
+ | |||
+ | 触发条件:会话创建 | ||
+ | |||
+ | 消息内容示例: | ||
+ | |||
+ | <code json> | ||
+ | { | ||
+ | "eventId": "fb50f590-f4ac-11e9-a28f-75fedd96c02a", | ||
+ | "timestamp": 1571735940126, | ||
+ | "event": "ServiceSessionAttributesCreateEvent", | ||
+ | "payload": { | ||
+ | "tenantId": 20016, | ||
+ | "serviceSessionId": "971c53a2-6302-4002-b6b2-6c484c290ce0", | ||
+ | "entity": [ | ||
+ | { | ||
+ | "name": "carrierOperator", | ||
+ | "value": "ssss35" //运营商 | ||
+ | }, | ||
+ | { | ||
+ | "name": "referer", | ||
+ | "value": "124" //来源信息 | ||
+ | }, | ||
+ | { | ||
+ | "name": "system", | ||
+ | "value": "sssss" //操作系统 | ||
+ | }, | ||
+ | { | ||
+ | "name": "searchType", | ||
+ | "value": null //推广来源 | ||
+ | }, | ||
+ | { | ||
+ | "name": "accessUrl", | ||
+ | "value": null //着陆页 | ||
+ | }, | ||
+ | { | ||
+ | "name": "ip", | ||
+ | "value": null //IP | ||
+ | }, | ||
+ | { | ||
+ | "name": "equipment", | ||
+ | "value": "4444" //设备 | ||
+ | }, | ||
+ | { | ||
+ | "name": "userAgent", | ||
+ | "value": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/77.0.3865.120 Safari/537.36" //软件环境 | ||
+ | }, | ||
+ | { | ||
+ | "name": "region", | ||
+ | "value": null //地区 | ||
+ | }, | ||
+ | { | ||
+ | "name": "keyword", | ||
+ | "value": null //搜索词 | ||
+ | }, | ||
+ | { | ||
+ | "name": "version", | ||
+ | "value": "1.0" //系统版本 | ||
+ | } | ||
+ | ] | ||
+ | } | ||
+ | } | ||
+ | </code> | ||
+ | |||
+ | 事件名称:ServiceSessionAttributesChangeEvent | ||
+ | |||
+ | 触发条件:会话来源修改 | ||
+ | |||
+ | 消息内容示例: | ||
+ | |||
+ | <code json> | ||
+ | { | ||
+ | "eventId": "fb50f590-f4ac-11e9-a28f-75fedd96c02a", | ||
+ | "timestamp": 1571735940126, | ||
+ | "event": "ServiceSessionAttributesChangeEvent", | ||
+ | "payload": { | ||
+ | "tenantId": 20016, | ||
+ | "serviceSessionId": "971c53a2-6302-4002-b6b2-6c484c290ce0", | ||
+ | "entity": [ | ||
+ | { | ||
+ | "name": "carrierOperator", | ||
+ | "value": "ssss35" //运营商 | ||
+ | }, | ||
+ | { | ||
+ | "name": "referer", | ||
+ | "value": "124" //来源信息 | ||
+ | }, | ||
+ | { | ||
+ | "name": "system", | ||
+ | "value": "sssss" //操作系统 | ||
+ | }, | ||
+ | { | ||
+ | "name": "searchType", | ||
+ | "value": null //推广来源 | ||
+ | }, | ||
+ | { | ||
+ | "name": "accessUrl", | ||
+ | "value": null //着陆页 | ||
+ | }, | ||
+ | { | ||
+ | "name": "ip", | ||
+ | "value": null //IP | ||
+ | }, | ||
+ | { | ||
+ | "name": "equipment", | ||
+ | "value": "4444" //设备 | ||
+ | }, | ||
+ | { | ||
+ | "name": "userAgent", | ||
+ | "value": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/77.0.3865.120 Safari/537.36" //软件环境 | ||
+ | }, | ||
+ | { | ||
+ | "name": "region", | ||
+ | "value": null //地区 | ||
+ | }, | ||
+ | { | ||
+ | "name": "keyword", | ||
+ | "value": null //搜索词 | ||
+ | }, | ||
+ | { | ||
+ | "name": "version", | ||
+ | "value": "1.0" //系统版本 | ||
+ | } | ||
+ | ] | ||
} | } | ||
} | } | ||
行 419: | 行 548: | ||
} | } | ||
</code> | </code> | ||
+ | |||
+ | ==== 待接入会话结束 ==== | ||
+ | |||
+ | 事件名称:ServiceSessionAbortedEvent | ||
+ | |||
+ | 触发条件:待接入会话超时自动结束、管理员手动关闭待接入会话 | ||
+ | |||
+ | 消息内容示例: | ||
+ | |||
+ | <code json> | ||
+ | { | ||
+ | "eventId": "4642aae0-a1bb-11e7-bc37-fbf67fe4d942", //事件ID | ||
+ | "timestamp": 1506321136945, //时间戳 | ||
+ | "event": "ServiceSessionAbortedEvent", //事件名称 | ||
+ | "payload": { | ||
+ | "serviceSession": { | ||
+ | "id": "562785f2-aed6-4420-bac5-fb1d2bd82f0e", //会话ID | ||
+ | "state": "Abort", //会话状态 | ||
+ | "origin_type": "webim", //渠道类型,值为app(App渠道)、webim(网页)、weixin(微信)、weibo(微博)、phone(呼叫中心)、rest(rest API渠道) | ||
+ | "abort_actor": { //会话结束方信息 | ||
+ | "user_id": "946f116d-2e09-410c-9015-4b480edc9939", //坐席ID | ||
+ | "user_name": "260553619@qq.com", //坐席登录邮箱地址 | ||
+ | "nice_name": "Admin" //坐席昵称 | ||
+ | }, | ||
+ | "timestamp": { | ||
+ | "create": 1506320908000, //会话创建时间 | ||
+ | "start": 1506321136000, //会话接起时间 | ||
+ | "stop": 1506321136000 //会话结束时间 | ||
+ | }, | ||
+ | "channel": { | ||
+ | "id": 10625, //关联ID | ||
+ | "type": "easemob" //关联类型 | ||
+ | }, | ||
+ | "visitor": { | ||
+ | "id": "678c9d67-f2f1-498f-a458-6f3fbf223a64", //系统内部访客ID | ||
+ | "name": "webim-visitor-RXFC9WR4KRG8FMK98PCY" //访客ID | ||
+ | }, | ||
+ | "agent_queue": { | ||
+ | "id": 39005 //会话所属技能组ID | ||
+ | } | ||
+ | } | ||
+ | } | ||
+ | } | ||
+ | </code> | ||
+ | |||
==== 会话接起 ==== | ==== 会话接起 ==== | ||
行 512: | 行 686: | ||
} | } | ||
} | } | ||
+ | } | ||
+ | </code> | ||
+ | |||
+ | ==== 视频结束 ==== | ||
+ | |||
+ | 事件名称:RtcMediaClosedEvent | ||
+ | |||
+ | 触发条件:坐席结束视频通话 | ||
+ | |||
+ | 消息内容示例: | ||
+ | |||
+ | <code json> | ||
+ | { | ||
+ | "eventId": "96791f40-8234-11e7-8522-47871522633a", | ||
+ | "timestamp": 1502854804131, | ||
+ | "event": "RtcMediaClosedEvent", | ||
+ | "payload": { | ||
+ | "mediaEntity": { //视频结束事件的详细信息 | ||
+ | "session_id": "60e9b15b-8221-4249-ac87-8b53d00cfb43", //视频通话的会话ID | ||
+ | "agent_id": "955eee17-4835-4e23-8b19-7e292d12f0e2", //视频通话中的客服ID | ||
+ | "visitor":{ | ||
+ | "id":"dfe7a557-aa77-443c-b2ec-7a8f93f90f22", //视频通话中的访客ID | ||
+ | "nickname":"webim-visitor-YEPWGBB4TCEYVGCPCJMP", //视频通话中的访客昵称 | ||
+ | }, | ||
+ | "url":{ | ||
+ | "agent":"https://kefu-media-files.oss-cn-beijing.aliyuncs.com/MS_X133600273164668928C2632M2__CH_VIDEO_1_C2632__VIDEO.webm?Expires=9223372036854775&OSSAccessKeyId=LTAI3pBwoxnmCWUw&Signature=VtkixMtyf9S4jPhLeCvyheEhc4k%3D", | ||
+ | //视频通话中客服端的录像文件 | ||
+ | "visitor":"https://kefu-media-files.oss-cn-beijing.aliyuncs.com/MS_X133600273164668928C2632M4__CH_VIDEO_3_C2632__VIDEO.webm?Expires=9223372036854775&OSSAccessKeyId=LTAI3pBwoxnmCWUw&Signature=gFfY11vIakftWpOmm8TdlYzkuAg%3D", | ||
+ | //视频通话中访客端的录像文件 | ||
+ | }, | ||
+ | "create_at": 1502854803252 //视频结束事件的发送时间 | ||
+ | } | ||
+ | } | ||
} | } | ||
</code> | </code> | ||
行 615: | 行 822: | ||
</code> | </code> | ||
- | ==== 待接入会话结束 ==== | ||
- | 事件名称:ServiceSessionAbortedEvent | ||
- | |||
- | 触发条件:待接入会话超时自动结束、管理员手动关闭待接入会话 | ||
- | |||
- | 消息内容示例: | ||
- | |||
- | <code json> | ||
- | { | ||
- | "eventId": "4642aae0-a1bb-11e7-bc37-fbf67fe4d942", //事件ID | ||
- | "timestamp": 1506321136945, //时间戳 | ||
- | "event": "ServiceSessionAbortedEvent", //事件名称 | ||
- | "payload": { | ||
- | "serviceSession": { | ||
- | "id": "562785f2-aed6-4420-bac5-fb1d2bd82f0e", //会话ID | ||
- | "state": "Abort", //会话状态 | ||
- | "origin_type": "webim", //渠道类型,值为app(App渠道)、webim(网页)、weixin(微信)、weibo(微博)、phone(呼叫中心)、rest(rest API渠道) | ||
- | "abort_actor": { //会话结束方信息 | ||
- | "user_id": "946f116d-2e09-410c-9015-4b480edc9939", //坐席ID | ||
- | "user_name": "260553619@qq.com", //坐席登录邮箱地址 | ||
- | "nice_name": "Admin" //坐席昵称 | ||
- | }, | ||
- | "timestamp": { | ||
- | "create": 1506320908000, //会话创建时间 | ||
- | "start": 1506321136000, //会话接起时间 | ||
- | "stop": 1506321136000 //会话结束时间 | ||
- | }, | ||
- | "channel": { | ||
- | "id": 10625, //关联ID | ||
- | "type": "easemob" //关联类型 | ||
- | }, | ||
- | "visitor": { | ||
- | "id": "678c9d67-f2f1-498f-a458-6f3fbf223a64", //系统内部访客ID | ||
- | "name": "webim-visitor-RXFC9WR4KRG8FMK98PCY" //访客ID | ||
- | }, | ||
- | "agent_queue": { | ||
- | "id": 39005 //会话所属技能组ID | ||
- | } | ||
- | } | ||
- | } | ||
- | } | ||
- | </code> | ||
- | |||
- | ==== 视频结束 ==== | ||
- | |||
- | 事件名称:RtcMediaClosedEvent | ||
- | |||
- | 触发条件:坐席结束视频通话 | ||
- | |||
- | 消息内容示例: | ||
- | |||
- | <code json> | ||
- | { | ||
- | "eventId": "96791f40-8234-11e7-8522-47871522633a", | ||
- | "timestamp": 1502854804131, | ||
- | "event": "RtcMediaClosedEvent", | ||
- | "payload": { | ||
- | "mediaEntity": { //视频结束事件的详细信息 | ||
- | "session_id": "60e9b15b-8221-4249-ac87-8b53d00cfb43", //视频通话的会话ID | ||
- | "agent_id": "955eee17-4835-4e23-8b19-7e292d12f0e2", //视频通话中的客服ID | ||
- | "visitor":{ | ||
- | "id":"dfe7a557-aa77-443c-b2ec-7a8f93f90f22", //视频通话中的访客ID | ||
- | "nickname":"webim-visitor-YEPWGBB4TCEYVGCPCJMP", //视频通话中的访客昵称 | ||
- | }, | ||
- | "url":{ | ||
- | "agent":"https://kefu-media-files.oss-cn-beijing.aliyuncs.com/MS_X133600273164668928C2632M2__CH_VIDEO_1_C2632__VIDEO.webm?Expires=9223372036854775&OSSAccessKeyId=LTAI3pBwoxnmCWUw&Signature=VtkixMtyf9S4jPhLeCvyheEhc4k%3D", | ||
- | //视频通话中客服端的录像文件 | ||
- | "visitor":"https://kefu-media-files.oss-cn-beijing.aliyuncs.com/MS_X133600273164668928C2632M4__CH_VIDEO_3_C2632__VIDEO.webm?Expires=9223372036854775&OSSAccessKeyId=LTAI3pBwoxnmCWUw&Signature=gFfY11vIakftWpOmm8TdlYzkuAg%3D", | ||
- | //视频通话中访客端的录像文件 | ||
- | }, | ||
- | "create_at": 1502854803252 //视频结束事件的发送时间 | ||
- | } | ||
- | } | ||
- | } | ||
- | </code> | ||
==== 满意度评价邀请 ==== | ==== 满意度评价邀请 ==== | ||
行 768: | 行 900: | ||
} | } | ||
} | } | ||
- | } | ||
- | } | ||
- | </code> | ||
- | |||
- | ==== 访客来源 ==== | ||
- | |||
- | 事件名称:ServiceSessionAttributesCreateEvent | ||
- | |||
- | 触发条件:会话创建 | ||
- | |||
- | 消息内容示例: | ||
- | |||
- | <code json> | ||
- | { | ||
- | "eventId": "fb50f590-f4ac-11e9-a28f-75fedd96c02a", | ||
- | "timestamp": 1571735940126, | ||
- | "event": "ServiceSessionAttributesCreateEvent", | ||
- | "payload": { | ||
- | "tenantId": 20016, | ||
- | "serviceSessionId": "971c53a2-6302-4002-b6b2-6c484c290ce0", | ||
- | "entity": [ | ||
- | { | ||
- | "name": "carrierOperator", | ||
- | "value": "ssss35" //运营商 | ||
- | }, | ||
- | { | ||
- | "name": "referer", | ||
- | "value": "124" //来源信息 | ||
- | }, | ||
- | { | ||
- | "name": "system", | ||
- | "value": "sssss" //操作系统 | ||
- | }, | ||
- | { | ||
- | "name": "searchType", | ||
- | "value": null //推广来源 | ||
- | }, | ||
- | { | ||
- | "name": "accessUrl", | ||
- | "value": null //着陆页 | ||
- | }, | ||
- | { | ||
- | "name": "ip", | ||
- | "value": null //IP | ||
- | }, | ||
- | { | ||
- | "name": "equipment", | ||
- | "value": "4444" //设备 | ||
- | }, | ||
- | { | ||
- | "name": "userAgent", | ||
- | "value": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/77.0.3865.120 Safari/537.36" //软件环境 | ||
- | }, | ||
- | { | ||
- | "name": "region", | ||
- | "value": null //地区 | ||
- | }, | ||
- | { | ||
- | "name": "keyword", | ||
- | "value": null //搜索词 | ||
- | }, | ||
- | { | ||
- | "name": "version", | ||
- | "value": "1.0" //系统版本 | ||
- | } | ||
- | ] | ||
- | } | ||
- | } | ||
- | </code> | ||
- | |||
- | 事件名称:ServiceSessionAttributesChangeEvent | ||
- | |||
- | 触发条件:会话来源修改 | ||
- | |||
- | 消息内容示例: | ||
- | |||
- | <code json> | ||
- | { | ||
- | "eventId": "fb50f590-f4ac-11e9-a28f-75fedd96c02a", | ||
- | "timestamp": 1571735940126, | ||
- | "event": "ServiceSessionAttributesChangeEvent", | ||
- | "payload": { | ||
- | "tenantId": 20016, | ||
- | "serviceSessionId": "971c53a2-6302-4002-b6b2-6c484c290ce0", | ||
- | "entity": [ | ||
- | { | ||
- | "name": "carrierOperator", | ||
- | "value": "ssss35" //运营商 | ||
- | }, | ||
- | { | ||
- | "name": "referer", | ||
- | "value": "124" //来源信息 | ||
- | }, | ||
- | { | ||
- | "name": "system", | ||
- | "value": "sssss" //操作系统 | ||
- | }, | ||
- | { | ||
- | "name": "searchType", | ||
- | "value": null //推广来源 | ||
- | }, | ||
- | { | ||
- | "name": "accessUrl", | ||
- | "value": null //着陆页 | ||
- | }, | ||
- | { | ||
- | "name": "ip", | ||
- | "value": null //IP | ||
- | }, | ||
- | { | ||
- | "name": "equipment", | ||
- | "value": "4444" //设备 | ||
- | }, | ||
- | { | ||
- | "name": "userAgent", | ||
- | "value": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/77.0.3865.120 Safari/537.36" //软件环境 | ||
- | }, | ||
- | { | ||
- | "name": "region", | ||
- | "value": null //地区 | ||
- | }, | ||
- | { | ||
- | "name": "keyword", | ||
- | "value": null //搜索词 | ||
- | }, | ||
- | { | ||
- | "name": "version", | ||
- | "value": "1.0" //系统版本 | ||
- | } | ||
- | ] | ||
} | } | ||
} | } | ||
</code> | </code> |