tencent cloud

功能说明

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

接口调用说明

适用的群组类型

即时通信 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 简介。

最高调用频率

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": "" // 设置为空表示删除该项自定义字段
        }
    ]
  }
  

请求包字段说明

应答包体示例

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

应答包字段说明

错误码说明

除非发生网络错误（例如502错误），否则该接口的 HTTP 返回码均为200。真正的错误码，错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。
公共错误码（60000 到 79999）参见 错误码 文档。
本 API 私有错误码如下：

接口调试工具

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

参考

删除群成员（v4/group_open_http_svc/delete_group_member）