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

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 参数

access_token

string

调用接口凭证

必需

示例值:

Body 参数application/json

cursor

string

可选

上一次调用时返回的next_cursor，第一次拉取可以不填。不多于64字节

limit

integer <int32>

可选

期望请求的数据量，默认值和最大值都为1000。注意：可能会出现返回条数少于limit的情况，需结合返回的has_more字段判断是否继续请求。

token

string

可选

回调事件返回的token字段，10分钟内有效；可不填，如果不填接口有严格的频率限制。不多于128字节

示例

{
  "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

integer <int32>

可选

msg_list

array [object {7}]

消息列表

可选

external_userid

string

可选

客户UserID（msgtype为event，该字段不返回）

send_time

integer <int32>

消息发送时间

可选

origin

integer <int32>

可选

消息来源。3-微信客户发送的消息 4-系统推送的事件消息 5-接待人员在企业微信客户端发送的消息

msgid

string

消息ID

可选

servicer_userid

string

可选

从企业微信给客户发消息的客服人员userid（msgtype为event，该字段不返回）

open_kfid

string

可选

客服帐号ID（msgtype为event，该字段不返回

msgtype

string

可选

对不同的msgtype，有相应的结构描述，下面进一步说明

next_cursor

string

可选

下次调用带上该值，则从当前的位置继续往后拉，以实现增量拉取。强烈建议对改该字段入库保存，每次请求读取带上，请求结束后更新。避免因意外丢，导致必须从头开始拉取，引起消息延迟。

errmsg

string

可选

has_more

integer <int32>

可选

是否还有更多数据。0-否；1-是。不能通过判断msg_list是否空来停止拉取，可能会出现has_more为1，而msg_list为空的情况

示例

{
  "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
}

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

发送消息

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

概述#

回调事件#

请求参数

示例代码

返回响应

概述

回调事件