API 参考

本页由 clients/protocol.yaml 生成，列出全部 WebSocket 命令。各命令的请求/响应负载详见客户端接入指南；服务端 HTTP 接口可从部署实例的 /openapi.yaml 或 /openapi.json 获取完整 OpenAPI 3.1 契约。

连接生命周期

命令	wire	类型
Login	`login`	请求
Heartbeat	`heartbeat`	请求
Ping	`ping`	请求

device-push

命令	wire	类型
PushDeviceRegister	`push_device_register`	请求
PushDeviceUnregister	`push_device_unregister`	请求

聊天室

命令	wire	类型
ChatRoomSend	`chat_room_send`	请求
ChatRoomHistory	`chat_room_history`	请求
ChatRoomSearch	`chat_room_search`	请求
ChatRoomConversations	`chat_room_conversations`	请求
ChatRoomMarkRead	`chat_room_mark_read`	请求
ChatRoomMuteSet	`chat_room_mute_set`	请求
ChatRoomPinSet	`chat_room_pin_set`	请求
ChatRoomTyping	`chat_room_typing`	请求
ChatRoomEdit	`chat_room_edit`	请求
ChatRoomRecall	`chat_room_recall`	请求
ChatRoomDelete	`chat_room_delete`	请求
ChatRoomReact	`chat_room_react`	请求
ChatRoomExpand	`chat_room_expand`	请求

群聊

命令	wire	类型
ChatGroupSend	`chat_group_send`	请求
ChatGroupJoin	`chat_group_join`	请求
ChatGroupHistory	`chat_group_history`	请求
ChatGroupSearch	`chat_group_search`	请求
ChatGroupConversations	`chat_group_conversations`	请求
ChatGroupMarkRead	`chat_group_mark_read`	请求
ChatGroupMuteSet	`chat_group_mute_set`	请求
ChatGroupPinSet	`chat_group_pin_set`	请求
ChatGroupTyping	`chat_group_typing`	请求
ChatGroupEdit	`chat_group_edit`	请求
ChatGroupRecall	`chat_group_recall`	请求
ChatGroupDelete	`chat_group_delete`	请求
ChatGroupReact	`chat_group_react`	请求
ChatGroupExpand	`chat_group_expand`	请求

私信

命令	wire	类型
ChatDMSend	`chat_dm_send`	请求
ChatDMOpen	`chat_dm_open`	请求
ChatDMHistory	`chat_dm_history`	请求
ChatDMSearch	`chat_dm_search`	请求
ChatDMConversations	`chat_dm_conversations`	请求
ChatDMMarkRead	`chat_dm_mark_read`	请求
ChatDMPinSet	`chat_dm_pin_set`	请求
ChatDMTyping	`chat_dm_typing`	请求
ChatDMEdit	`chat_dm_edit`	请求
ChatDMRecall	`chat_dm_recall`	请求
ChatDMDelete	`chat_dm_delete`	请求
ChatDMReact	`chat_dm_react`	请求
ChatDMExpand	`chat_dm_expand`	请求
ChatStreamCancel	`chat_stream_cancel`	请求
ChatDMHandover	`chat_dm_handover`	请求
ChatDMRelease	`chat_dm_release`	请求
ChatReceipts	`chat_receipts`	请求

message

命令	wire	类型
ChatCombinedDetail	`chat_combined_detail`	请求
ChatMessagePinSet	`chat_message_pin_set`	请求
ChatMessagePinList	`chat_message_pin_list`	请求
ChatSearchGlobal	`chat_search_global`	请求
ChatMessageTranslate	`chat_message_translate`	请求

推送事件

命令	wire	类型
ChatMessage	`chat_message`	推送
ChatMessagePinChanged	`chat_message_pin_changed`	推送
ChatStreamDelta	`chat.stream.delta`	推送
ChatStreamDone	`chat.stream.done`	推送
ChatStreamError	`chat.stream.error`	推送
ChatDMRoutingChanged	`chat_dm_routing_changed`	推送
ChatRoomConversationUpdate	`chat_room_conversation_update`	推送
ChatGroupConversationUpdate	`chat_group_conversation_update`	推送
ChatDMConversationUpdate	`chat_dm_conversation_update`	推送
ChatGroupRequestUpdate	`chat_group_request_update`	推送
ChatPresenceUpdate	`chat_presence_update`	推送
ChatDMReadReceipt	`chat_dm_read_receipt`	推送
ChatGroupReadReceipt	`chat_group_read_receipt`	推送
ChatDMDeliveryReceipt	`chat_dm_delivery_receipt`	推送
ChatMessageMutation	`chat_message_mutation`	推送
ChatTyping	`chat_typing`	推送

聊天室操作

命令	wire	类型
RoomJoin	`room_join`	请求
RoomExit	`room_exit`	请求

群操作

命令	wire	类型
GroupJoin	`group_join`	请求
GroupExit	`group_exit`	请求

音视频信令

命令	wire	类型
RTCCallInvite	`rtc_call_invite`	请求
RTCCallAccept	`rtc_call_accept`	请求
RTCCallReject	`rtc_call_reject`	请求
RTCCallHangup	`rtc_call_hangup`	请求
RTCCallState	`rtc_call_state`	请求
RTCOffer	`rtc_offer`	请求
RTCAnswer	`rtc_answer`	请求
RTCICECandidate	`rtc_ice_candidate`	请求
RTCMultiJoin	`rtc_multi_join`	请求
RTCMultiSignal	`rtc_multi_signal`	请求
RTCMultiLeave	`rtc_multi_leave`	请求
RTCMultiState	`rtc_multi_state`	推送
RTCCSVoiceInvite	`rtc_cs_voice_invite`	请求
RTCCSVoiceCallback	`rtc_cs_voice_callback`	请求

好友

命令	wire	类型
ChatFriendList	`chat_friend_list`	请求
ChatFriendAdd	`chat_friend_add`	请求
ChatFriendRemove	`chat_friend_remove`	请求
ChatFriendRemarkSet	`chat_friend_remark_set`	请求
ChatFriendRequestList	`chat_friend_request_list`	请求
ChatFriendAccept	`chat_friend_accept`	请求
ChatFriendReject	`chat_friend_reject`	请求
ChatFriendRequestUpdate	`chat_friend_request_update`	推送
ChatFriendshipUpdated	`chat_friendship_updated`	推送
ChatProfileUpdated	`chat_profile_updated`	推送

黑名单

命令	wire	类型
ChatBlockAdd	`chat_block_add`	请求
ChatBlockRemove	`chat_block_remove`	请求
ChatBlockList	`chat_block_list`	请求

私信白名单

命令	wire	类型
ChatDMWhitelistAdd	`chat_dm_whitelist_add`	请求
ChatDMWhitelistRemove	`chat_dm_whitelist_remove`	请求
ChatDMWhitelistList	`chat_dm_whitelist_list`	请求

enterprise-directory

命令	wire	类型
EnterpriseDepartmentCreate	`enterprise_department_create`	请求
EnterpriseDepartmentUpdate	`enterprise_department_update`	请求
EnterpriseDepartmentDelete	`enterprise_department_delete`	请求
EnterpriseDepartmentList	`enterprise_department_list`	请求
EnterpriseMemberUpsert	`enterprise_member_upsert`	请求
EnterpriseMemberRemove	`enterprise_member_remove`	请求
EnterpriseMemberList	`enterprise_member_list`	请求
EnterpriseMemberSearch	`enterprise_member_search`	请求

聊天室查询

命令	wire	类型
ChatRoomMembers	`chat_room_members`	请求

聊天室成员

命令	wire	类型
ChatRoomMemberKick	`chat_room_member_kick`	请求
ChatRoomMemberMuteSet	`chat_room_member_mute_set`	请求

群管理

命令	wire	类型
ChatGroupCreate	`chat_group_create`	请求
ChatGroupUpdate	`chat_group_update`	请求
ChatGroupInvite	`chat_group_invite`	请求
ChatGroupInviteApprovalSet	`chat_group_invite_approval_set`	请求
ChatGroupMembers	`chat_group_members`	请求

group-user-groups

命令	wire	类型
ChatGroupUserGroupCreate	`chat_group_user_group_create`	请求
ChatGroupUserGroupUpdate	`chat_group_user_group_update`	请求
ChatGroupUserGroupDelete	`chat_group_user_group_delete`	请求
ChatGroupUserGroupList	`chat_group_user_group_list`	请求
ChatGroupUserGroupSearch	`chat_group_user_group_search`	请求
ChatGroupUserGroupMemberAdd	`chat_group_user_group_member_add`	请求
ChatGroupUserGroupMemberRemove	`chat_group_user_group_member_remove`	请求
ChatGroupUserGroupMemberList	`chat_group_user_group_member_list`	请求

群管理

命令	wire	类型
ChatGroupMemberKick	`chat_group_member_kick`	请求
ChatGroupMemberMuteSet	`chat_group_member_mute_set`	请求
ChatGroupMemberMarkSet	`chat_group_member_mark_set`	请求
ChatGroupMemberMarkChanged	`chat_group_member_mark_changed`	推送
ChatGroupList	`chat_group_list`	请求
ChatGroupLeave	`chat_group_leave`	请求
ChatGroupMuteAllSet	`chat_group_mute_all_set`	请求
ChatGroupRoleSet	`chat_group_role_set`	请求
ChatGroupOwnerTransfer	`chat_group_owner_transfer`	请求
ChatGroupDisband	`chat_group_disband`	请求
ChatGroupApply	`chat_group_apply`	请求
ChatGroupRequestList	`chat_group_request_list`	请求
ChatGroupRequestApprove	`chat_group_request_approve`	请求
ChatGroupRequestReject	`chat_group_request_reject`	请求
ChatGroupHistoryPolicySet	`chat_group_history_policy_set`	请求
ChatGroupJoinPolicySet	`chat_group_join_policy_set`	请求

社区

命令	wire	类型
CommunityCreate	`community_create`	请求
CommunityUpdate	`community_update`	请求
CommunityDisband	`community_disband`	请求
CommunityJoin	`community_join`	请求
CommunityLeave	`community_leave`	请求
CommunityMembers	`community_members`	请求
CommunityMemberKick	`community_member_kick`	请求
CommunityMemberMuteSet	`community_member_mute_set`	请求
CommunityRoleSet	`community_role_set`	请求
CommunityJoinPolicySet	`community_join_policy_set`	请求
CommunityOwnerTransfer	`community_owner_transfer`	请求
CommunityDiscover	`community_discover`	请求
CommunityChannelCreate	`community_channel_create`	请求
CommunityChannelUpdate	`community_channel_update`	请求
CommunityChannelDelete	`community_channel_delete`	请求
CommunityChannelList	`community_channel_list`	请求
CommunityGet	`community_get`	请求
CommunityCategoryCreate	`community_category_create`	请求
CommunityCategoryUpdate	`community_category_update`	请求
CommunityCategoryDelete	`community_category_delete`	请求
CommunityCategoryList	`community_category_list`	请求
CommunitySend	`community_send`	请求
CommunityHistory	`community_history`	请求
CommunityTyping	`community_typing`	请求
CommunityMarkRead	`community_mark_read`	请求
CommunityConversations	`community_conversations`	请求
CommunityMessage	`community.message`	推送
CommunityMemberChanged	`community.member_changed`	推送
CommunityChannelChanged	`community.channel_changed`	推送
CommunityTypingPush	`community.typing`	推送

会话操作

命令	wire	类型
ChatGroupConversationRemove	`chat_group_conversation_remove`	请求
ChatDMConversationRemove	`chat_dm_conversation_remove`	请求
ChatRoomConversationRemove	`chat_room_conversation_remove`	请求
ChatDMPolicyGet	`chat_dm_policy_get`	请求
ChatDMPolicySet	`chat_dm_policy_set`	请求
ChatDMForgetMemory	`chat_dm_forget_memory`	请求
ChatDMHandoverBrief	`chat_dm_handover_brief`	推送
ChatDMHandoverBriefGet	`chat_dm_handover_brief_get`	请求
ChatDMTransfer	`chat_dm_transfer`	请求
ChatDMForceReassign	`chat_dm_force_reassign`	请求
ChatGroupCSClaim	`chat_group_cs_claim`	请求
ChatGroupCSRelease	`chat_group_cs_release`	请求
ChatGroupCSReassign	`chat_group_cs_reassign`	请求
ChatGroupCSRoutingChanged	`chat_group_cs_routing_changed`	推送
ChatCSWorkspaceBootstrap	`chat_cs_workspace_bootstrap`	请求
ChatCSQueueList	`chat_cs_queue_list`	请求
ChatCSSessionHistory	`chat_cs_session_history`	请求
ChatCSStats	`chat_cs_stats`	请求
ChatCSProfileGet	`chat_cs_profile_get`	请求
ChatCSProfileSet	`chat_cs_profile_set`	请求
ChatCSRepliesList	`chat_cs_replies_list`	请求
ChatCSReplyUse	`chat_cs_reply_use`	请求
ChatCSNoteAdd	`chat_cs_note_add`	请求
ChatCSNotesList	`chat_cs_notes_list`	请求
ChatCSAgentStatusSet	`chat_cs_agent_status_set`	请求
ChatCSSLAAlert	`chat_cs_sla_alert`	推送
ChatCSCopilotSuggest	`chat_cs_copilot_suggest`	请求
ChatCSCopilot	`chat_cs_copilot`	推送
ChatCSCopilotUse	`chat_cs_copilot_use`	请求
ChatCSCopilotRewrite	`chat_cs_copilot_rewrite`	请求
ChatCSCopilotSummary	`chat_cs_copilot_summary`	请求
ChatCSQAGet	`chat_cs_qa_get`	请求
ChatCSQAAppeal	`chat_cs_qa_appeal`	请求
ChatCSAvatarStart	`chat_cs_avatar_start`	请求
ChatCSAvatarStop	`chat_cs_avatar_stop`	请求
ChatCSAvatarInterrupt	`chat_cs_avatar_interrupt`	请求
ChatInteractiveReply	`chat_interactive_reply`	请求
ChatConversationLabelsSet	`chat_conversation_labels_set`	请求
ChatConversationLabelsList	`chat_conversation_labels_list`	请求
ChatConversationsByLabel	`chat_conversations_by_label`	请求
ChatConversationMarkUnread	`chat_conversation_mark_unread`	请求
ChatDraftSet	`chat_draft_set`	请求
ChatDraftClear	`chat_draft_clear`	请求
ChatDeviceSyncState	`chat_device_sync_state`	请求
UserPushSettingsGet	`user_push_settings_get`	请求
UserPushSettingsSet	`user_push_settings_set`	请求

在线状态

命令	wire	类型
ChatStatusSend	`chat_status_send`	请求
ChatPresenceQuery	`chat_presence_query`	请求
ChatPresenceSubscribe	`chat_presence_subscribe`	请求
ChatPresenceSubscriptions	`chat_presence_subscriptions`	请求
ChatPresenceUnsubscribe	`chat_presence_unsubscribe`	请求

聊天室治理

命令	wire	类型
ChatRoomAttributeSet	`chat_room_attribute_set`	请求
ChatRoomAttributeDelete	`chat_room_attribute_delete`	请求
ChatRoomBanSet	`chat_room_ban_set`	请求
ChatRoomGlobalMuteSet	`chat_room_global_mute_set`	请求
ChatRoomInfo	`chat_room_info`	请求
ChatRoomKeepAliveSet	`chat_room_keepalive_set`	请求
ChatRoomMuteAllSet	`chat_room_mute_all_set`	请求
ChatRoomPrioritySet	`chat_room_priority_set`	请求
ChatRoomUserProtectSet	`chat_room_user_protect_set`	请求

兼容命令

命令	wire	类型
History	`history`	请求

错误码

名称	Code	含义
`OK`	200	成功
`NotLoggedIn`	1000	未登录
`ParameterIllegal`	1001	参数不合法
`UnauthorizedUserID`	1002	非法的用户ID
`Unauthorized`	1003	未授权
`ServerError`	1004	系统错误
`NotData`	1005	没有数据
`ModelAddError`	1006	添加错误
`ModelDeleteError`	1007	删除错误
`ModelStoreError`	1008	存储错误
`OperationFailure`	1009	操作失败
`RoutingNotExist`	1010	路由不存在
`MessageTooLarge`	1011	消息体过大