tencent cloud

文档反馈

修改话题资料

最后更新时间:2024-06-11 10:57:33

    功能说明

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

    接口调用说明

    适用的群组类型

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

    请求 URL 示例

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

    最高调用频率

    200次/秒。

    请求包示例

    修改话题的基础信息。
    修改话题的基础信息,例如话题名称,话题公告等。
    {
    "GroupId":"@TGS#_@TGS#cQVLVHIM62CJ", // 要修改哪个群组下属的话题 (必填)
    "TopicId":"@TGS#_@TGS#cQVLVHIM62CJ@TOPIC#_@TOPIC#cRTE3HIM62C5", // 要修改的话题ID (必填)
    "TopicName":"TestTopicName", // 话题名称 (选填)
    "Notification":"Notification" // 话题的公告(选填)
    }
    ALL IN ONE。
    {
    "GroupId":"@TGS#_@TGS#cQVLVHIM62CJ", // 要修改哪个群组下属的话题 (必填)
    "TopicId":"@TGS#_@TGS#cQVLVHIM62CJ@TOPIC#_@TOPIC#cRTE3HIM62C5", // 要修改的话题ID (必填)
    "From_Account":"1400187352", // 修改话题的成员
    "TopicName":"TestTopicName", // 话题名称 (选填)
    "FaceUrl":"http://this.is.new.face.url", // 话题头像(选填)
    "Notification":"Notification", // 话题的公告(选填)
    "Introduction":"Introduction", //话题的简介 (选填)
    "MuteAllMember":"On", // 设置全员禁言(选填):"On"开启,"Off"关闭
    "CustomString":"This is a customs string." // 自定义字符串 (选填)
    }

    请求包字段说明

    字段
    类型
    属性
    说明
    GroupId
    String
    必填
    需要修改的话题所属的群组 ID
    TopicId
    String
    必填
    需要修改的话题 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个字节
    MuteAllMember
    String
    选填
    话题内成员禁言,只有群管理员和群主以及系统管理员可以发言

    应答包体示例

    {
    "ActionStatus": "OK",
    "ErrorInfo": "ok",
    "ErrorCode": 0
    }

    应答包字段说明

    字段
    类型
    说明
    ActionStatus
    String
    请求处理的结果,OK 表示处理成功,FAIL 表示失败
    ErrorCode
    Integer
    错误码,0表示成功,非0表示失败
    ErrorInfo
    String
    错误信息

    错误码说明

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

    接口调试工具

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

    可能触发的回调

    联系我们

    联系我们,为您的业务提供专属服务。

    技术支持

    如果你想寻求进一步的帮助,通过工单与我们进行联络。我们提供7x24的工单服务。

    7x24 电话支持