跳到主要内容

设置群组资料

该接口用于设置群组的基本信息、权限和扩展信息。

开通服务

调用此接口前,您须在控制台开通用户信息托管服务。详情请参阅开启用户信息托管

请求方法

POST:https://数据中心域名/entrust/group/profile/update.json

频率限制:每秒 100 次

签名规则:所有服务端 API 请求均需要进行规则校验,详见 API 请求签名

正文参数

HTTP 请求正文数据格式为 application/x-www-form-urlencoded,支持以下 HTTP 表单参数:

参数类型必传说明
groupIdString群组 ID,最大长度 64 个字符。支持大小写英文字母与数字的组合。
groupProfileString群组基本信息,为 JSON 数据,具体的 key 参考下方详情。
permissionsString群组权限信息,为 JSON 数据,具体的 key 参考下方详情。
groupExtProfileString群组扩展信息,为 JSON 格式。键(key)的前缀必须加 ext_,其长度不超过 32 个字符;值(value)的长度不超过 256 个字符;键值对(KV)默认可设置 10 个。

groupProfile 中的 key 如下:

key 值类型长度/取值范围描述
nameString长度不超过 64 个字符群名称
introductionString长度不超过 512 个字符群简介
announcementString长度不超过 1024 个字符群公告
portraitUrlString长度不超过 128 个字符群头像地址

permissions 中的 key 如下:

key 值类型长度/取值范围描述
joinPermNumber取值范围:
  • 0:需要群主验证(默认)
  • 1:不用验证
  • 2:群管理员或群主验证
  • 3:不允许任何人加入
加入群权限
removePermNumber取值范围:
  • 0:群主(默认)
  • 1:群主+群管理员
  • 2:所有人
将群成员移出群组权限
memInvitePermNumber取值范围:
  • 0:群主(默认)
  • 1:群主+群管理员
  • 2:所有人
邀请他人入群权限
invitePermNumber取值范围:
  • 0:不需要被邀请人同意(默认)
  • 1:需要被邀请人同意
邀请加入群组处理方式
profilePermNumber取值范围:
  • 0:群主(默认)
  • 1:群主+群管理员
  • 2:所有人
修改群资料及权限
memProfilePermNumber取值范围:
  • 0:群主+群管理员+自己(默认)
  • 1:群主+自己
  • 2:仅自己
设置群成员资料权限

请求示例

HTTP
POST /entrust/group/profile/update.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=testGroupId&groupProfile={"introduction":"群简介","name":"群名字"}

返回结果

HTTP 响应正文包含具有以下结构的 JSON 对象:

返回值返回类型说明
codeNumber业务状态码。200 表示操作成功。

返回结果示例

HTTP
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
"code": 200
}