Browse Platform API
Platform API

Before members join a group

Copy

Validate or adjust member profiles before users become group members.

HTTP request

POST {WEBHOOK_ADDRESS}/callbackBeforeMembersJoinGroupCommand

Request body

PropertyTypeDescription
callbackCommandstringcallbackBeforeMembersJoinGroupCommand.
groupIDstringGroup ID.
memberListobject[]Members about to join, including userID and ex.
groupExstringGroup extension data.

Response

Return the common before-event fields from Webhooks overview. memberCallbackList may contain adjusted profiles for the members OpenIM is about to add.

Processing rules

  • Configuration key: beforeMemberJoinGroup.
  • OpenIM waits synchronously. Use nextCode: 1 to reject the operation; timeout behavior follows failedContinue.