获取话题资料

功能说明

App 管理员可以通过该接口获取话题资料。

接口调用说明

适用的群组类型

群组类型 ID
是否支持此 REST API
Private
不支持
Public
不支持
ChatRoom
不支持
AVChatRoom
不支持
Community(社群)
只有支持话题的社群才适用此 API
即时通信 IM 内置上述群组类型,详情介绍请参见 群组系统
说明
话题功能需要在 控制台 > 功能配置 > 群组配置 > 群功能配置 > 社群 页面,完成开通社群后,再打开开通话题开关,方可使用。

请求 URL 示例

https://xxxxxx/v4/million_group_open_http_svc/get_topic?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json

请求参数说明

下表仅列出调用本接口时涉及修改的参数及其说明,更多参数详情请参见 REST API 简介
参数
说明
xxxxxx
SDKAppID 所在国家/地区对应的专属域名:
中国:console.tim.qq.com
新加坡:adminapisgp.im.qcloud.com
首尔: adminapikr.im.qcloud.com
法兰克福:adminapiger.im.qcloud.com
硅谷:adminapiusa.im.qcloud.com
雅加达:adminapiidn.im.qcloud.com
v4/million_group_open_http_svc/get_topic
请求接口
sdkappid
创建应用时即时通信 IM 控制台分配的 SDKAppID
identifier
必须为 App 管理员账号,更多详情请参见 App 管理员
usersig
App 管理员账号生成的签名,具体操作请参见 生成 UserSig
random
请输入随机的32位无符号整数,取值范围0 - 4294967295
contenttype
请求格式固定值为json

最高调用频率

200次/秒。

请求包示例

基础形式。
用来获取话题的详细信息,请求中包含群组 ID 和所需要拉取的所有话题列表。
{
"GroupId":"@TGS#_@TGS#cQVLVHIM62CJ", // 需要获取话题所在的群组ID (必填)
"From_Account":"1400187352" // 获取指定用户在话题中的信息 (必填)
}
指定需要拉取的话题列表形式。
{
"GroupId":"@TGS#_@TGS#cQVLVHIM62CJ", // 需要获取话题所在的群组ID (必填)
"From_Account":"1400187352", // 获取指定用户在话题中的信息 (必填)
"TopicIdList":[ // 指定需要拉取的话题列表 (选填)
"@TGS#_@TGS#cQVLVHIM62CJ@TOPIC#_@TOPIC#cRTE3HIM62C5"
]
}
使用过滤器,获取指定的信息形式。
可以指定拉取的话题信息字段,在 ResponseFilter 中设置。如果设置了过滤器,没有在过滤器中指明的字段将不被拉取。
{
"GroupId":"@TGS#_@TGS#cQVLVHIM62CJ", // 需要获取话题所在的群组ID (必填)
"From_Account":"1400187352", // 获取指定用户在话题中的信息 (必填)
"TopicIdList":[ // 指定需要拉取的话题列表 (选填)
"@TGS#_@TGS#cQVLVHIM62CJ@TOPIC#_@TOPIC#cRTE3HIM62C5"
],
"ResponseFilter":[ // 返回信息的过滤器,指定需要获取的话题信息 (选填)
"TopicName", // 话题的名称
"FaceUrl", // 话题头像 URL
"Notification", // 话题公告
"Introduction" // 话题简介
]
}

请求包字段说明

字段
类型
属性
说明
GroupId
String
必填
需要获取话题所在的群组 ID
From_Account
String
必填
获取指定用户在话题中的信息
TopicIdList
Array
选填
需要获取的话题列表,若不填,则获取群组下所有的话题信息
ResponseFilter
Array
选填
返回信息的过滤器,指定需要获取的话题信息

应答包体示例

基础形式、指定获取的话题列表形式。
{
"ActionStatus": "OK",
"ErrorInfo": "ok", // 这里的 ErrorInfo 无意义,需要判断每个话题的 ErrorInfo
"ErrorCode": 0, // 这里的 ErrorCode 无意义,需要判断每个话题的 ErrorCode
"TopicAndSelfInfo": [ // 返回结果为话题信息数组,为简单起见这里仅列出一个话题
{
"ErrorCode": 0,
"ErrorInfo": "ok", // 针对该话题的返回结果
"SelfInfo": { // 指定的用户在此话题中的相关信息
"ShutUpTime": 0, //用户的禁言时间
"MsgSeq": 0, // 成员已读消息 seq
"MsgFlag": "AcceptAndNotify"
},
"TopicInfo": { // 返回的话题信息
"TopicName": "TestTopicName", // 话题的名称
"GroupID": "@TGS#_@TGS#cQVLVHIM62CJ", // 话题所在的群组ID
"FaceUrl": "http://this.is.new.face.url", // 话题头像 URL
"TopicId": "@TGS#_@TGS#cQVLVHIM62CJ@TOPIC#_@TOPIC#cRTE3HIM62C5", //话题的ID
"NextMsgSeq": 1,
"Notification": "Notification", // 话题公告
"Introduction": "Introduction", // 话题简介
"CreateTime": 1658839448, //话题的创建时间 (UTC 时间)
"LastMsgTime": 0, // 话题内最后一条消息的时间(UTC 时间)
"MuteAllMember": "Off", // 话题全员禁言标志,On代表为启用全员禁言,Off代表未启用全员禁言
"CustomString": "This is a customs string." //话题中的自定义字符串
}
}
]
}
使用过滤器,获取指定的话题信息形式。
{
"ActionStatus": "OK",
"ErrorInfo": "ok", // 这里的 ErrorInfo 无意义,需要判断每个话题的 ErrorInfo
"ErrorCode": 0, // 这里的 ErrorCode 无意义,需要判断每个话题的 ErrorCode
"TopicAndSelfInfo": [ // 返回结果为话题信息数组,为简单起见这里仅列出一个话题
{
"ErrorCode": 0,
"ErrorInfo": "ok", // 针对该话题的返回结果
"SelfInfo": { // 指定的用户在此话题中的相关信息
"ShutUpTime": 0, //用户的禁言时间
"MsgSeq": 0,
"MsgFlag": "AcceptAndNotify"
},
"TopicInfo": { // 返回的话题信息
"TopicName": "TestTopicName", // 话题的名称
"GroupID": "@TGS#_@TGS#cQVLVHIM62CJ", // 话题所在的群组ID
"FaceUrl": "http://this.is.new.face.url", // 话题头像 URL
"TopicId": "@TGS#_@TGS#cQVLVHIM62CJ@TOPIC#_@TOPIC#cRTE3HIM62C5", //话题的ID
"Notification": "Notification", // 话题公告
"Introduction": "Introduction" // 话题简介
}
}
]
}

应答包字段说明

字段
类型
说明
ActionStatus
String
请求处理的结果,OK 表示处理成功,FAIL 表示失败
ErrorCode
Integer
错误码,0表示成功,非0表示失败
ErrorInfo
String
错误信息
TopicAndSelfInfo
Array
返回为话题信息数组,内容包括话题的基本信息以及指定成员在话题中的相关信息

错误码说明

除非发生网络错误(例如502错误),否则该接口的 HTTP 返回码均为200。真正的错误码,错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。
公共错误码(60000到79999)参见 错误码 文档。
本 API 私有错误码如下:
错误码
含义说明
10002
服务器内部错误,请重试
10003
请求命令字非法
10004
参数非法,请根据错误描述检查请求是否正确
10006
操作频率限制,请尝试降低调用的频率。常见于单日净增群量过多,获取 App 中所有群组操作过于频繁
10007
操作权限不足,请根据错误信息检查请求参数。
10008
请求非法,可能是请求中携带的签名信息验证不正确,请再次尝试或 提交工单 联系技术客服
10010
请求非法,群组或者话题已经被删除
11000
表示当前群组不支持社群话题,需购买 进阶版在控制台开通 后方可使用
110003
请求失败,话题已经被删除

接口调试工具

通过 REST API 在线调试工具 调试本接口。