创建群组/聊天室事件
大约 3 分钟
REST API
创建群组/聊天室事件
成功创建群组或聊天室后,环信服务器会按照发送后回调规则向你的 App Server 发送回调请求,App Server 可通过该回调查看创建的群组/聊天室的信息,进行数据同步。
提示
回调时机
- 客户端创建了群组/聊天室。
- 调用 RESTful API 创建了群组/聊天室。
- 在环信控制台上创建了群组/聊天室。
回调请求
请求示例
下面的请求示例为创建群组的事件,创建聊天室的字段与其相同。
{
"callId": "XXXX#XXXX_cfc0d78c-XXXX-XXXX-b687-8b84107a798b",
"security": "4930bcf03103aXXXX632eadd9b36b6c7",
"payload": {
"role": {
"tst": "owner",
"abc": "admin"
},
"member": ["abc"],
"info": {
"owner": "XXXX#XXXX_tst",
"created": "1729496598199",
"custom": "",
"description": "描述",
"mute": "false",
"mute_duration": -1,
"avatar": "https://XXXX/XXXX/XXXX",
"title": "测试01",
"max_users": "200",
"invite_need_confirm": "true",
"public": "true",
"allow_user_invites": "false",
"disabled": "false",
"last_modified": "1729496598199"
}
},
"appkey": "XXXX#XXXX",
"id": "262246968131585",
"type": "GROUP",
"event": "group_op_event",
"operation": "CREATE",
"operator": "tst",
"timestamp": 1729496598231
}
请求字段说明
以下以创建群组的事件为例进行介绍,聊天室的字段与其相同。
字段名称 | 类型 | 描述 |
---|---|---|
callId | String | callId 为每个回调请求的唯一标识,格式为 App Key_UUID 。 |
security | String | 签名,格式如下: MD5(callId+secret+timestamp) 。详见配置环信控制台回调规则。 |
payload | Object | 事件内容。 |
payload.role | JSON | 群组角色。若设置了管理员,显示管理员角色,若未设置,则只显示群组角色: - 用户 ID: owner - 用户 ID: admin |
payload.member | Array | 创建群组时拉入群的用户。 |
payload.info | JSON | 新群组的相关信息。 - owner :String 类型,群主。- created :Long 类型,群组创建时间。- custom :String 类型,群组自定义信息。- description :String 类型,群组描述。- mute :Bool 类型,是否进行全员禁言,true 表示是,false 表示否。- mute_duration :Long 类型,全员禁言时长,从当前时间开始计算。单位为秒。0 表示取消禁言,-1 表示永久禁言。- avatar :String,群组头像 URL。- title :String 类型,群组名称。- max_users :群组最大成员数(包括群主)。- invite_need_confirm :Bool 类型,邀请用户入群时是否需要被邀用户同意,true 表示需要被邀用户同意,false 表示不需要。- public :Bool 类型,是否是公开群, true 表示公开群,false 表示私有群。- allow_user_invites :Bool 类型,是否允许普通群成员邀请用户加入群组,true 表示允许,false 表示不允许,只有群主和群管理员才能邀请用户入群。- disabled :Boolean 类型,true 表示群组为禁用状态,false ,表示群组为非禁用状态,可正常使用。 - last_modified :Long 类型,群组信息的最新修改时间。 |
appkey | String | 你在环信管理后台注册的应用唯一标识。 |
id | String | 群组/聊天室 ID。 |
type | String | 区分群组或聊天室事件: - GROUP :群组 - CHATROOM :聊天室 |
event | String | 对于群组和聊天室,该参数的值固定为 group_op_event 。接收方可按此字段区分是否是群组/聊天室操作事件。 |
operation | String | 操作。创建群组的操作为 CREATE 。 |
operator | String | 操作人。若 app 管理员创建了群组,该参数的值固定为 @ppAdmin 。 |
timestamp | Long | 操作完成的时间戳。 |