一、功能说明
App 管理员可以通过该接口获取群自定义属性。
二、适用的群组类型
| 群组类型 ID | 是否支持此 REST API |
| Private | 支持，同新版本中的 Work（好友工作群）。 |
| Public | 支持。 |
| ChatRoom | 支持，同新版本中的 Meeting（临时会议群）。 |
| AVChatRoom | 支持。 |
| Community（社群） | 支持。 |
即时通信 IM 内置上述群组类型，详情介绍请参见 群组系统。
三、请求 URL 示例
https://xxxxxx/v4/group_open_attr_http_svc/get_group_attr?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东京：adminapijpn.im.qcloud.com法兰克福：adminapiger.im.qcloud.com硅谷：adminapiusa.im.qcloud.com雅加达：adminapiidn.im.qcloud.com利雅得：adminapiksa.im.qcloud.com |
| v4/group_open_attr_http_svc/get_group_attr | 请求接口。 |
| sdkappid | 创建应用时即时通信 IM 控制台分配的 SDKAppID。 |
| identifier | 必须为 App 管理员账号，更多详情请参见 App 管理员。 |
| usersig | App 管理员账号生成的签名，具体操作请参见 生成 UserSig。 |
| random | 请输入随机的32位无符号整数，取值范围0 – 4294967295。 |
| contenttype | 请求格式固定值为 json。 |
五、最高调用频率
200次/秒。
六、请求包示例
·基础形式
获取群自定义属性
{ "GroupId": "@TGS#aC5SZEAEF"}
七、请求包字段说明
| 字段 | 类型 | 属性 | 说明 |
| GroupId | String | 必填 | 获取自定义属性的群 ID。 |
八、应答包体示例
{ "ActionStatus": "OK", "ErrorInfo": "", "ErrorCode": 0, "GroupAttrAry": [ { "key": "attr_key1", "value": "attr_val1" }, { "key": "attr_key2", "value": "attr_val2" } ], "RequestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"}
九、应答包字段说明
| 字段 | 类型 | 说明 |
| ActionStatus | String | 请求处理的结果：OK：表示处理成功。FAIL：表示失败。 |
| ErrorCode | Integer | 错误码：0：表示成功。非0：表示失败。 |
| ErrorInfo | String | 错误信息。 |
| GroupAttrAry | Array | 自定义属性的键值对。 |
| RequestId | String | 本次请求的唯一标识 ID，可用于问题排查。 |
十、错误码说明
除非发生网络错误（例如502错误），否则该接口的 HTTP 返回码均为200。真正的错误码，错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。
公共错误码（60000到79999）参见 错误码 文档。
本 API 私有错误码如下：
| 错误码 | 含义说明 |
| 10002 | 服务器内部错误，请重试。 |
| 10004 | 参数非法，请根据错误描述检查请求是否正确。 |
| 10007 | 操作权限不足，该群类型不支持自定义属性。 |
| 10010 | 群组不存在，或者曾经存在过，但是目前已经被解散。 |
| 10015 | 群组 ID 非法，请检查群组 ID 是否填写正确，群不存在。 |