# 群消息置顶-列表
## OpenAPI Specification
```yaml
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/api/qw/doApi:
post:
summary: 群消息置顶-列表
deprecated: false
description: >-
tags:
- 'API参考/会话与消息/消息模块 '
parameters:
- name: Content-Type
in: header
description: ''
required: true
example: application/json
schema:
type: string
- name: X-QIWEI-TOKEN
in: header
description: >-
进入 应用凭证，复制
TokenId。
required: true
example: '{{tokenId}}'
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
properties:
method:
type: string
title: 执行方法
description: >-
/msg/roomTopMessageList
params:
type: object
properties:
guid:
type: string
title: 设备 ID
description: >-
设备唯一标识 guid，由「创建设备」接口返回，业务接口必传。
roomId:
type: string
title: 群 ID
description: >-
群聊 ID。
required:
- guid
- roomId
x-apifox-orders:
- guid
- roomId
title: 请求参数
required:
- method
- params
x-apifox-orders:
- method
- params
example:
method: /msg/roomTopMessageList
params:
guid: '{{guid}}'
roomId: 1088541**********6
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
code:
type: integer
title: 状态码
description: >-
状态码，0 成功。
data:
type: object
properties:
list:
type: array
items:
type: object
properties:
senderId:
type: string
title: 发送人userId
description: ''
senderName:
type: string
title: 发送人名称
description: ''
sendAvatar:
type: string
title: 发送人头像
description: ''
msgType:
type: integer
title: 消息类型
description: ''
timestamp:
type: integer
title: 时间戳
description: ''
isOutRoom:
type: integer
title: 是否外群
description: ''
fromRoomId:
type: string
title: 来源群Id
description: ''
msgUniqueIdentifier:
type: string
title: 消息唯一标识
description: ''
msgData:
type: object
properties:
fileAesKey:
type: string
title: 文件密钥
description: ''
fileHttpUrl:
type: string
title: 文件HTTP链接
description: ''
fileId:
type: string
title: 文件 ID
description: ''
fileMd5:
type: string
title: 文件 MD5
description: ''
fileSize:
type: integer
title: 文件大小
description: ''
filename:
type: string
title: 文件名
description: ''
height:
type: integer
title: 高度
description: ''
sourceDesc:
type: string
title: Source描述
description: ''
sourceType:
type: integer
title: Source类型
description: ''
type:
type: integer
title: 类型
description: ''
width:
type: integer
title: 宽度
description: ''
subMsgDesc:
type: string
title: Sub消息描述
description: ''
subMsgFlag:
type: integer
title: Sub消息标志
description: ''
subMsgList:
type: array
items:
type: object
properties:
subMsgData:
type: object
properties:
atList:
type: array
items:
type: string
title: atList
description: ''
title: At列表
description: ''
content:
type: string
title: 消息内容
description: ''
fileAesKey:
type: string
title: 文件密钥
description: ''
fileId:
type: string
title: 文件 ID
description: ''
fileMd5:
type: string
title: 文件 MD5
description: ''
fileSize:
type: integer
title: 文件大小
description: ''
filename:
type: string
title: 文件名
description: ''
imageHasHd:
type: boolean
title: 图片含高清
description: ''
required:
- fileAesKey
- fileId
- fileMd5
- fileSize
- filename
- imageHasHd
x-apifox-orders:
- atList
- content
- fileAesKey
- fileId
- fileMd5
- fileSize
- filename
- imageHasHd
title: Sub消息数据
description: ''
subMsgFromId:
type: string
title: Sub消息来源Id
description: ''
subMsgId:
type: string
title: Sub消息Id
description: ''
subMsgSenderAvatar:
type: string
title: Sub消息Sender头像
description: ''
subMsgSenderId:
type: string
title: Sub消息SenderId
description: ''
subMsgTimestamp:
type: integer
title: Sub消息时间戳
description: ''
subMsgType:
type: integer
title: Sub消息类型
description: ''
required:
- subMsgData
- subMsgFromId
- subMsgId
- subMsgSenderAvatar
- subMsgSenderId
- subMsgTimestamp
- subMsgType
x-apifox-orders:
- subMsgData
- subMsgFromId
- subMsgId
- subMsgSenderAvatar
- subMsgSenderId
- subMsgTimestamp
- subMsgType
title: Sub消息列表
description: ''
required:
- subMsgDesc
- subMsgFlag
- subMsgList
x-apifox-orders:
- fileAesKey
- fileHttpUrl
- fileId
- fileMd5
- fileSize
- filename
- height
- sourceDesc
- sourceType
- type
- width
- subMsgDesc
- subMsgFlag
- subMsgList
title: 消息数据
description: ''
seq:
type: integer
title: 消息序号
description: ''
desc:
type: string
title: 描述
description: ''
required:
- senderId
- senderName
- sendAvatar
- msgType
- timestamp
- isOutRoom
- fromRoomId
- msgUniqueIdentifier
- msgData
- seq
- desc
x-apifox-orders:
- senderId
- senderName
- sendAvatar
- msgType
- timestamp
- isOutRoom
- fromRoomId
- msgUniqueIdentifier
- msgData
- seq
- desc
title: 列表
description: ''
required:
- list
x-apifox-orders:
- list
title: 响应数据
description: >-
业务数据。
msg:
type: string
title: 说明
description: >-
返回说明。
required:
- code
- data
- msg
x-apifox-orders:
- code
- data
- msg
example:
code: 0
data:
list:
- senderId: 168******04
senderName: ''
sendAvatar: ''
msgType: 29
timestamp: 1752825029
isOutRoom: 1
fromRoomId: 1096******579
msgUniqueIdentifier: CIGABBDD+efDBnICAAyAB
msgData:
fileAesKey: 326137****316637
fileHttpUrl: >-
https://wework.qpic.cn/wwpic3az/757944_rZr5j_dgQa1_1744700046/0
fileId: >-
306b020102046430620201000204cf35f7dc******a0204e5fe1d3c02046879fcc4042461373233666563632d346364352d343565372d****0b54596fcb20131b6efa0201010201000400
fileMd5: c23f9c8917***131b6efa
fileSize: 0
filename: ''
height: 600
sourceDesc: ''
sourceType: 2
type: 2
width: 800
seq: 25
desc: '[表情]'
- senderId: 168******04
senderName: ''
sendAvatar: ''
msgType: 4
timestamp: 1752805930
isOutRoom: 1
fromRoomId: 1096******579
msgUniqueIdentifier: CAQQquTwYY3O/X+gAMghuGtpAM=
msgData:
subMsgDesc: 虚头***和Ice
subMsgFlag: 0
subMsgList:
- subMsgData:
atList: []
content: wehook[OK]
subMsgFromId: 788*****9450
subMsgId: ''
subMsgSenderAvatar: ''
subMsgSenderId: 788*****9450
subMsgTimestamp: 1752803769
subMsgType: 0
- subMsgData:
fileAesKey: 23554a2e9****0b67660c86fc
fileId: >-
306902010204***465662d396662352d343530352d616633302d653137666134663932623462020100020303345004****a6c0201020201000400
fileMd5: ab3c67c4e******1b02ffca6c
fileSize: 209998
filename: ''
imageHasHd: false
subMsgFromId: 7881****450
subMsgId: ''
subMsgSenderAvatar: ''
subMsgSenderId: 788****450
subMsgTimestamp: 1752803791
subMsgType: 14
seq: 27
desc: ''
msg: 成功
headers: {}
x-apifox-name: 成功
security: []
x-apifox-folder: 'API参考/会话与消息/消息模块 '
x-apifox-status: released
x-run-in-apifox: https://app.apifox.com/web/project/7051713/apis/api-344613930-run
components:
schemas: {}
securitySchemes:
apiKey:
type: apikey
in: header
name: X-WECOM-TOKEN
servers:
- url: https://new.qiweapi.com/qiwe
description: 正式环境
security: []
```