Platform API

Before group online push

Adjust target users or push policy before an online group push.

HTTP request

POST {WEBHOOK_ADDRESS}/callbackBeforeGroupOnlinePushCommand

Request body

Property	Type	Description
callbackCommand	string	`callbackBeforeGroupOnlinePushCommand`.
operationID	string	OpenIM operation trace ID.
platformID	int	Client platform ID.
platform	string	Client platform name.
clientMsgID	string	Client message ID.
sendID	string	Sender user ID.
groupID	string	Group ID.
contentType	int	Message content type.
sessionType	int	Conversation type.
atUserIDList	string[]	Mentioned user IDs.
content	string	Message content JSON string.
seq	int	Message sequence number.

Response

Return the common before-event fields from Webhooks overview. userIDList may replace the online recipients and offlinePushInfo may replace fallback push metadata.

Processing rules

Configuration key: beforeGroupOnlinePush.
OpenIM waits synchronously; timeout behavior follows failedContinue.

Was this page helpful?