即时通信 IM
有奖捉虫：行业应用 & 管理与支持文档专题 HOT
文档中心 > 即时通信 IM > 服务端 API > REST API > 群组相关 > 社群管理 > 导入话题基础资料

导入话题基础资料

最近更新时间：2024-02-29 11:15:42

我的收藏

本页目录：

功能说明

App 管理员可以通过该接口导入话题，不会触发回调、不会下发通知；当 App 需要从其他即时通信系统迁移到即时通信 IM 时，使用该协议导入存量话题数据。

接口调用说明

适用的群组类型

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

请求 URL 示例

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

最高调用频率

200次/秒。

请求包示例

基础形式 导入群，可以用 CreateTime 指定话题的创建时间。
{
"GroupId": "@TGS#_@TGS#cBZXAIIM62CV",     // 用户导入话题所在的群组 ID（必填）
"TopicName": "test_topic3",           // 话题的名称 （必填）
"CreateTime": 1448357837              //指定话题的创建时间（选填）
}
指定其他选填字段 指定简介、公告等选填字段。
{
  "Type": "Community", // 话题所属的群组类型:Community（选填）
  "GroupId":"@TGS#_@TGS#cBZXAIIM62CV", // 用户导入话题所在的群组 ID（必填）
  "TopicName": "test_topic3",           // 话题的名称 （必填）
  "Introduction": "This is topic Introduction", // 话题简介（选填）
  "Notification": "This is topic Notification", // 话题公告（选填）
  "FaceUrl": "http://this.is.face.url",
  "CreateTime": 1448357837 // 话题的创建时间（选填，不填会以请求时刻为准）
}

请求包字段说明

字段
类型
属性
说明
Type
String
选填
话题所属的群组类型，目前只支持Community（社群）类型。
GroupId
String
必填
导入话题所在的群组 ID。
TopicId
String
选填
为了使得话题 ID 更加简单，便于记忆传播，腾讯云支持 App 在通过 REST API 创建话题时 自定义话题 ID。
TopicName
String
必填
话题名称，最长30字节，使用 UTF-8 编码，1个汉字占3个字节。
From_Account
String
选填
表示需要创建话题的用户账号。
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个字节。
CreateTime
Integer
选填
指定话题的创建时间。

应答包体示例

基础形式
{
  "ActionStatus": "OK",
  "ErrorInfo": "",
  "ErrorCode": 0,
  "TopicId": "@TGS#_@TGS#cBZXAIIM62CV@TOPIC#_@TOPIC#cTCCCIIM62CW"
}
指定其他选填字段
{
  "ActionStatus": "OK",
  "ErrorInfo": "",
  "ErrorCode": 0,
  "TopicId": "@TGS#_@TGS#cBZXAIIM62CV@TOPIC#_@TOPIC#c5CCCIIM62CW"
}

应答包字段说明

字段
类型
说明
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
参数非法，请根据错误描述检查请求是否正确。
10007
操作权限不足，请根据错误信息检查请求参数。
10010
当前群组不存在或者已经被删除。
10015
请求的群组ID无效，请根据错误信息检查请求参数。
10021
话题 ID 已被使用，请选择其他的话题 ID。
10037
超过预付费创建话题的数量限制，请解散部分话题或者参见 价格说明 购买升级。
11000
表示当前群组不支持社群话题，需购买 旗舰版套餐包 并 在控制台开通 后方可使用。
80001
未通过安全检查，请根据错误信息检查请求参数。
80005
未通过安全检查，安全检查超时。

接口调试工具

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

参考

创建话题（v4/million_group_open_http_svc/create_topic）
解散话题（v4/million_group_open_http_svc/destroy_topic）
导入群基础资料（v4/group_open_http_svc/import_group）
中国站