群组类型 | 支持此 REST API |
Private | 支持,同新版本中的 Work(好友工作群) |
Public | 支持 |
ChatRoom | 支持,同新版本中的 Meeting(会议群) |
AVChatRoom | 不支持 |
Community(社群) | 支持 |
https://xxxxxx/v4/group_open_http_svc/import_group?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_http_svc/import_group | 请求接口 |
sdkappid | 创建应用时即时通信 IM 控制台分配的 SDKAppID |
identifier | |
usersig | |
random | 请输入随机的32位无符号整数,取值范围0 - 4294967295 |
contenttype | 请求格式固定值为 json |
{"Owner_Account": "leckie", // 群主的 UserId(选填)"Type": "Public", // 群组类型:Private/Public/ChatRoom/Community(必填)"Name": "TestGroup", // 群名称(必填)"CreateTime": 1448357837 // 群组的创建时间(选填,不填会以请求时刻为准)}
{"Type": "Community", //群组类型 (必填)"Name": "test_import_group", //群组名称 (必填)"SupportTopic": 1 // 是否支持话题选项, 1代表支持,0代表不支持}
{"Owner_Account": "leckie", // 群主的 UserId(选填)"Type": "Public", // 群组类型:Private/Public/ChatRoom/Community(必填)"GroupId":"MyFirstGroup", // 用户自定义群组外显 ID(选填)"Name": "TestGroup", // 群名称(必填)"Introduction": "This is group Introduction", // 群简介(选填)"Notification": "This is group Notification", // 群公告(选填)"FaceUrl": "http://this.is.face.url","MaxMemberCount": 500, // 最大群成员数量(选填)"ApplyJoinOption": "FreeAccess", // 申请加群处理方式(选填)"CreateTime": 1448357837, // 群组的创建时间(选填,不填会以请求时刻为准)"AppDefinedData": [ // 群组维度的自定义字段(选填){"Key": "GroupTestData1", // App 自定义的字段 Key"Value": "xxxxx" // 自定义字段的值},{"Key": " GroupTestData2","Value": "abc\\u0000\\u0001" // 自定义字段支持二进制数据}]}
字段 | 类型 | 属性 | 说明 |
Owner_Account | String | 选填 | 群主 ID,自动添加到群成员中。如果不填,群没有群主 |
Type | String | 必填 | 群组类型,包括 Public(陌生人社交群),Private(同新版本中的Work,好友工作群), ChatRoom(同新版本中的Meeting,会议群)、Community(社群) |
GroupId | String | 选填 | |
Name | String | 必填 | 群名称,最长30字节 |
Introduction | String | 选填 | 群简介,最长240字节 |
Notification | String | 选填 | 群公告,最长300字节 |
FaceUrl | String | 选填 | 群头像 URL,最长100字节 |
MaxMemberCount | Integer | 选填 | 最大群成员数量,最大为6000,不填默认为2000个。社群目前默认支持的最大群成员数量为100000 |
ApplyJoinOption | String | 选填 | 申请加群处理方式。包含 FreeAccess(自由加入),NeedPermission(需要验证),DisableApply(禁止加群),不填默认为NeedPermission(需要验证)。社群目前不支持此字段 |
AppDefinedData | Array | 选填 | |
CreateTime | Integer | 选填 | 群组的创建时间 |
SupportTopic | Integer | 选填 | 是否支持话题选项,此字段只针对社群有效 |
{"ActionStatus": "OK","ErrorInfo": "","ErrorCode": 0,"GroupId": "@TGS#2J4SZEAEL"}
{"ActionStatus": "OK","ErrorInfo": "","ErrorCode": 0,"GroupId": "@TGS#_@TGS#c4YHCIIM62CX"}
{"ActionStatus": "OK","ErrorInfo": "","ErrorCode": 0,"GroupId": "MyFirstGroup"}
字段 | 类型 | 说明 |
ActionStatus | String | 请求处理的结果,OK 表示处理成功,FAIL 表示失败 |
ErrorCode | Integer | 错误码,0表示成功,非0表示失败 |
ErrorInfo | String | 错误信息 |
GroupId | String | 创建成功之后的群 ID,由 IM 云后台分配或者用户指定 |
错误码 | 含义说明 |
10002 | 服务器内部错误,请重试 |
10003 | 请求命令字非法 |
10004 | 参数非法,请根据错误描述检查请求是否正确 |
10007 | 操作权限不足,例如 Public 群组中普通成员尝试执行踢人操作,但只有 App 管理员才有权限 |
10021 | 群组 ID 已被使用,请选择其他的群组 ID |
本页内容是否解决了您的问题?