# 获取聊天记录

调试工具

接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南

接口英文名:getMsgList

本接口用于获取客服聊天记录。

返回的聊天记录中,对于图片、语音、视频,分别展示成文本格式的[image]、[voice]、[video]。对于较可能包含重要信息的图片消息,后续将提供图片拉取URL

1.查询时间段不能超过24小时 2.每次最多获取10000条记录

# 1. 调用方式

# HTTPS 调用

POST https://api.weixin.qq.com/customservice/msgrecord/getmsglist?access_token=ACCESS_TOKEN

# 云调用

  • 本接口不支持云调用

# 第三方调用

  • 本接口支持第三方平台代商家调用。

  • 该接口所属的权限集 id 为:1、6、19、100-101

  • 服务商获得其中之一权限集授权后,可通过使用 authorizer_access_token 代商家进行调用,具体可查看 第三方调用 说明文档。

# 2. 请求参数

# 查询参数 Query String parameters

参数名类型必填说明
access_tokenstring接口调用凭证,可使用 access_tokenauthorizer_access_token

# 请求体 Request Payload

# 3. 返回参数

# 返回体 Response Payload

参数名类型说明
recordlistobjarray消息内容
numbernumber消息数量
msgidnumber消息id

# Res.recordlist(Array) Object Payload

消息内容

参数名类型说明
openidstring用户openid
opercodenumber操作码,2002(客服发送信息),2003(客服接收消息)
textstring聊天记录
timenumber操作时间
workerstring完整客服账号,格式为:账号前缀@公众号微信号

# 4. 注意事项

本接口无特殊注意事项

# 5. 代码示例

请求示例

{
  "starttime": 1464710400,
  "endtime": 1464796800,
  "msgid": 1,
  "number": 10000
}

返回示例

{
  "recordlist": [
    {
      "openid": "oDF3iY9WMaswOPWjCIp_f3Bnpljk",
      "opercode": 2002,
      "text": "您好,客服test1为您服务。",
      "time": 1464710500,
      "worker": "test1@test"
    }
  ],
  "number": 10000,
  "msgid": 20165258
}

# 6. 错误码

以下是本接口的错误码列表,其他错误码可参考 通用错误码

错误码错误描述解决方案
65400please enable new custom service or wait for a while if you have enabled没有开通或升级到新版客服功能
65416param invalid  please check查询参数不合法
65417it is too long from the starttime to endtime查询时间段超出限制

# 7. 适用范围

本接口在不同账号类型下的可调用情况:
小程序公众号服务号小游戏
仅认证 仅认证
  • ✔:该账号可调用此接口
  • 仅认证:表示仅允许企业主体已认证账号调用,未认证或不支持认证的账号无法调用
  • 其他未明确声明的账号类型,如无特殊说明,均不可调用此接口;