获取员工会话消息列表

最后更新：2024/6/4

获取指定员工的指定聊天会话消息列表

请求方式： GET（HTTPS）

请求地址： https://open.wshoto.com/openapi/chat/message/list

参数说明：

参数 类型 必填 说明
access_token string 是 调用接口凭证
userid string 否 企业成员自建userid,当type字段传入具体参数时候,该字段参数会生效
target_id string 否 群聊房间id 或者对方用户id,当type字段传入具体参数时候,该字段参数会生效
type int 否 0:单人会话 1:群聊会话
last_seq int 否 最后一条seq
page_size int 否 列表返回长度。默认值为20，最大值为100
msg_time_start long 否 开始时间,时间戳,精度:秒 开始时间和结束时间必须同时传入或全部不传入
msg_time_end long 否 结束时间,时间戳,精度:秒 开始时间和结束时间必须同时传入或全部不传入

返回值：

{
  "code": 0,
  "msg": "ok",
  "data": {
    "total": 10,
    "records": [
      {
        "msgid": "1",
        "seq": 100,
        "direction": "send",
        "from": "XuJinSheng",
        "from_avatar": "http://p.qlogo.cn/bizmail/IcsdgagqefergqerhewSdage/0",
        "room_id": "wrROPkDQAAA8iGZUBM2_FKpmpYNEBwjQ",
        "tolist": "woROPkDQAA3OKG0GGBWaV4ceG4jetBgQ,GuJunShuo,woROPkDQAAmhGCydWKUuLP5gk2tWMOYw",
        "msgtime": 1608269181797,
        "msgtype": "text",
        "content": "文本消息",
        "msg_content": {
          "content": "这是一条引用/回复消息：\n\"nick\n666\"\n------\n@nick777"
        }
      },
      {
        "msgid": "2",
        "seq": 101,
        "direction": "send",
        "from": "XuJinSheng",
        "from_avatar": "http://p.qlogo.cn/bizmail/IcsdgagqefergqerhewSdage/0",
        "room_id": "wrROPkDQAAA8iGZUBM2_FKpmpYNEBwjQ",
        "tolist": "woROPkDQAA3OKG0GGBWaV4ceG4jetBgQ,GuJunShuo,woROPkDQAAmhGCydWKUuLP5gk2tWMOYw",
        "msgtime": 1608269181797,
        "msgtype": "image",
        "content": null,
        "msg_content": {
          "md5sum": "50de8e5ae8ffe4f1df7a93841f71993a",
          "filesize": 70961,
          "sdkfileid": "CtYBMzA2OTAyMDEwMjA0NjIzMDYwMDIwMTAwMDIwNGI3ZmU0MDZlMDIwMzBmNTliMTAyMDQ1YzliNTQ3NzAyMDQ1YzM3M2NiYzA0MjQ2NjM0MzgzNTM0NjEzNTY1MmQzNDYxMzQzODJkMzQzMTYxNjEyZDM5NjEzOTM2MmQ2MTM2NjQ2NDY0NjUzMDY2NjE2NjM1MzcwMjAxMDAwMjAzMDExNTQwMDQxMDUwZGU4ZTVhZThmZmU0ZjFkZjdhOTM4NDFmNzE5OTNhMDIwMTAyMDIwMTAwMDQwMBI4TkRkZk1UWTRPRGcxTVRBek1ETXlORFF6TWw4eE9UUTVOamN6TkRZMlh6RTFORGN4TWpNNU1ERT0aIGEwNGQwYWUyM2JlYzQ3NzQ5MjZhNWZjMjk0ZTEyNTkz"
        }
      }
    ],
    "sortValues": [37871]
  }
}

返回说明：

参数 类型 说明
code int 出错返回码，为0表示成功，非0表示调用失败
msg string 返回码描述
data Page 分页对象
  total int 总量
  records ChatMessage[] 群聊列表
    msgid string 消息id
    seq long 消息编号
    direction string 消息方向（针对当前 session 的所有者来说），可能值为 \"send\"（发送）或 \"receive\"（接收）
    from string 发送者id，可能是员工id（user_id）或是外部联系人id（external_user_id）
    from_avatar string 发送者头像，分情况下无法获取头像，会为空
    room_id string 所在群聊id，不是群聊中的消息则为空
    tolist string 接收者id，可能是员工id（user_id）或是外部联系人id（external_user_id）,多个以逗号隔开
    msgtime long 消息发送时间
    msgtype string 消息类型，每种消息类型对应一种独特的内容格式
    content string 文字内容，此字段为了方便进行纯文本形式的内容展示
    msg_content Object 消息内容。MsgData是一个泛指，根据消息类型（type）不同其数据结构会不同，具体参考企业微信官方文档
  sortValues object[] 游标

备注

1.seq字段:微盛返回的seq与企业微信会话信息的seq保持一致,seq能保证持续递增,但不保证连续递增.在企业首次拉取全量数据时候,不建议使用seq参数大小与实际拉取数据量大小进行比较判断是否丢失数据.

基础频率

每企业调用不可超过300次/分钟。

results matching ""

    No results matching ""