删除话题

功能说明

App 管理员可以通过该接口解散话题。

接口调用说明

适用的群组类型

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

请求 URL 示例

https://xxxxxx/v4/million_group_open_http_svc/destroy_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/destroy_topic
请求接口
sdkappid
创建应用时即时通信 IM 控制台分配的 SDKAppID
identifier
必须为 App 管理员账号,更多详情请参见 App 管理员
usersig
App 管理员账号生成的签名,具体操作请参见 生成 UserSig
random
请输入随机的32位无符号整数,取值范围0 - 4294967295
contenttype
请求格式固定值为json

最高调用频率

200次/秒。

请求包示例

话题解散之后无法恢复,请谨慎调用此接口。
{
"GroupId":"@TGS#_@TGS#cQVLVHIM62CJ", // 需要解散话题所属的群组ID
"TopicIdList":[ // 需要解散的话题ID列表
"@TGS#_@TGS#cQVLVHIM62CJ@TOPIC#_TestTopic",
"@TGS#_@TGS#cQVLVHIM62CJ@TOPIC#_TestTopic_1"
]
}

请求包字段说明

字段
类型
属性
说明
GroupId
String
必填
需要解散话题所属的群组 ID
TopicIdList
Array
必填
表示需要解散的话题列表,可以有多个

应答包体示例

{
"ActionStatus": "OK",
"ErrorInfo": "ok",
"ErrorCode": 0,
"DestroyResultItem": [
{
"ErrorCode": 0,
"ErrorInfo": "ok",
"TopicId": "@TGS#_@TGS#cQVLVHIM62CJ@TOPIC#_TestTopic"
},
{
"ErrorCode": 0,
"ErrorInfo": "ok",
"TopicId": "@TGS#_@TGS#cQVLVHIM62CJ@TOPIC#_TestTopic_1"
}
]
}

应答包字段说明

字段
类型
说明
ActionStatus
String
请求处理的结果,OK 表示处理成功,FAIL 表示失败
ErrorCode
Integer
错误码,0表示成功,非0表示失败
ErrorInfo
String
错误信息
DestroyResultItem
Array
返回解散话题的结果,每一项对应解散一个话题的执行结果

错误码说明

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

接口调试工具

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

可能触发的回调