1.1. 拉取会话存档接口

该接口用于拉取会话存档信息

1.1.1. 请求方法

POST api/v1/getChatRecord 注:获取会话记录内容不能超过3天,如果企业需要全量数据,则企业需要定期拉取聊天消息。

1.1.2. 请求参数

参数 是否必须 说明
corpId 企业微信corp_id
seq 本次请求获取消息记录开始的seq值。首次访问填写0,非首次使用上次企业微信返回的最大seq。允许从任意seq重入拉取。
limit 一次调用限制的limit值,不能超过1000.

1.1.3. 入参示例

{
    "corp_id":"wxxxxxxxxxxx078",
    "seq":0,
    "limit":1000
}

1.1.4. 返回数据

属性名 类型 说明
errcode 整型 0表示成功,错误返回非0错误码,需要参看errmsg。
errmsg 字符串 返回信息,如非空为错误原因。
chatdata 对象数组 聊天记录数据内容。数组类型。包括seq、msgid等内容
- seq 整型 消息的seq值,标识消息的序号。再次拉取需要带上上次回包中最大的seq。
- msgid 字符串 消息id,消息的唯一标识,企业可以使用此字段进行消息去重。msgid以_external结尾的消息,表明该消息是一条外部消息。 msgid以_updown_stream结尾的消息,表明该消息是一条上下游消息。
- publickey_ver 整型 加密此条消息使用的公钥版本号。
- encrypt_chat_msg 字符串 消息密文。
- msg 对象 针对不同的消息格式,所对应的对象内容不同,具体参考各个消息类型

1.1.5. 返回示例

{
  "errcode": 0,
  "errmsg": "ok",
  "chatdata": [
    {
      "seq": 196,
      "msgid": "CAQQ2fbb4QUY0On2rYSAgAMgip/yzgs=",
      "publickey_ver": 3,
      "msg": {
        "msgid": "CAQQluDa4QUY0On2rYSAgAMgzPrShAE=",
        "action": "send",
        "from": "XuJinSheng",
        "tolist": [
          "icefog"
        ],
        "roomid": "",
        "msgtime": 1547087894783,
        "msgtype": "text",
        "text": {
          "content": "test"
        }
      }
    }
  ]
}

results matching ""

    No results matching ""