文档首页/ 云客服/ API参考/ 网页客户端接入/ 集成开发/ 多媒体消息交谈场景中使用的接口/ 查询历史消息 (queryHistoryChatMessage)
更新时间：2025-03-07 GMT+08:00
查看PDF
分享

查询历史消息 (queryHistoryChatMessage)

场景描述

用户接入座席后，可按照渠道查询该用户与座席交谈的历史消息记录。可选择查询的消息数量或者根据时间段查询。

接口方法

POST

接口URI

https://域名/apiaccess/ccmessaging/queryHistoryChatMessage，例如域名是service.besclouds.com

请求说明

表1 请求头参数

序号

名称

参数类型

是否必选

说明

1

x-app-key

string

True

appKey字段，用户标识

2

Authorization

string

True

鉴权字段，内容格式为：Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格）

3

ccmessaging-token

string

True

applyToken接口生成的ccmessaging-token
表2 请求体参数

序号

名称

参数类型

是否必选

说明

1.1

channelId

string

True

渠道标识

1.2

userId

string

True

渠道下发送消息的用户ID。取值范围：1到24位字符串。

1.3

startTime

string

False

查询历史消息开始时间

1.4

endTime

string

False

查询历史消息结束时间

1.5

limit

string

True

分页参数，查询历史消息数量

1.6

offset

string

True

分页参数，偏移量

1.7

channel

string

True

客户端已发送消息所属渠道类型，如WEB(WEB客服接入渠道)

响应说明

  • 响应状态码: 200
表3 响应体参数

序号

名称

参数类型

说明

1.1

messageList

array

查询到的历史消息集合

1.1

resultCode

string

0：成功

1：失败

1.2

resultDesc

string

响应返回描述
  • 响应状态码: 400

    错误的请求：请检查请求路径及参数。

  • 响应状态码: 401

    未授权：1.请确认是否购买了相关服务。2.请联系客服人员检查您账号的当前状态。

  • 响应状态码: 404

    请求的内容未找到：请检查请求的路径。

  • 响应状态码: 500

    业务失败：请依次确认您请求中各参数的取值。

错误码

无。

报文样例

  • 场景描述：查询历史消息

    URL：https://域名/apiaccess/ccmessaging/queryHistoryChatMessage

    请求头:

    {
	"ccmessaging-token": "eyJjcmVhdGVUaW1lI********************************IiwiY2hhbm5lbElkIjoiMjAyMTAyMTkzMTk2ODY5NzA4In0%3D",
	"x-app-key": "ea5c29a3-ea45-4b79-a449-2a3dbeb4c32c",
	"Authorization": "Bearer 57042f85****************8c4e0",
	"Content-Type": "application/json"
}
    请求参数: 
    {
        "channelId":"202207292843442389",
        "userId":"1659490221026188522",
        "limit":"1",
        "offset":"0",
        "startTime":"1659910093000",
        "endTime":"1659938956000",
        "channel":"WEB"
}

    响应参数:

    {
        "messageList": [
            {
                "id": "10113293212986888",
                "channel": "WEB",
                "senderNickname": "wangming77",
                "senderAvatar": "../../image/user1.png",
                "sendTime": 1659938956000,
                "receiveTime": 1659938956000,
                "controlType": "CHAT",
                "sourceType": "USER",
                "mediaType": "FILE",
                "content": "diaoyu.aac,26964,fee53aad-94a0-4dc2-b7ff-fd8c2e2496f2,aac",
                "callId": "1659938875-16806492",
                "messageCode": "67A257B0DB5EFBC08C9F2BD612443F09BBF858570A62CCAAB8D3CE45B7C0EFD0",
                "associationContentId": null,
                "sendStatus": null,
                "errorMsg": null,
                "isForwarded": false,
                "forwardTime": null,
                "contentDealType": null
             }
        ],
        "resultCode": "0",
        "resultDesc": "success"
}