- 动态与公告
- 产品简介
- 购买指南
- 开发指引
- Demo 专区
- 下载中心
- 聊天互动（含 UI）
- 视频通话（含 UI）
- 推送功能
- 智能客服
- 更多实践
- 无 UI 集成
- 客户端 API
- 服务端 API
- 控制台指南
- 常见问题
- 协议与认证
- IM 政策
- 平滑迁移方案
- 错误码
- 联系我们
- 动态与公告
- 产品简介
- 购买指南
- 开发指引
- Demo 专区
- 下载中心
- 聊天互动（含 UI）
- 视频通话（含 UI）
- 推送功能
- 智能客服
- 更多实践
- 无 UI 集成
- 客户端 API
- 服务端 API
- 控制台指南
- 常见问题
- 协议与认证
- IM 政策
- 平滑迁移方案
- 错误码
- 联系我们
功能说明
App 管理员可以通过该接口获取群自定义属性。
接口调用说明
适用的群组类型
群组类型 ID | 是否支持此 REST API |
Private | 支持，同新版本中的 Work（好友工作群） |
Public | 支持 |
ChatRoom | 支持，同新版本中的 Meeting（临时会议群） |
AVChatRoom | 支持 |
Community（社群） | 支持 |
请求 URL 示例
https://xxxxxx/v4/group_open_attr_http_svc/get_group_attr?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
请求参数说明
参数 | 说明 |
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_attr_http_svc/get_group_attr | 请求接口 |
sdkappid | 创建应用时即时通信 IM 控制台分配的 SDKAppID |
identifier | |
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"}]}
应答包字段说明
字段 | 类型 | 说明 |
ActionStatus | String | 请求处理的结果，OK 表示处理成功，FAIL 表示失败 |
ErrorCode | Integer | 错误码，0表示成功，非0表示失败 |
ErrorInfo | String | 错误信息 |
GroupAttrAry | Array | 自定义属性的键值对 |
错误码说明
除非发生网络错误（例如502错误），否则该接口的 HTTP 返回码均为200。真正的错误码，错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。
本 API 私有错误码如下：
错误码 | 含义说明 |
10002 | 服务器内部错误，请重试 |
10004 | 参数非法，请根据错误描述检查请求是否正确 |
10007 | 操作权限不足，该群类型不支持自定义属性 |
10010 | 群组不存在，或者曾经存在过，但是目前已经被解散 |
10015 | 群组 ID 非法，请检查群组 ID 是否填写正确，群不存在 |
是
否
本页内容是否解决了您的问题？