tencent cloud

文档反馈

修改群基础资料

最后更新时间:2023-12-14 10:31:35

    功能说明

    App 管理员可以通过该接口修改指定群组的基础信息。

    接口调用说明

    适用的群组类型

    群组类型 ID
    是否支持此 REST API
    Private
    支持,同新版本中的 Work(好友工作群)
    Public
    支持
    ChatRoom
    支持,同新版本中的 Meeting(临时会议群)
    AVChatRoom
    支持
    Community(社群)
    支持
    即时通信 IM 内置上述群组类型,详情介绍请参见 群组系统

    请求 URL 示例

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

    最高调用频率

    200次/秒。

    请求包示例

    修改群组基础信息。
    修改群组基础信息,如群名称,群公告等。
    {
    "GroupId": "@TGS#1NVTZEAE4", // 要修改哪个群的基础资料(必填)
    "Name": "NewName", // 群名称(选填)
    "Introduction": "NewIntroduction", // 群简介(选填)
    "Notification": "NewNotification", // 群公告(选填)
    "FaceUrl": "http://this.is.new.face.url", // 群头像(选填)
    "MaxMemberNum": 500, // 最大群成员数量(选填)
    "ApplyJoinOption": "NeedPermission", // 申请加群方式(选填)
    "MuteAllMember": "On" // 设置全员禁言(选填):"On"开启,"Off"关闭
    }
    设置群自定义信息。
    设置群组自定义字段信息,自定义信息默认没有,可以通过 即时通信 IM 控制台 进行配置,详见请求包字段说明表。
    {
    "GroupId": "@TGS#1NVTZEAE4", // 要修改哪个群的基础资料(必填)
    "AppDefinedData": [ // 自定义字段(选填)
    {
    "Key": "GroupTestData1", // 需要修改的自定义字段 key
    "Value": "NewData" // 自定义字段的新值
    }
    ]
    }
    删除群自定义信息。
    删除已设置的群组自定义字段信息。
    {
    "GroupId": "@TGS#1NVTZEAE4", // 要修改哪个群的基础资料(必填)
    "AppDefinedData": [ // 自定义字段(选填)
    {
    "Key": "GroupTestData2",
    "Value": "" // 设置为空表示删除该项自定义字段
    }
    ]
    }
    ALL IN ONE。
    {
    "GroupId": "@TGS#2J4SZEAEL", // 要修改哪个群的基础资料(必填)
    "Name": "NewName", // 群名称(选填)
    "Introduction": "NewIntroduction", // 群简介(选填)
    "Notification": "NewNotification", // 群公告(选填)
    "FaceUrl": "http://this.is.new.face.url", // 群头像(选填)
    "MaxMemberNum": 500, // 最大群成员数量(选填)
    "ApplyJoinOption": "NeedPermission", // 申请加群方式(选填)
    "MuteAllMember": "On", // 设置全员禁言(选填):"On"开启,"Off"关闭
    "AppDefinedData": [ // 自定义字段(选填)
    {
    "Key": "GroupTestData1", // 需要修改的自定义字段 key
    "Value": "NewData" // 自定义字段的新值
    },
    {
    "Key": "GroupTestData2",
    "Value": "" // 设置为空表示删除该项自定义字段
    }
    ]
    }

    请求包字段说明

    字段
    类型
    属性
    说明
    GroupId
    String
    必填
    需要修改基础信息的群组的 ID
    Name
    String
    选填
    最长30字节,使用 UTF-8 编码,1个汉字占3个字节
    Introduction
    String
    选填
    最长240字节,使用 UTF-8 编码,1个汉字占3个字节
    Notification
    String
    选填
    最长300字节,使用 UTF-8 编码,1个汉字占3个字节
    FaceUrl
    String
    选填
    群头像 URL,最长100字节
    MaxMemberNum
    Integer
    选填
    最大群成员数量
    好友工作群(Work),陌生人社交群(Public),临时会议群(Meeting)及社群(Community):该字段阈值请参见 群组系统 中的群成员人数上限相关说明
    直播群(AVChatRoom):该字段为无效字段,无需填写
    ApplyJoinOption
    String
    选填
    申请加群处理方式。包含 FreeAccess(自由加入),NeedPermission(需要验证),DisableApply(禁止加群)。社群目前不支持此字段
    AppDefinedData
    Array
    选填
    默认情况是没有的。开通群组维度的自定义字段详情请参见 自定义字段
    MuteAllMember
    String
    选填
    群内群成员禁言,只有群管理员和群主以及系统管理员可以发言

    应答包体示例

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

    应答包字段说明

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

    错误码说明

    除非发生网络错误(例如502错误),否则该接口的 HTTP 返回码均为200。真正的错误码,错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。
    公共错误码(60000 到 79999)参见 错误码 文档。
    本 API 私有错误码如下:
    错误码
    描述
    10002
    服务器内部错误,请重试
    10003
    请求命令字非法
    10004
    参数非法,请根据错误描述检查请求是否正确
    10026
    该 SDKAppID 请求的命令字已被禁用,请联系客服
    10007
    操作权限不足,请确认操作者是否是 App 管理员或者是否有权限修改请求中的字段
    10010
    群组不存在,或者曾经存在过,但是目前已经被解散
    10015
    群组 ID 非法,请检查群组 ID 是否填写正确

    接口调试工具

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

    参考

    联系我们

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

    技术支持

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

    7x24 电话支持