加入群组
该接口用于加入已存在的群组。
开通服务
调用此接口前,您须在控制台开通信息托管服务。详情请参阅开启用户信息托管。
请求方法
POST: https://数据中心域名/entrust/group/join.json
频率限制: 每秒钟限 100 次
签名规则: 所有服务端 API 请求均需要进行规则校验,详见 API 请求签名。
正文参数
HTTP 请求正文数据格式为 application/x-www-form-urlencoded
,支持以下 HTTP 表单参数:
参数 | 类型 | 必传 | 说明 |
---|---|---|---|
groupId | String | 是 | 群组 ID |
userIds | Array | 是 | 加入群的用户ID:一次最多可以添加 100 个用户 |
请求示例
POST /entrust/group/join.json HTTP/1.1
Host: api.rong-api.com
App-Key: uwd1c0sxdlx2
Nonce: 14314
Timestamp: 1408710653491
Signature: 45beb7cc7307889a8e711219a47b7cf6a5b000e8
Content-Type: application/x-www-form-urlencoded
groupId=groupId1&userIds=userId
返回结果
HTTP 响应正文包含具有以下结构的 JSON 对象:
返回值 | 返回类型 | 说明 |
---|---|---|
code | Number | 返回码,200 为正常。 |
ngroupIdame | String | 群ID |
name | String | 群名称 |
groupProfile | String | 群组基本信息, 为 JSON 数据 |
groupExtProfile | String | 群扩展信息 为 JSON 格式 |
permissions | String | 群权限信息, 为 JSON 格式 |
owner | String | 群主 |
createTime | Long | 群创建时间 |
memberCount | Number | 群成员数量 |
groupProfile
中的 key 如下:
key 值 | 类型 | 描述 |
---|---|---|
introduction | String | 群简介,长度不超过 512 个字符 |
announcement | String | 群公告,长度不超过 1024 个字符 |
portraitUrl | String | 群头像地址,长度不超过 128 个字符 |
permissions
中的 key 如下:
key 值 | 类型 | 长度/取值范围 | 描述 |
---|---|---|---|
joinPerm | Number | 取值范围:
| 加入群权限 |
removePerm | Number | 取值范围:
| 将群成员移出群组权限 |
memInvitePerm | Number | 取值范围:
| 邀请他人入群权限 |
invitePerm | Number | 取值范围:
| 邀请加入群组处理方式 |
profilePerm | Number | 取值范围:
| 修改群资料及权限 |
memProfilePerm | Number | 取值范围:
| 设置群成员资料权限 |
返回结果示例
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"code": 200,
"groupId":"gorupId1",
"createTime":1717717737377,
"owner":"userId1",
"name":"gName1",
"groupExtProfile":"{\"ext_key1\":\"value1\",\"ext_key2\":\"value2\"}",
"memberCount":10
}