跳到主要内容

设置群成员信息之前的回调

功能说明

App 业务服务端可以通过该回调查看修改后的群成员信息,。

注意事项

  • 为启用回调,必须配置回调 URL,并开启本条回调协议对应的开关。配置方法详见 回调说明 文档。
  • 回调的方向是 OpenIMServer 向 App 后台发起 HTTP/HTTPS POST 请求。
  • APP 业务服务端需在超时时间内响应此请求。

可能触发该回调的场景

  • 群管理员通过客户端修改群成员相关的信息。

回调发生时机

  • OpenIMServer 准备更新群成员信息之前。

接口说明

请求 URL 示例

此处CallbackCommand为:callbackBeforeSetGroupMemberInfoCommand

{WEBHOOK_ADDRESS}/callbackBeforeSetGroupMemberInfoCommand?contenttype=json

请求包示例

{
"callbackCommand": "callbackBeforeSetGroupMemberInfoCommand",
"groupID": "12345",
"userID": "user789",
"nickName":"user",
"faceURL": "http://example.com/path/to/face/image.png",
"roleLevel": 20,
"ex": "Extra data"
}

请求包字段说明

对象类型描述
callbackCommandstring回调命令,这里是创建群组之前的回调
groupIDstring群组的唯一标识符
userIDstring加入群组的用户ID。
nickName*string加入群组的用户呢称。
faceURL*string群成员图标的URL
roleLevel*int32加入群组用户的权限级别。普通成员(20)或管理员(60)
ex*string额外的数据字段

应答包示例

允许修改

{
"actionCode": 0,
"errCode": 0,
"errMsg": "",
"errDlt": "",
"nextCode": 0,
"ex": "Some extra data",
"nickName":"user",
"faceURL": "http://example.com/path/to/face/image.png",
"roleLevel": 20
}

应答包字段说明

字段说明
actionCode0表示业务系统的回调是否正确执行。0表示操作成功。
errCode5001表示自定义错误码,范围在5000-9999之间。在 actionCode 不等于0时设置;在 nextCode 等于1时设置。
errMsg"An error message"自定义错误码对应的简单错误信息。
errDlt"Detailed error information"自定义错误码对应的详细错误信息。
nextCode1下一步执行指令,1表示拒绝继续执行,actionCode 等于0时设置。
ex*string额外的数据字段
nickName*string加入群组的用户呢称。
faceURL*string群成员图标的URL
roleLevel*int32加入群组用户的权限级别。普通成员(20)或管理员(60)