tencent cloud

PrevNext

文档反馈

请输入关键字

Recent Pages

文档
即时通信 IM
    文档
    Download PDF

    创建权限组

    最后更新时间：2024-07-16 11:20:06
    下载PDF

      功能说明

      App 管理员可以通过该接口创建一个新的权限组。

      接口调用说明

      适用的群组类型

      群组类型
      支持此 REST API
      Private
      不支持，同新版本中的 Work（好友工作群）
      Public
      不支持
      ChatRoom
      不支持，同新版本中的 Meeting（会议群）
      AVChatRoom
      不支持
      Community（社群）
      支持
      即时通信 IM 内置以上四种群组类型，详情请参阅 群组系统。

      请求 URL 示例

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

      最高调用频率

      200次/秒。

      请求包示例

      基础形式
      {
          "GroupId": "@TGS#_@TGS#cV6IHIIM62C4",    // 权限组所属的群Id
          "PermissionGroupId": "@PMG#_test_permission_group",  // 权限组Id
          "PermissionGroupName": "test_permission_group", // 权限组名称
          "Permission": 123,  // 具体的权限
          "CustomString": "test_custom_string"   // 自定义字段
      }

      请求包字段说明

      字段
      类型
      属性
      说明
      GroupId
      String
      必填
      群 ID
      PermissionGroupId
      String
      选填
      权限组 ID。为了使权限组 ID 更加简单，便于记忆传播，腾讯云支持 App 在通过 REST API 创建权限组时自定义权限组 ID。若不填，则系统会默认生成一个权限组ID 返回
      PermissionGroupName
      String
      必填
      权限组的名称。最长150字节，使用 UTF-8 编码，1个汉字占3个字节
      Permission
      Integer
      必填
      权限组对应的具体权限，每一位代表一种权限，具体的权限位描述请参见权限位介绍
      CustomString
      String
      选填
      权限组的自定义字段，最长3000字节，业务层可以使用此字段来实现特殊场景的需求

      应答包体示例

      {
          "ActionStatus": "OK",
          "ErrorInfo": "",
          "ErrorCode": 0,
          "PermissionGroupId": "@PMG#_test_permission_group"
      }

      应答包字段说明

      字段
      类型
      说明
      ActionStatus
      String
      请求处理的结果
      OK：表示处理成功
      FAIL：表示失败
      ErrorCode
      Integer
      错误码
      0：表示成功
      非0：表示失败
      ErrorInfo
      String
      错误信息
      PermissionGroupId
      String
      返回的权限组ID

      错误码说明

      除非发生网络错误（例如502错误），否则该接口的 HTTP 返回码均为200。真正的错误码，错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。 公共错误码（60000到79999）参见 错误码 文档。 本 API 私有错误码如下：
      错误码
      含义说明
      10002
      服务器内部错误，请重试
      10003
      请求命令字非法
      10004
      参数非法，请根据错误描述检查请求是否正确
      10007
      操作权限不足，例如没有创建权限组的权限
      10010
      群组不存在，或者曾经存在过，但是目前已经被解散
      10015
      群组 ID 非法，请检查群组 ID 是否填写正确
      10016
      开发者后台通过第三方回调拒绝本次操作
      10019
      请求的 UserID 不存在，请检查 MemberList 中的所有 Member_Account 是否正确
      10021
      创建的权限组Id已被使用，说明可能重复创建权限组
      10037
      创建的权限组超过限制数量
      110006
      权限组不存在，或者曾经存在过，但是目前已经被解散
      110008
      权限组 ID 非法，请检查权限组 ID 是否填写正确

      接口调试工具

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

      参考

      销毁权限组（销毁权限组）
      修改权限组资料（修改权限组资料）
      获取权限组资料（获取权限组资料）
      
      
      联系我们

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

      联系我们
      技术支持

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

      提交工单
      7x24 电话支持
      Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
      隐私条款服务条款缓存条款