回调通知分为事件发生前和事件发生后两类：

• 事件发生前：该事件由客户端发起请求，IM 服务端将该请求传给业务服务端，业务服务端可在 Response 中对客户端发起请求进行修改。
• 事件发生后：该事件已在客户端完成，IM 服务端将该事件通知给业务服务端，业务服务端无法对该事件进行修改。

注意：通过服务端openapi发起的请求不会触发 "事件发生前" 回调，仅会触发 "事件发生后" 的回调。

回调通知服务支持的事件有：

• 事件发生前：
  • 消息发送前：BeforeSendMessage
  • 创建群聊前：BeforeCreateConversation
  • 添加群成员前：BeforeAddParticipant
  • 创建单聊前：BeforeCreateSingleConversation
  • 移除群聊用户前：BeforeRemoveParticipant
  • 更新群聊信息前：BeforeUpdateConversation
  • 修改群成员详情前：BeforeUpdateParticipant
  • 修改用户对群设置前：BeforeUpdateSetting
• 事件发生后：
  • 群成员离开会话后：AfterRemoveParticipant
  • 群成员加入会话后：AfterAddParticipant
  • 直播群群成员在群状态变化：ParticipantStateChange
  • 成员在线状态变化：OnlineStateChange
  • 创建会话后：AfterCreateConversation
  • 消息在线推送后：AfterPush
  • 消息发送后：AfterSendMessage
  • 消息属性修改后：AfterSetProperty

BeforeSendMessage

消息发送前。
该回调支持单聊、普通群和直播群。

MessageBody

RefMsgInfo

{
  "AppId": 000000, 
  "InboxType": 0, 
  "MessageBody": {
    "Content": "Your_Content",
    "ConversationShortId": 000001, 
    "ConversationType": 2, 
    "Ext": { 
      "key":"value"
    },
    "MsgType": 10001, 
    "Sender": 000010, 
    "MessageId": 000012,
    "MentionedUsers":[],
    "MessagePriority":1
  },
  "RefMsgInfo": { 
    "Content": "Your_Content", 
    "Hint": "[图片]", 
    "InvisibleUsers": [], 
    "VisibleUsers": [], 
    "ReferenceMessageId": 000013, 
    "ReferenceMessageType": 10001, 
    "Status": 0  
  },
  "ToId": 000011,
  "ClientMessageId":"ClientMessageId",
  "Header":{
    "IP":"xxxxx"
  }
}
json

此条消息最终会以业务服务端传入的Ext，Content、InvisibleUsers 或 VisibleUsers 的值为准，如果不想修改用户传入原始的Content等字段，这些值传 null或者Response的json中不出现此字段。

MessageBody

{
    "CheckCode":0, 
    "CheckMessage":"" 
    "MessageBody":{
        "Ext":null, 
        "Content":null,
        "VisibleUsers":null, 
        "InVisibleUsers":null,
        "MentionedUsers":null,
        "MessagePriority":1
    }
}
json

BeforeCreateConversation

创建群聊前。
该回调支持普通群和直播群。

{
  "AppId": 000000, 
  "Description": "Your_Description", 
  "AvatarUrl": "http://xxx.com", 
  "Name": "Conversation", 
  "InboxType": 0, 
  "ParticipantUserIds": [
    10001,
    10002
  ],
  "OwnerUserId": 10001,
  "Ext": { 
    "key":"value"
	}
}
json

若想修改 IM 服务端传入的ValidParticipantUserIds，InValidParticipantUserIds、Name 、AvatarUrl 、Description 或 Ext 的值，可在 Response 中传入，否则这些值均不传或传 null。

InValidParticipantUserIds 暂时无意义，但建议设置。

{
    "CheckCode": 0,
    "CheckMessage": "",
    "ValidParticipantUserIds":[10001,10002,10004], 
    "InValidParticipantUserIds":[10003],
    "Name":"Newconversation",
    "AvatarUrl":"http://xxx.xxx.com",
    "Description":"new_Description",
    "Ext": { 
      "key":"value"
    }
}
json

BeforeAddParticipant

添加群成员前。
该回调仅支持普通群。

{
  "AppId": 000000, 
  "ConversationShortId": 000001, 
  "InboxType": 0, 
  "ParticipantUserIds": [ 
    10009
  ],
  "Operator": 100001 
}
json

若想修改 IM 服务端传入的ValidParticipantUserIds 或 InValidParticipantUserIds的值，可在 Response 中传入，否则这些值均不传或传 null。

InValidParticipantUserIds 暂时无意义，但建议设置。

{
    "CheckCode": 0,
    "CheckMessage": "",
    "ValidParticipantUserIds":[10010], 
    "InValidParticipantUserIds":[10003] 
json

BeforeCreateSingleConversation

创建单聊前。
该回调仅支持单聊。

{
  "AppId": 000000, 
  "OwnerUserId": 10001, 
  "ParticipantUserIds": [ 
    10001，
    10002
  ]
  "Ext": { 
    "key":"value"
	} 
}
json

若想修改 IM 服务端传入的Ext 的值，可在 Response 中传入，否则这些值均不传或传 null。

InValidParticipantUserIds 暂时无意义，但建议设置。

{
    "CheckCode": 0,
    "CheckMessage": "",
    "Ext": { 
      "key":"value"
    }
json

BeforeRemoveParticipant

移除群聊用户前。
该回调仅支持普通群。

{
  "AppId": 000000,
  "ConversationShortId": 000001, 
  "ParticipantIds": [ 
    10002
  ],
  "Operator": 100001 
}
json

若想修改 IM 服务端传入的ValidParticipantUserIds 或 InValidParticipantUserIds的值，可在 Response 中传入，否则这些值均不传或传 null。

{
    "CheckCode": 0,
    "CheckMessage": ""
    "ValidParticipantUserIds":[10002],
    "InValidParticipantUserIds":[10003]
}
json

BeforeUpdateConversation

更新群聊信息前。
该回调支持单聊、普通群和直播群。

若某个字段并没有修改，则 EventData 中并不会出现该字段。

{
  "AppId": 000000,
  "ConversationShortId": 000001, 
  "ConversationType": 2,   
  "Description": "000001",
  "AvatarUrl": http://xxx.com,
  "Name": "Conversation",
  "Notice": Your_Notice,
	"Ext": { 
	  "key":"value"
	}
  "Operator":100001
}
json

若想修改 IM 服务端传入的Name、Description、AvatarUrl、Notice 或 Ext的值，可在 Response 中传入，否则这些值均不传或传 null。

{
    "CheckCode": 0,
    "CheckMessage": ""
    "Name":"New_Conversation",
    "Description":"New_Description",
    "AvatarUrl":"http://xxx.xxx.com",
    "Notice":"New_Notice",
	  "Ext": { 
	    "key":"value"
		}
}
json

BeforeUpdateParticipant

修改群成员详情前。
该回调仅支持普通群和直播群。

若某个字段并没有修改，则 EventData 中并不会出现该字段。

UpdateParticipant

{
  "AppId": 000000,
  "ConversationShortId": 000001,
  "ConversationType": 2,
  "Operator": 10002, 
  "UpdateParticipants":[{
      "ParticipantUserId":10006,
      "Role": 2, 
      "NickName":"Your_NickName", 
      "AvatarUrl":"http://xxx.com",
      "MarkTypes":["mark1","mark2"] 
  }]
}
json

{
    "CheckCode": 0,
    "CheckMessage": ""
}
json

BeforeUpdateSetting

修改用户对群设置前。
该回调支持单聊和普通群。

若某个字段并没有修改，则 EventData 中并不会出现该字段。

{
  "AppId": 000000,
  "ConversationShortId": 000001,
  "ConversationType": 2,
  "IsMute": true 
  "IsSetTop":true 
  "IsSetFavorite" : true
  "Ext": { 
    "key":"value"
	}
  "ParticipantUserId": 10001
}
json

若想修改 IM 服务端传入的Ext的值，可在 Response 中传入，否则这些值均不传或传 null。

{
    "CheckCode": 0,
    "CheckMessage": "",
    "Ext": { 
      "key":"value"
    }
}
json

AfterRemoveParticipant

群成员离开会话后，包括主动离开会话和被移除会话。
该回调支持普通群和直播群。

{
    "AppId":000000, 
    "ConversationShortId":000001, 
    "ConversationType":100,
    "InboxType":0, 
    "ParticipantUserIds":[ 
        10001
    ],
    "Operator":100001 
}
json

{
    "CheckCode": 0,
    "CheckMessage": ""
}
json

AfterAddParticipant

群成员加入会话后
该回调支持普通群和直播群。

Participant

{
    "AppId":000000, 
    "ConversationShortId":000001, 
    "ConversationType":2,
    "InboxType":0, 
    "Operator":10001, 
    "Participants":[
        {
            "ParticipantUserId":10001, 
            "Level":0, 
            "NickName":"Your_NickName", 
            "Role":1, 
            "Ext":{"key":"value"} 
        }
    ]
}
json

{
    "CheckCode": 0,
    "CheckMessage": ""
}
json

ParticipantStateChange

直播群成员在群状态发生变化。
该回调仅支持直播群。
该回调只会在以下两种情况下触发：

• 用户进入直播群之后，未正常退群，并且网络中断超过 120s。
• 用户进入直播群之后，未正常退群，网络中断超过 120s 后，重新上线。

若同一个登录用户使用多台设备同时加入到同一个直播间时，只有当所有设备同时掉线才会触发掉线事件。当任一设备恢复上线时会触发该回调，后续其他设备登录不会触发该回调。

{
    "AppId":000000, 
    "ConversationShortId":000001, 
    "ConversationType":100, 
    "InboxType":0, 
    "ParticipantUserIds":[ 
        10003
    ],
    "StateChangeType":2 
}
json

{
    "CheckCode": 0,
    "CheckMessage": ""
}
json

OnlineStateChange

用户状态发生变化。
该回调与会话无关，为用户自身在应用中状态。

Event

{
    "AppId":000000,
    "Events":[
        {
            "AppId":000000, 
            "UserId":10001, 
            "EventTime":1683357800192, 
            "EventType":1, 
            "ConnId":"Your_ConnId", 
            "DeviceId":10002 
        }
    ]
}
json

{
    "CheckCode": 0,
    "CheckMessage": ""
}
json

AfterCreateConversation

会话创建后。
该回调支持单聊、普通群和直播群。

{
    "AppId":000000, 
    "ConversationShortId":000001, 
    "ConversationType":100, 
    "InboxType":0, 
    "Description": "Your_Description", 
    "AvatarUrl": "http://xxx.com", 
    "Name": "Conversation", 
    "CreateTime": 1666598278, 
    "Ext": { 
      "key":"value"
    "OwnerUserId": 10001,
    "ToUserId": 000001
}
json

{
    "CheckCode": 0,
    "CheckMessage": ""
}
json

AfterPush

将客户端发送的消息在线推送后
该回调支持单聊和普通群
普通群中，消息在线推送给所有群成员，每个群成员均会触发一次回调。

MessageBody

RefMsgInfo

SuccessPushResult

{
    "AppId":000000, 
    "ToId":100002, 
    "InboxType":0, 
    "MessageBody":{
        "ConversationType":2, 
        "Content":"Your_Content", 
        "ConversationShortId":000001, 
        "MsgType":10001, 
        "Sender":000010, 
        "Ext":{ 
            "key":"value"
        },
        "MessageId":000012
    },
    "RefMsgInfo":{
        "ReferenceMessageId":000013, 
        "Hint":"[图片]", 
        "ReferenceMessageType":10001, 
        "Status":0 
    },
    "SuccessPushResult":[ 
        {
            "Platform":"Platform_IOS",
            "ConnId":"ConnId_1" 
        },
        {
            "Platform":"Platform_Web",
            "ConnId":"ConnId_2"
        }
    ],
    "IsPushSuccess":false, 
    "IsMute":false 
}
json

{
    "CheckCode": 0,
    "CheckMessage": ""
}
json

AfterSendMessage

消息发送成功且存入数据库后

该回调支持单聊、普通群和直播群

MessageBody

RefMsgInfo

{
  "AppId": 000000, 
  "FromId": 100002, 
  "InboxType": 0, 
  "MessageBody": {
    "Content": "Your_Content",
    "ConversationShortId": 000001, 
    "ConversationType": 1, 
    "Ext": { 
      "key":"value"
    },
    "MsgType": 10001, 
    "Sender": 000010, 
    "MessageId": 0000111, 
    "IndexInConversation": 1111111222 
  },
  "RefMsgInfo": { 
    "Hint": "1", 
    "ReferenceMessageId": 0000122, 
    "ReferenceMessageType": 10001, 
    "Status": 0 
  },
  "ToId": 000010,
  "Header":{
    "IP": "180.184.92.210",
    "DevicePlatform": "android",
    "OsVersion": "10",
    "DeviceType": "ANA-AN00"
  }
}
json

{
    "CheckCode": 0,
    "CheckMessage": ""
}
json

AfterSetProperty

消息属性修改后。

该回调支持单聊和群聊。

MessageBody

PropertyItem

ModifyProperty

{
    "AppId":000000, 
    "InboxType":0, 
    "ConversationShortId":000001, 
    "ConversationType":2, 
    "MessageBody":{
        "ConversationType":2, 
        "Content":"{"text":"text"}", 
        "ConversationShortId":000001, 
        "MsgType":10001, 
        "Sender":000010, 
        "Ext":{ 
            "key":value"
        },
        "MessageId":0000111,
        "IndexInConversation":1111111222,
        "Property":{ 
            "[可爱]":[
                {
                    "Operator":10002, 
                    "CreateTime":1703058396, 
                    "IdempotentId":"[可爱]10002[可爱]",
                    "Value":"[可爱]" 
                }
            ]
        }
    },
    "ModifyProperties":[ 
        {
            "Key":"[可爱]", 
            "Op":0, 
            "Value":"[可爱]", 
            "IdempotentId":"[可爱]10002[可爱]" 
        }
    ],
    "Operator":10002 
}
json

{
    "CheckCode": 0,
    "CheckMessage": ""
}
json