本文介绍群成员删除回调(Callback.RemoveGroupMember)的功能说明、请求参数、返回数据和示例。
功能说明
客户端发起的群成员删除调用时,AIMServer会回调AppServer,业务方校验踢人操作是否允许。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
operatorAppUid | String | 是 | 1001 | 操作用户ID。 |
appCid | String | 是 | $2$111100008 | 群聊会话ID。 |
initMembers | List<String> | 是 | ["111", "222"] | 删除的成员用户ID列表。 |
bizCtx | Map<String, String> | 否 | {"biz_k1":"biz_v1"} | AppClient传递给AppServer信息,PaaS平台不做处理。 |
paasCtx | Map<String, String> | 否 | {"paas_k1":"paas_v1"} | PaaS平台信息。包括发起端的信息,目前包括以下key:
|
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
result | object | 返回结果。 | |
allow | Boolean | true | 是否允许删除群成员。取值:
|
code | String | 0xx | 不允许删除时的返回码。
allow为true时会被忽略,为false时必填。 |
reason | String | security filter | 错误原因。关于code的解释。 |
请求示例
{
"operatorAppUid": "1001",
"appCid": "$2$111100008",
"appUidsRemoved": ["111", "222"],
"bizCtx": {
"key": "value"
},
"paasCtx": {
"key": "value"
}
}
返回示例
{
"data": {
"result": {
"allow": true,
"code": "0xx",
"reason": "security filter",
}
}
}