功能说明
App 管理员可以通过该接口获取群组内已置顶的消息列表，包含消息序号和置顶者等信息。
接口调用说明
适用的群组类型
群组类型 | 是否支持此 REST API |
Private | 支持。 |
Public | 支持。 |
ChatRoom | 支持。 |
AVChatRoom | 不支持。 |
Community | 支持。 |
注意：
该接口仅支持旗舰版、企业版和开发版用户，体验版和专业版用户无法使用此功能。
请求 URL 示例
https://xxxxxx/v4/group_open_http_svc/get_pinned_messages?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
请求参数说明
参数 | 说明 |
xxxxxx | SDKAppID 所在国家/地区对应的专属域名，不同地区域名不同： 中国： console.tim.qq.com新加坡： adminapisgp.im.qcloud.com首尔： adminapikr.im.qcloud.com东京： adminapijpn.im.qcloud.com法兰克福： adminapiger.im.qcloud.com硅谷： adminapiusa.im.qcloud.com雅加达： adminapiidn.im.qcloud.com利雅得： adminapiksa.im.qcloud.com |
v4/group_open_http_svc/get_pinned_messages | 请求接口。 |
sdkappid | 创建应用时即时通信 IM 控制台分配的 SDKAppID。 |
identifier | |
usersig | |
random | 请输入随机的32位无符号整数，取值范围0 - 4294967295。 |
contenttype | 请求格式固定值为 json。 |
请求频率限制
默认接口请求频率限制：200 次/秒。
请求包示例
基础形式
{"GroupId": "@TGS#2J4SZEAEL"}
获取置顶的话题消息列表
{"GroupId": "@TGS#_test_group","TopicId":"@TGS#_test_group@TOPIC#_test_topic"}
请求包字段说明
字段 | 类型 | 属性 | 说明 |
GroupId | String | 必填 | 群组 ID，仅支持群组 ID 不支持群组昵称。 |
TopicId | String | 社群必填 | 话题 ID。 |
应答包体示例
{"ActionStatus": "OK","ErrorInfo": "","ErrorCode": 0,"PinnedMsgList": [{"MsgSeq": 7,"Pinner_Account": "admin"},{"MsgSeq": 5,"Pinner_Account": "user1"}]}
应答包字段说明
字段 | 类型 | 说明 |
ActionStatus | String | 请求处理的结果， OK 表示处理成功；FAIL 表示失败。 |
ErrorCode | Integer | 错误码， 0 表示成功；非 0 表示失败。 |
ErrorInfo | String | 错误信息。当 ErrorCode 非 0 时，本字段包含详细的错误描述。 |
PinnedMsgList | Array | 置顶消息列表，数组元素为置顶消息对象。 |
MsgSeq | Integer | 置顶消息的序号，取值范围1 - 4294967295。 |
Pinner_Account | String | 执行置顶操作的用户账号。 |
错误码说明
除非发生网络错误（例如502错误），否则该接口的 HTTP 返回码均为200。真正的错误码，错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。
本 API 私有错误码如下：
错误码 | 含义说明 |
10002 | 服务器内部错误，请重试。 |
10004 | 参数非法，请根据错误描述检查请求是否正确。 GroupId 不存在或无效。 |
10007 | 操作权限不足。仅当前用户为群成员或管理员才能查询群组内的置顶消息。 |
10010 | 群组不存在，或群组已被解散。 |
10026 | 不支持在此类型群组上执行该操作。群组类型为 AVChatRoom 时不支持此操作。 |
10059 | 该功能仅供旗舰版、企业版和开发版用户使用，请升级您的套餐包。 |
