App 管理员可以通过该接口创建话题。
群组类型 ID | 是否支持此 REST API |
---|---|
Private | 不支持 |
Public | 不支持 |
ChatRoom | 不支持 |
AVChatRoom | 不支持 |
Community(社群) | 只有支持话题的社群才适用此 API |
即时通信 IM 内置上述群组类型,详情介绍请参见 群组系统。
说明:话题功能需要在 控制台 > 功能配置 > 群组配置 > 群功能配置 > 社群 页面,完成开通社群后,再打开开通话题开关,方可使用。
https://xxxxxx/v4/million_group_open_http_svc/create_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 adminapiind.im.qcloud.com adminapiusa.im.qcloud.com |
v4/million_group_open_http_svc/create_topic | 请求接口 |
sdkappid | 创建应用时即时通信 IM 控制台分配的 SDKAppID |
identifier | 必须为 App 管理员帐号,更多详情请参见 App 管理员 |
usersig | App 管理员帐号生成的签名,具体操作请参见 生成 UserSig |
random | 请输入随机的32位无符号整数,取值范围0 - 4294967295 |
contenttype | 请求格式固定值为json |
200次/秒。
{
"GroupId": "@TGS#_@TGS#cQVLVHIM62CJ", // 话题所属的群ID(必填)
"TopicName": "TestTopic" // 话题的名称(必填)
}
{
"GroupId": "@TGS#_@TGS#cQVLVHIM62CJ", // 话题所属的群ID(必填)
"TopicId": "@TGS#_@TGS#cQVLVHIM62CJ@TOPIC#_TestTopic", // 用户自定义话题 ID(选填)
"TopicName": "TestTopic" // 话题的名称(必填)
}
{
"GroupId": "@TGS#_@TGS#cQVLVHIM62CJ", // 话题所属的群ID(必填)
"TopicId": "@TGS#_@TGS#cQVLVHIM62CJ@TOPIC#_TestTopic", // 用户自定义话题 ID(选填)
"TopicName": "TestTopic", // 话题的名称(必填)
"From_Account": "1400187352", // 创建话题的成员
"CustomString": "This is a custom string", // 自定义字符串
"FaceUrl": "http://this.is.face.url", // 话题头像 URL(选填)
"Notification": "This is topic Notification", // 话题公告(选填)
"Introduction": "This is topic Introduction" // 话题简介(选填)
}
字段 | 类型 | 属性 | 说明 |
---|---|---|---|
GroupId | String | 必填 | 需要创建的话题所属的群组ID |
TopicId | String | 选填 | 为了使得话题 ID 更加简单,便于记忆传播,腾讯云支持 App 在通过 REST API 创建话题时 自定义话题 ID |
TopicName | String | 必填 | 话题名称,最长30字节,使用 UTF-8 编码,1个汉字占3个字节 |
From_Account | uint64 | 选填 | 表示需要创建话题的用户帐号 |
CustomString | String | 选填 | 自定义字符串,最长3000个字节,使用 UTF-8 编码,1个汉字占3个字节 |
FaceUrl | String | 选填 | 话题头像 URL,最长100字节 |
Notification | String | 选填 | 话题公告,最长300字节,使用 UTF-8 编码,1个汉字占3个字节 |
Introduction | String | 选填 | 话题简介,最长240字节,使用 UTF-8 编码,1个汉字占3个字节 |
基础形式、仅包含话题基础信息
{
"ActionStatus": "OK",
"ErrorInfo": "",
"ErrorCode": 0,
"TopicId": "@TGS#_@TGS#cQVLVHIM62CJ@TOPIC#_@TOPIC#cETE3HIM62CQ"
}
自定义话题 ID 和 ALL IN ONE
{
"ActionStatus": "OK",
"ErrorInfo": "",
"ErrorCode": 0,
"TopicId": "@TGS#_@TGS#cQVLVHIM62CJ@TOPIC#_TestTopic"
}
字段 | 类型 | 说明 |
---|---|---|
ActionStatus | String | 请求处理的结果,OK 表示处理成功,FAIL 表示失败 |
ErrorCode | Integer | 错误码,0表示成功,非0表示失败 |
ErrorInfo | String | 错误信息 |
TopicId | String | 创建成功之后的话题 ID,由用户自定义或者即时通信 IM 后台分配 |
除非发生网络错误(例如502错误),否则该接口的 HTTP 返回码均为200。真正的错误码,错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。
公共错误码(60000到79999)参见 错误码 文档。
本 API 私有错误码如下:
错误码 | 含义说明 |
---|---|
10002 | 服务器内部错误,请重试 |
10003 | 请求命令字非法 |
10004 | 参数非法,请根据错误描述检查请求是否正确 |
10006 | 操作频率限制,请尝试降低调用的频率。常见于单日净增群量过多,获取 App 中所有群组操作过于频繁 |
10007 | 操作权限不足,请根据错误信息检查请求参数。 |
10008 | 请求非法,可能是请求中携带的签名信息验证不正确,请再次尝试或 提交工单 联系技术客服 |
10010 | 当前群组不存在或者已经被删除 |
10015 | 请求的群组ID无效,请根据错误信息检查请求参数 |
10016 | App 后台通过第三方回调拒绝本次操作,请检查您的回调服务“创建话题之前回调”的返回值 |
10025 | 该群组 ID 已经由您自己使用过,请您先解散该群组或者选择其他的群组 ID |
10036 | 创建的音视频聊天室数量超过限制,请先解散部分音视频聊天室或者参考 价格说明 购买升级 |
10037 | 超过预付费创建话题的数量限制,请解散部分话题或者参考 价格说明 购买升级 |
11000 | 表示当前群组不支持社群话题,需购买 旗舰版 并 在控制台开通 后方可使用 |
80001 | 未通过安全检查,请根据错误信息检查请求参数 |
通过 REST API 在线调试工具 调试本接口。
本页内容是否解决了您的问题?