Platform API
Before one-to-one online push
Adjust target users or push policy before an online one-to-one push.
HTTP request
POST {WEBHOOK_ADDRESS}/callbackBeforeOnlinePushCommandRequest body
| Property | Type | Description |
|---|---|---|
| callbackCommand | string | callbackBeforeOnlinePushCommand. |
| operationID | string | OpenIM operation trace ID. |
| platformID | int | Client platform ID. |
| platform | string | Client platform name. |
| userIDList | string[] | Target user IDs. |
| title | string | Push title. |
| desc | string | Push summary. |
| ex | string | Extension data. |
| iOSPushSound | string | iOS notification sound. |
| iOSBadgeCount | boolean | Whether to update the iOS badge. |
| clientMsgID | string | Client message ID. |
| sendID | string | Sender user ID. |
| groupID | string | Group ID when present. |
| contentType | int | Message content type. |
| sessionType | int | Conversation type. |
| atUserIDList | string[] | Mentioned user IDs. |
| content | string | Message content JSON string. |
Response
Return the common before-event fields from Webhooks overview. userIDList may replace the push recipients and offlinePushInfo may replace push metadata.
Processing rules
- Configuration key:
beforeOnlinePush. - OpenIM waits synchronously; timeout behavior follows
failedContinue.
Was this page helpful?