Platform APIEnterprise

Before creating one-to-one conversations

Adjust default properties before one-to-one conversations are first created. This callback is available in OpenIM Enterprise.

HTTP request

POST {WEBHOOK_ADDRESS}/callbackBeforeCreateSingleChatConversationsCommand

Request body

Property	Type	Description
callbackCommand	string	`callbackBeforeCreateSingleChatConversationsCommand`.
owner_user_id	string	User who owns the conversation.
conversation_id	string	Conversation ID.
conversation_type	int	Conversation type.
user_id	string	Other participant user ID.
recv_msg_opt	int	Message receive option.
is_pinned	boolean	Whether the conversation is pinned.
is_marked	boolean	Whether the conversation is marked.
is_private_chat	boolean	Whether burn-after-reading is enabled.
burn_duration	int	Burn-after-reading duration.
group_at_type	int	Group mention reminder type.
attached_info	string	Attached conversation data.
ex	string	Extension data.

Response

Return the common before-event fields from Webhooks overview. The response may replace recv_msg_opt, is_pinned, is_marked, is_private_chat, burn_duration, group_at_type, attached_info, and ex.

Processing rules

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

Was this page helpful?