事件回调

当其他服务需要知道IM服务中下述信息变动时,可以配置对应回调,当对应事件发生时,IM服务会推送事件到指定地址。需要注意的时IM服务内使用单线程推送,如果处理耗时较长,会产生较大延迟和拖累IM服务的性能。建议服务器放到同一内网减少网络延迟,接收服务异步处理快速返回,不能处理完再返回

1. 设置事件回调

请参考配置说明

2. 接收消息回调

当服务收到发送消息请求后,把消息推送到配置指定的服务去。

2.0.1. body

参数 类型 必需 描述
sender string 发送者ID
conv json 会话
conv.type int 会话类型
conv.target string 会话目标
conv.line int 会话线路,缺省为0
payload json 消息负载
payload.type int 消息类型
payload.searchableContent string 消息可搜索内容
payload.pushContent string 消息推送内容
payload.pushData string 消息推送数据
payload.content string 消息内容
payload.base64edData string 消息二进制内容,base64编码
payload.mediaType int 媒体消息类型
payload.remoteMediaUrl string 媒体内容链接
payload.expireDuration long 消息过期时间
payload.mentionedType int 消息提醒类型
payload.mentionedTarget string list 消息提醒对象列表
messageUid long 消息唯一ID
timestamp long 服务器处理时间

2.0.2. 响应

http code 200

3. 用户在线状态回调

当用户上线/下线时,会通知到配置指定的服务器去

3.0.1. body

参数 类型 必需 描述
userId string 用户ID
clientId string client ID
platform int 平台
status int 状态。0 下线;1 上线; -1 客户端调用logout
packageName string 应用包名
timestamp long 时间戳

3.0.2. 响应

http code 200

4. 群组信息变动回调

当用户创建/修改/销毁群组时触发。

4.0.1. body

参数 类型 必需 描述
userId string 操作的用户
type int 0是创建,1是修改属性,2转移群组,3是禁言群组,4是取消禁言群组,5是销毁群组
groupId string 群组ID

4.0.2. 响应

http code 200

5. 群组成员变动回调

当群组成员修改状态时触发。

5.0.1. body

参数 类型 必需 描述
operatorId string 操作者用户ID
groupId string 群组ID
memberId string 群成员ID
type int 0加入群组,1主动离开群组,2被移出群组,3群成员状态改变,4修改群昵称
value string 当type为4时为群昵称,type为3时值为群成员新的状态

群组成员状态0,普通群成员;1,管理员;2,群主;3,禁言;5,白名单

5.0.2. 响应

http code 200

6. 用户关系变动回调

当用户修改用户关系时。

6.0.1. body

参数 类型 必需 描述
userId string 用户ID
targetId string client ID
type int 0是好友关系,1是昵称,2是黑名单
value string type为0时,“0”是非好友;“1”是好友。type为1时值为昵称。type2时,“0”非黑名单,“1”拉黑

6.0.2. 响应

http code 200

7. 用户信息变更回调

当用户修改用户信息时。

7.0.1. body

参数 类型 必需 描述
userId string 用户ID
name string 帐号名
displayName string 显示名字
portrait string 用户头像
mobile string 用户手机号码
email string 用户邮箱
address string 用户地址
company string 用户公司
extra string 附加信息

7.0.2. 响应

http code 200

8. 频道订阅状态变更回调

当用户订阅/取消订阅时进行回调

8.0.1. body

参数 类型 必需 描述
userId string 用户ID
channelId string 频道Id
status int 0,取消订阅;1,订阅。

8.0.2. 响应

http code 200

9. 聊天室回调

当用户加入/退出时进行回调

9.0.1. body

参数 类型 必需 描述
userId string 用户ID
chatroomId string 聊天室Id
status int 0,退出;1,加入。

9.0.2. 响应

http code 200

2018 © wildfirechat.cn 京ICP备18060403号-1 all right reserved,powered by Gitbook该文件修订时间: 2020-10-19 10:25:59

results matching ""

    No results matching ""