本文介绍群成员添加回调(Callback.AddGroupMember)的功能说明、请求参数、返回数据和示例。

功能说明

客户端发起的群成员添加调用时,AIMServer会回调AppServer,业务方可校验加人操作是否允许。

请求参数

名称 类型 是否必选 示例值 描述
operatorAppUid String 1001 添加者用户ID。
appCid String $2$111100008 群聊会话ID。
initMembers Array 添加的成员信息。
appUid String 10001 被添加的群成员用户ID。
role Integer 2 群成员角色。取值:
  • 1:群主。
  • 2:管理员。
  • 3:普通成员。
  • 100~127:自定义角色。
nick String test 群成员昵称。
joinTime Long 1613700223555 群成员加入时间。时间戳,单位:毫秒。不填默认为当前时间。
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的解释。

请求示例

{
  "operatorAppUid": "1001",
  "appCid": "12345",
  "initMembers": 
  [
    {
      "nick": "test",
      "role": 2,
      "joinTime": 1613700223555,
      "appUid": "10001",
    }
  ],
  "bizCtx": {
    "key": "value"
  },
  "paasCtx": {
    "key": "value"
  }
}

返回示例

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