====== 回调过滤规则设置 ======
''本文档已不再维护,新版文档见:[[ccim:rest:callbackconfig|发送后事件回调过滤规则设置]]。''
通过回调过滤规则的设置,可以根据需求选择回调中的有用信息。如需使用请联系商务。
回调过滤规则如下:
|项目|设置内容|
|`msgType`|设置回调消息类型,包括:上行消息、离线消息|
|`interested`
`ignored`|设置回调事件,支持感兴趣的和忽略的事件。如:需要所有单聊中除CMD消息的回调事件, `"interested":[ "chat"],"ignored":cmd"`。回调事件列表见下|
|`groupIds`|设置群ID|
|`froms`|设置发送人|
|`tos`|设置接收人|
|`containsExtProperties`|消息扩展中包含字段|
|`extProperty`
`extValues`|两个字段结合使用,对消息扩展中字段为`extProperty`,且值包含在`extValues`中的消息进行过滤。|
====== 回调事件 ======
===== 单聊 =====
|事件|payload中类型|触发事件|
|chat|-|单聊中所有事件|
|chat:txt|{"bodies":{"type":"txt"}}|单聊中发文本消息|
|chat:img|{"bodies":{"type":"img"}}|单聊中发图片消息|
|chat:audio|{"bodies":{"type":"audio"}}|单聊中发语音消息|
|chat:loc|{"bodies":{"type":"loc"}}|单聊中发位置消息|
|chat:video|{"bodies":{"type":"video"}}|单聊中发视频消息|
|chat:file|{"bodies":{"type":"file"}}|单聊中发文件消息|
|chat:cmd|{"bodies":{"type":"cmd"}}|单聊中发命令消息|
|chat:custom|{"bodies":{"type":"custom"}}|单聊中发自定义消息|
|chat:unknown|{"bodies":{"type":"unknown"}}|单聊中发未知消息|
===== 群聊 =====
|事件|payload中类型|触发时间|
|groupchat|-|群聊中所有事件|
|groupchat:txt|{"bodies":{"type":"txt"}}|群聊中发文本消息|
|groupchat:img|{"bodies":{"type":"img"}}|群聊中发图片消息|
|groupchat:audio|{"bodies":{"type":"audio"}}|群聊中发语音消息|
|groupchat:loc|{"bodies":{"type":"loc"}}|群聊中发位置消息|
|groupchat:video|{"bodies":{"type":"video"}}|群聊中发视频消息|
|groupchat:file|{"bodies":{"type":"file"}}|群聊中发文件消息|
|groupchat:cmd|{"bodies":{"type":"cmd"}}|群聊中发命令消息|
|groupchat:custom|{"bodies":{"type":"custom"}}|群聊中发自定义消息|
|groupchat:unknown|{"bodies":{"type":"unknown"}}|群聊中发未知消息|
===== 聊天室 =====
|事件|payload中类型|触发时间|
|chatroom|-|聊天室中所有事件|
|chatroom:txt|{"bodies":{"type":"txt"}}|聊天室中发文本消息|
|chatroom:img|{"bodies":{"type":"img"}}|聊天室中发图片消息|
|chatroom:audio|{"bodies":{"type":"audio"}}|聊天室中发语音消息|
|chatroom:loc|{"bodies":{"type":"loc"}}|聊天室中发位置消息|
|chatroom:video|{"bodies":{"type":"video"}}|聊天室中发视频消息|
|chatroom:file|{"bodies":{"type":"file"}}|聊天室中发文件消息|
|chatroom:cmd|{"bodies":{"type":"cmd"}}|聊天室中发命令消息|
|chatroom:custom|{"bodies":{"type":"custom"}}|聊天室中发自定义消息|
|chatroom:unknown|{"bodies":{"type":"unknown"}}|聊天室中发未知消息|
===== 消息撤回 =====
|事件|payload中类型|触发时间|
|recall|无|进行消息撤回|
===== 群组和聊天室操作 =====
注意:目前muc:create仅在开通多设备服务后,才支持回调。
|事件|payload中类型|触发时间|
|muc|-|群聊和聊天室操作所有事件|
|muc:create|{"operation":"create"}|创建群/聊天室|
|muc:destroy|{"operation":"destroy"}|删除群/聊天室|
|muc:apply|{"operation":"apply"}|成员申请加入群/聊天室|
|muc:apply_accept|{"operation":"apply_accept"}|同意成员加群申请|
|muc:invite|{"operation":"invite"}|邀请成员加入群|
|muc:invite_accept|{"operation":"invite_accept"}|被邀请成员同意加入群|
|muc:invite_decline|{"operation":"invite_decline"}|被邀请成员拒绝加入群|
|muc:kick|{"operation":"kick"}|踢出群/聊天室|
|muc:ban|{"operation":"ban"}|封禁群/聊天室成员|
|muc:allow|{"operation":"allow"}|解除群/聊天室成员封禁|
|muc:update|{"operation":"update"}|群/聊天室信息修改|
|muc:block|{"operation":"block"}|用户屏蔽群/聊天室|
|muc:unblock|{"operation":"unblock"}|用户解除屏蔽群/聊天室|
|muc:presence|{"operation":"presence"}|成员进群/聊天室|
|muc:absence|{"operation":"absence"}|成员离开群/聊天室|
|muc:leave|{"operation":"leave"}|离开群/聊天室|
|muc:assing_owner|{"operation":"assing_owner"}|转让群/聊天室|
|muc:add_admin|{"operation":"add_admin"}|添加群/聊天室管理员|
|muc:remove_admin|{"operation":"remove_admin"}|删除群/聊天室管理员|
|muc:add_mute|{"operation":"add_mute"}|将群/聊天室成员禁言|
|muc:remove_mute|{"operation":"remove_mute"}|将群/聊天室成员解除禁言|
|muc:update_announcement|{"operation":"update_announcement"}|更新群/聊天室公告|
|muc:delete_announcement|{"operation":"delete_announcement"}|删除群/聊天室公告|
|muc:upload_file|{"operation":"upload_file"}|上传群文件|
|muc:delete_file|{"operation":"delete_file"}|删除群文件|
|muc:add_user_white_list|{"operation":"add_user_white_list"}|用户加入群白名单|
|muc:remove_user_white_list|{"operation":"remove_user_white_list"}|用户移除群白名单|
|muc:ban_group|{"operation":"ban_group"}|群/聊天室全局禁言|
|muc:remove_ban_group|{"operation":"remove_ban_group"}|解除群/聊天室全局禁言|
===== 好友关系操作 =====
|事件|payload中类型|触发事件|
|roster|-|好友关系操作所有事件|
|roster:add|{"operation":"add"}|添加好友|
|roster:remove|{"operation":"remove"}|删除好友|
|roster:accept|{"operation":"accept"}|同意好友申请|
|roester:decline|{"operation":"decline"}|拒绝好友申请|
|roster:ban|{"operation":"ban"}|拉黑好友|
|roster:allow|{"operation":"allow"}|解除拉黑好友|
|roster:remote_accept|{"operation":"remote_accept"}|远程同意|
|roster:remote_decline|{"operation":"remote_decline"}|远程拒绝|
===== ack事件 =====
|事件|payload中类型|触发事件|
|read_ack|无|已读ack|
|delivery_ack|无|投递ack|
===== 用户登入登出 =====
|事件|payload中类型|触发事件|
|userStatus|-|用户在线状态变更事件|
|userStatus:login|{"status":"online","reason":"login"}|用户登录|
|userStatus:logout|{"status":"offline","reason":"logout"}|用户登出|
|userStatus:replaced|{"status":"offline","reason":"replaced"}|用户登出|
===== 敏感词监测 =====
|事件|payload中类型|触发事件|
|sensitiveWords|-|敏感词所有事件|
|sensitiveWords:intercepted|{"alertReason":"intercepted"}|因为触发敏感词被拦截|