查询历史消息 (queryHistoryChatMessage)

1

x-app-key

string

True

appKey字段，用户标识

2

Authorization

string

True

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

3

ccmessaging-token

string

True

applyToken接口生成的ccmessaging-token

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客服接入渠道)

1.1

messageList

array

True

查询到的历史消息集合

1.1.1

id

string

True

会话消息ID

1.1.2

channel

string

True

渠道名称，例如WEB,WECHAT,FACEBOOK

1.1.3

channelConfigId

string

True

渠道ID

1.1.4

userId

string

True

渠道下客户的唯一标识

1.1.5

senderNickname

string

False

消息发送者的昵称，如果是客户发的，就是客户的昵称；如果是座席发的，就是座席的昵称。

1.1.6

senderAvatar

string

False

消息发送者的头像

1.1.7

sendTime

timestamp

True

消息发生时间

1.1.8

receiveTime

timestamp

False

用户发送消息到达时间

1.1.9

controlType

string

False

消息控制类型，如连接（CONNECT），聊天(CHAT)，转人工（TRANS2AGENT），用户输入中（INPUT），断开连接(DISCONNECT)，已读（READ）

1.1.10

sourceType

string

False

消息发送方来源，如人工座席（AGENT）、机器人（ROBOT）、系统（SYSTEM）

1.1.11

mediaType

string

False

消息媒体类型，如文本类型（TEXT），图片类型（IMAGE），音频类型（AUDIO），视频类型（VIDEO），文件类型（FILE），文件图片（FILE_IMAGE），文件视频（FILE_VIDEO），网页卡片消息（WEBCARD）

1.1.12

content

string

False

消息内容，视mediaType而定，例如mediaType是TEXT，content就是发送的文本内容，文本内容大小不能超过1K；如果是音视频等媒体，content是fileId，mediaType，fileId为/ccmessaging/uploadFileStream接口返回的objectKey，具体入参为"field，mediaType"，如图片为"objectKey，jpg"，视频为"objectKey，mp4"，音频为"objectKey，mp3"，位置为"objectKey，txt"，文件下载接口会使用此fileId做文件下载用。

如果mediaType值为WEBCARD，content的值为JSON结构转换的字符串，例如JSON固定结构如下：

{"title":"卡片标题"，"description":"卡片描述"，"mediaFileId":"卡片媒体文件ID，通过upload接口返回"，"mediaFileType":"当前仅支持固定值img，img/png，img/jpg，不填类型默认按jpg"，"redirectUrl":"跳转地址"

}，其中redirectUrl和mediaFileId为二选一必填项，其他项不填可以为空值，具体可参考报文样例：向座席发送网页卡片消息。

1.1.13

callId

string

False

呼叫ID

1.1.14

tenant_id

string

False

配置所属的租间ID

1.1.15

partdbId

bigdecimal

True

分库字段

1.1.16

messageCode

string

False

消息唯一编码，用来识别撤销或删除动作操作的消息

1.1.17

associationContentId

string

False

关联邮件t_chat_email id

1.1.18

sendStatus

integer

False

消息发送状态：

• 0：发送成功;
• 1：发送中
• 2：发送失败
• 3：消息已读
• 4：消息未读

1.1.19

recallTime

timestamp

False

撤回消息时间

1.1.20

modifiedTime

timestamp

True

修改时间

1.1.21

errorMsg

timestamp

False

消息发送失败原因

1.1.22

dayOfYear

integer

True

分区字段，一年中的天数

1.1.23

receiveTime

timestamp

False

用户发送消息到达时间

1.1.24

isForwarded

boolean

False

标识是否已转发：

• 0/null：未转发
• 1：已转发

1.1.25

forwardTime

timestamp

False

邮件转发时间

1.1.26

contentDealType

string

False

标识是否本地文件消息，1是本地文件消息

1.1.27

multiMediaLibraryInfo

MultiMediaLibraryDO

False

如果是多媒体类型消息，会返回多媒体的相关属性，详情请参见表4

1.1.28

chat_id

string

False

会话ID

1.1.29

readTime

long

False

消息已读时间（facebook专用）

1.2

resultCode

string

True

0：成功

1：失败

1.3

resultDesc

string

True

响应返回描述

id

string

True

多媒体库id

parentTypeId

string

False

多媒体库类别id

name

string

False

多媒体数据名称

description

string

False

多媒体数据描述

mediaType

string

True

多媒体数据类型：IMAGE,VIDEO,AUDIO,LOCATE

uploadTime

timestamp

True

多媒体数据上传时间

mediaUrl

string

False

多媒体数据存储位置url

latitude

string

False

地址数据的纬度

longitude

string

False

地址数据的经度

duration

string

False

音视频文件的时长

mediaFileType

string

False

媒体文件类型

content

string

False

多媒体内容

fileName

string

False

文件名称

fileSize

string

False

文件大小

sizeUnit

string

False

文件大小单位，KB或MB