Browse Platform API
Platform API

Before user registration

Copy

Validate, reject, or adjust user profiles before OpenIM registers them.

HTTP request

POST {WEBHOOK_ADDRESS}/callbackBeforeUserRegisterCommand

Request body

PropertyTypeDescription
callbackCommandstringcallbackBeforeUserRegisterCommand.
usersUserInfo[]Users about to be registered. See UserInfo.

Response

Return the common before-event response. An optional users array replaces the profiles OpenIM will process. Use nextCode: 1 with a business error to reject registration.

Processing rules

  • Configuration key: beforeUserRegister.
  • OpenIM waits synchronously; failure behavior follows failedContinue.