接收消息和事件-读取消息

POST

http://127.0.0.1/cgi-bin/kf/sync_msg

最后修改时间：2022-08-30 03:03:37

责任人：未设置

概述

当微信客户、接待人员发消息或有行为动作时，企业微信后台会将事件的回调数据包发送到企业指定URL；企业收到请求后，再通过读取消息接口主动读取具体的消息内容。

回调事件

接收并解析事件的方法见：接收事件。
示例

<xml>   <ToUserName><![CDATA[ww12345678910]]></ToUserName>   <CreateTime>1348831860</CreateTime>   <MsgType><![CDATA[event]]></MsgType>   <Event><![CDATA[kf_msg_or_event]]></Event>   <Token><![CDATA[ENCApHxnGDNAVNY4AaSJKj4Tb5mwsEMzxhFmHVGcra996NR]]></Token></xml>

说明

参数	说明
ToUserName	企业微信CorpID
CreateTime	消息创建时间，unix时间戳
MsgType	消息的类型，此时固定为：event
Event	事件的类型，此时固定为：kf_msg_or_event
Token	调用拉取消息接口时，需要传此token，用于校验请求的合法性

读取消息
微信客户发送的消息、接待人员在企业微信回复的消息、发送消息接口发送失败事件（如被用户拒收）、客户点击菜单消息的回复消息，可以通过该接口获取具体的消息内容和事件。不支持读取通过发送消息接口发送的消息。
支持的消息类型：文本、图片、语音、视频、文件、位置、链接、名片、小程序、菜单、事件。

权限说明:
企业需要使用“微信客服”secret所获取的accesstoken来调用（accesstoken如何获取？）
第三方应用需具有“微信客服权限->管理帐号、分配会话和收发消息”权限

文档ID: 31078
原文档地址：
https://open.work.weixin.qq.com/api/doc/90000/90135/94670
https://open.work.weixin.qq.com/api/doc/90001/90143/94699

请求参数

Query 参数

Body 参数application/json

示例

{
    "cursor": "4gw7MepFLfgF2VC5npN",
    "token": "ENCApHxnGDNAVNY4AaSJKj4Tb5mwsEMzxhFmHVGcra996NR",
    "limit": 1000
}

请求示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location -g --request POST 'http://127.0.0.1/cgi-bin/kf/sync_msg?access_token={{accesstoken}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "cursor": "4gw7MepFLfgF2VC5npN",
    "token": "ENCApHxnGDNAVNY4AaSJKj4Tb5mwsEMzxhFmHVGcra996NR",
    "limit": 1000
}'

返回响应

🟢200成功

application/json

Body

示例

{
    "errcode": 0,
    "msg_list": [
        {
            "external_userid": "string",
            "send_time": 0,
            "origin": 0,
            "msgid": "string",
            "servicer_userid": "string",
            "open_kfid": "string",
            "msgtype": "string"
        }
    ],
    "next_cursor": "string",
    "errmsg": "string",
    "has_more": 0
}

修改于 2022-08-30 03:03:37

分配客服会话-变更会话状态

发送消息

接收消息和事件-读取消息

概述#

回调事件#

请求参数

请求示例代码

返回响应

概述

回调事件