本文介绍群聊创建回调(Callback.CreateGroup)的功能说明、请求参数、返回数据和示例。

功能说明

客户端发起的群聊会话创建调用时, AIMServer会回调AppServer,通过返回值告知该群是否可以创建。

请求参数

名称 类型 是否必选 示例值 描述
creatorAppUid String 1001 创建者用户ID,默认为群主。
initMembers Array 创建群时的初始化成员。
appUid String 1001 群成员用户ID。
role Integer 1 群成员角色。取值:
  • 1:群主。
  • 2:管理员。
  • 3:普通成员。
  • 100~127:自定义角色。
nick String Bob 群成员昵称。
joinTime Long 1613700223555 群成员加入时间。时间戳,单位:毫秒。不填默认为当前时间。
title String 一个群名称 群名称。
iconMediaId String $iQEMAqNqcGcDAQTNAyAFzQJYBtoAIYQBpAuf1dQCqrY4aIGemoBLONIDzwAAAXazCVSoBM0NyAcACAAKAB 群头像MediaId。
extensions Map<String, String> {"ext_k1":"ext_v1"} 消息扩展信息。
bizCtx Map<String, String> {"biz_k1":"biz_v1"} AppClient传递给AppServer信息,PaaS平台不做处理。
paasCtx Map<String, String> {"paas_k1":"paas_v1"} PaaS平台信息。包括发起端的信息,目前包括以下key:
  • appKey
  • sdkVersion

返回数据

名称 类型 示例值 描述
result object 返回结果。
allow Boolean true 群聊是否允许创建。取值:
  • true:允许。
  • false:不允许。
code String 0xx 不允许创建时的返回码。

allow为true时会被忽略,为false时必填。

reason String security filter 错误原因。关于code的解释。

请求示例

{
  "creatorAppUid": "1001",
  "initMembers": 
  [
    {
      "appUid": "1001",
      "nick": "Bob",
      "role": 1,
      "joinTime": 1613700223555
    }
  ],
  "title": "一个群名称",
  "iconMediaId": "$iQEMAqNqcGcDAQTNAyAFzQJYBtoAIYQBpAuf1dQCqrY4aIGemoBLONIDzwAAAXazCVSoBM0NyAcACAAKAB",
  "extensions": {
    "key": "value"
  },
  "bizCtx": {
    "key": "value"
  },
  "paasCtx": {
    "key": "value"
  }
}

返回示例

{
  "result":
  {
    "allow": true,
    "code": "0xx", 
    "reason": "security filter",
  }
}