事件回调
当其他服务需要知道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 | 否 | 消息提醒对象列表 |
| messageId | 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是黑名单，3是extra信息 |
| 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 | 否 | 用户手机号码 |
| 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
10. 创建会议回调
当创建会议时进行回调
10.0.1. body
| 参数 | 类型 | 必需 | 描述 |
|---|---|---|---|
| userId | string | 否 | 创建用户ID，当客户端创建时为用户id，当server api操作会议时为空 |
| roomId | string | 是 | 会议室Id |
| serverId | string | 否 | 会议室所在服务的服务id，当超级会议时会议室Id为空 |
| description | string | 是 | 会议描述 |
| pin | string | 是 | 会议密码 |
| max_publishers | int | 是 | 最大交互成员数 |
| bitrate | int | 是 | 最大码率 |
| advance | bool | 是 | 是否是超级会议 |
| recording | bool | 是 | 是否服务器端录制 |
10.0.2. 响应
http code 200
11. 销毁会议回调
当销毁会议时进行回调
11.0.1. body
| 参数 | 类型 | 必需 | 描述 |
|---|---|---|---|
| userId | string | 否 | 创建用户ID，当客户端创建时为用户id，当server api操作会议时为空 |
| roomId | string | 是 | 会议室Id |
11.0.2. 响应
http code 200
12. 加入会议回调
当成员加入会议时进行回调
12.0.1. body
| 参数 | 类型 | 必需 | 描述 |
|---|---|---|---|
| userId | string | 是 | 用户ID |
| roomId | string | 是 | 会议室Id |
12.0.2. 响应
http code 200
13. 离开会议回调
当成员离开会议时进行回调
13.0.1. body
| 参数 | 类型 | 必需 | 描述 |
|---|---|---|---|
| userId | string | 是 | 用户ID |
| roomId | string | 是 | 会议室Id |
13.0.2. 响应
http code 200
14. 会议成员发布回调
当会议成员发布回调时进行回调
14.0.1. body
| 参数 | 类型 | 必需 | 描述 |
|---|---|---|---|
| userId | string | 是 | 用户ID |
| video | bool | 是 | 是否开启视频 |
| roomId | string | 是 | 会议室Id |
14.0.2. 响应
http code 200
15. 成员取消发布回调
当成员取消发布回调时进行回调
15.0.1. body
| 参数 | 类型 | 必需 | 描述 |
|---|---|---|---|
| userId | string | 是 | 用户ID |
| roomId | string | 是 | 会议室Id |
15.0.2. 响应
http code 200