openapi‐chat‐records

聊天记录接口

通过API获取聊天记录接口

• URL：https://api.nxcloud.com/saas/openapi/chat/records?page_number={page_number}&page_size={page_size}&tenant_id={tenant_id}&appkey={appkey}&saas_conversation_id={dimension}&channel={channel}
• Method：GET
• Content-Type：application/json
• 需要鉴权：是

请求参数

header参数：

参数名	类型	必选	示例值	说明
accessKey	String	是	fme2na3kdi3ki	用户身份标识
ts	String	是	1655710885431	当前请求的时间戳（单位是毫秒），牛信服务端允许用户端请求最大时间误差为60秒
bizType	String	是	2	WhatsApp业务类型，取固定值“2”
action	String	是	mt	WhatsApp业务操作，取固定值“mt”
sign	String	是	6e9506557d1f289501d333ee2c365826	API入参参数签名，公共约定

parameter 参数：

参数名	类型	必选	示例值	说明
tenant_id	Long	是	1	租户ID
appkey	String	是	pem28kje	应用appkey
page_number	integer	是	1	页数
page_size	integer	是	10	每页个数,最大100
saas_conversation_id	String	是	会话ID	会话ID
channel	integer	是	渠道	2：WhatsApp 目前只支持2

返回参数说明

参数名	类型	说明
list	array[data JsonObject]	请求结果
message	string	请求结果说明
code	integer	结果编码
total	integer	列表总数量
page_number	integer	页数
page_size	integer	每页数量

data

参数名	类型	说明
id	String	消息记录ID
channel	integer	2 whatsapp
user_channel_id	String	商户唯一标识符,例如WhatsApp商户号码
from	String	发送方
to	String	接收方
customer_id	String	客户ID
customer_name	String	客户名称
user_id	String	坐席ID
user_name	String	坐席名称
chat_type	integer	消息方向 0下行 1上行 2系统消息
message_type	String	消息类型
content	String	消息内容
created_at	String	创建时间
updated_at	String	更新时间

响应示例

{
  "code": 0,
  "message": null,
  "traceId": "ee0e74276ff14dd58c43512c92ed9958.316.17223233548652651",
  "total": 4,
  "page_number": 1,
  "page_size": 10,
  "list": [
    {
      "id": "1184532473820278785",
      "channel": 2,
      "user_channel_id": "155xxx2740",
      "from": "852xxxx4115",
      "to": "155xxxx2740",
      "customer_id": "11845xxxxx4289152",
      "customer_name": "空格键",
      "user_id": "708",
      "user_name": "[email protected]",
      "chat_type": 1,
      "message_type": "text",
      "content": "你好",
      "created_at": "2025-10-13 16:29:09",
      "updated_at": "2025-10-13 16:29:09"
    }
  ],
  "ext": null,
  "empty": false,
  "notEmpty": true,
  "totalPages": 4
}

响应码说明

code	message	解决办法
0	请求成功
-1	请求失败	请联系技术人员排除问题
1000~100X	鉴权问题	详情查看API鉴权部分
21058	参数异常	tenant_id 必填
21059	参数异常	appkey必填
22016	参数异常	商户未配置WhatsApp应用
22072	参数异常	参数错误异常