Platform API

Before inviting users to a group

Validate a group invitation and optionally refuse individual invitees.

HTTP request

POST {WEBHOOK_ADDRESS}/callbackBeforeInviteJoinGroupCommand

Property	Type	Description
callbackCommand	string	`callbackBeforeInviteJoinGroupCommand`.
operationID	string	OpenIM operation trace ID.
groupID	string	Group ID.
reason	string	Invitation reason.
invitedUserIDs	string[]	User IDs to invite.

Return the common before-event fields from Webhooks overview. Set refusedMembersAccount to the user IDs that must not be added.

Configuration key: beforeInviteUserToGroup.
OpenIM waits synchronously. Use nextCode: 1 to reject the entire invitation; timeout behavior follows failedContinue.

Was this page helpful?