获取会话消息（企微数据专区）

GET

/open-api/chat_zone/message/list

因企微限制，微伴获取不到数据专区的消息内容，故此接口拉取不到消息内容

请求参数

Query 参数

staff_id

string

员工ext_id

必需

session_id

string

必需

会话session_id

limit

integer

可选

列表长度，默认范围30-100

last_id

integer

可选

返回值message_list中最后一个item的id

access_token

string

调用接口凭证

必需

默认值:

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://open.weibanzhushou.com/open-api/chat_zone/message/list?staff_id=&session_id=&limit=&last_id=&access_token='

返回响应

🟢200成功

application/json

Body

errcode

integer

必需

errmsg

string

必需

message_list

array [object {14}]

必需

created_at

integer

可选

数据创建时间（微伴系统内时间）

direction

string

可选

消息方向（针对当前 session 的所有者来说），可能值为 "send"（发送）或 "receive"（接收）

from_avatar

string

可选

发送者头像，部分情况下无法获取头像，会为空

from_id

string

可选

发送者id，可能是员工id（staff_id）或是外部联系人id（external_user_id）

from_name

string

可选

发送者昵称，和 session 类似，部分情况下无法获取准确昵称，此时会用id拼接的昵称代替

integer

消息id

可选

original_id

string

可选

企业微信原始消息id

room_id

null

可选

所在群聊id，不是群聊数据为空，只有群聊的时候才会返回此字段

session_id

string

可选

对话消息session_id

staff_id

string

员工id

可选

time

integer

可选

消息发送时间（来自企业微信）

to_id

string

可选

接收者id，可能是员工id（staff_id）或是外部联系人id（external_user_id）

type

string

可选

消息类型，每种消息类型对应一种独特的内容格式

updated_at

integer

更新时间

可选

total

integer

剩余消息总数

必需

示例

{
  "errcode": 0,
  "errmsg": "ok",
  "message_list": [
    {
      "created_at": 1731402032,
      "direction": "receive",
      "from_avatar": "http://wx.qlogo.cn/mmhead/00GYaClAoOqxgEfVkc5HvFTtNA7bsR2AX6qp3KUibIEMMP2CopbTIk7k3BS4ia5d1u8vLWx5oY2Bk/0",
      "from_id": "wmgizUDQAAsi8EQ4GgoubUpeTefflTYw",
      "from_name": "eeee",
      "id": 101366131,
      "original_id": "mAAyAsis3UNbi2jXnuEuCtA92amkjU_Zm4Psz7v82Ko90",
      "room_id": null,
      "session_id": "wmgizUDQAAsi8EQ4GgoubUpeTefflTYw",
      "staff_id": "wogizUDQAAtjqS1Lr7zhFG-6dfDa816Q",
      "time": 1731402030,
      "to_id": "wogizUDQAAtjqS1Lr7zhFG-6dfDa816Q",
      "type": "text",
      "updated_at": 1731402032
    }
  ],
  "total": 97
}

🟢200正常返回

修改于 2025-02-13 02:31:15

企业话术列表