Platform API

Before creating a group

Validate or adjust group information and initial members before a group is created.

HTTP request

POST {WEBHOOK_ADDRESS}/callbackBeforeCreateGroupCommand

Request body

Property	Type	Description
callbackCommand	string	`callbackBeforeCreateGroupCommand`.
operationID	string	OpenIM operation trace ID.
groupID	string	Group ID.
groupName	string	Group name.
notification	string	Group announcement.
introduction	string	Group introduction.
faceURL	string	Group avatar URL.
ownerUserID	string	Group owner user ID.
createTime	int	Group creation time in milliseconds.
memberCount	int	Initial member count.
ex	string	Extension data.
status	int	Group status.
creatorUserID	string	Group creator user ID.
groupType	int	Group type.
needVerification	int	Join verification policy.
lookMemberInfo	int	Whether ordinary members can view member profiles.
applyMemberFriend	int	Whether ordinary members can add other members as friends.
notificationUpdateTime	int	Announcement update time in milliseconds.
notificationUserID	string	User who last updated the announcement.
displayIsRead Enterprise	boolean	Whether group message read status is displayed.
muteBypassUserIDs Enterprise	string[]	Users allowed to send messages while the group is muted.
initMemberList	object[]	Initial members, each containing `userID` and `roleLevel`.

Response

Return the common before-event fields from Webhooks overview. The response may also return the mutable group fields shown above to replace the values OpenIM is about to process.

Processing rules

Configuration key: beforeCreateGroup.
OpenIM waits synchronously. Use nextCode: 1 to reject creation; timeout behavior follows failedContinue.

Was this page helpful?