差别

这里会显示出您选择的修订版和当前版本之间的差别。

到此差别页面的链接

两侧同时换到之前的修订记录 前一修订版
后一修订版
前一修订版
后一修订版 两侧同时换到之后的修订记录
cs:400systemintegration:20webhook [2020/02/18 07:17]
candywang
cs:400systemintegration:20webhook [2020/09/09 02:52]
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" ​          //​系统版本
 +            }
 +        ]
     }     }
 } }
行 557: 行 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>​
行 660: 行 822:
 </​code>​ </​code>​
  
 +==== 会话标签变更 ====
  
-==== 视频结束 ====+事件名称:ServiceSessionSummaryEven
  
-事件名称:RtcMediaClosedEvent +触发条件:坐席/管理员 手动 添加/​更改 会话标签,系统自动添加会标签
- +
-触发条件:坐席结束视频通+
  
 消息内容示例: 消息内容示例:
  
-<code json>+系统添加的会话标签: 
 { {
-    ​"​eventId":​ "96791f40-8234-11e7-8522-47871522633a", +  ​"​eventId":​ "ca81ade0-6dc5-11e6-9c13-dfa1eed70626", 
-    "​timestamp": ​1502854804131+  "​timestamp": ​1472460726612
-    "​event":​ "RtcMediaClosedEvent", +  "​event":​ "ServiceSessionSummaryEvent", 
-    "​payload":​ { +  "​payload":​ { 
-        "mediaEntity": {                                               //​视频结束事件的详细信息 +    "serviceSession": { 
-            "session_id": "60e9b15b-8221-4249-ac87-8b53d00cfb43", ​     ​//​视频通话的会话ID +      "id": "4fe1b496-90ac-4412-8f40-0f6a13cbfc4b", 
-            ​"agent_id": ​"​955eee17-4835-4e23-8b19-7e292d12f0e2", ​       //​视频通话中的客服ID +      "​summary_category": ​
-            "​visitor":​+        [ 
-                    "​id":​"​dfe7a557-aa77-443c-b2ec-7a8f93f90f22"​      //​视频通话中的访客ID +          
-                    "nickname":"​webim-visitor-YEPWGBB4TCEYVGCPCJMP", ​  //​视频通中的访客昵称 +            "​id": ​555554
-            }, +            "name": "待接入超时结束会" 
-            "​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", +          ​
-                                                                       //​视频通话中访客端的录像文件 +            "id": ​731840
-            ​}, +            "name": "无效会话
-            "​create_at":​ 1502854803252 ​                                //​视频结束事件的发送时间 +          
-        }+        ] 
 +      ]
     }     }
 +  }
 } }
-</code>+ 
 +坐席/管理员手动添加的会话标签: 
 + 
 +
 +  "​eventId":​ "​ca81ade0-6dc5-11e6-9c13-dfa1eed70626",​ 
 +  "​timestamp":​ 1472460726612,​ 
 +  "​event":​ "​ServiceSessionSummaryEvent",​ 
 +  "​payload":​ { 
 +    "​serviceSession":​ { 
 +      "​id":​ "​4fe1b496-90ac-4412-8f40-0f6a13cbfc4b",​ 
 +      "​actor":​ { 
 +        "​id":​ "​6384ec4b-96ed-4f88-92a9-6f085201e30a",​ 
 +        "​type":​ "​Agent"​ 
 +      }, 
 +      "​summary_category":​ [ 
 +        [ 
 +          { 
 +            "​id":​ 555554, 
 +            "​name":​ "​待接入超时结束会话"​ 
 +          } 
 +        ], 
 +        [ 
 +          { 
 +            "​id":​ 731840, 
 +            "​name":​ "​无效会话"​ 
 +          } 
 +        ] 
 +      ] 
 +    } 
 +  } 
 +
  
 ==== 满意度评价邀请 ==== ==== 满意度评价邀请 ====
行 770: 行 965:
             }             }
         }         }
-    } 
-} 
-</​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>​