API Reference

Generated from clients/protocol.yaml; lists every WebSocket command. For request/response payloads, see the Client Integration Guide. The complete OpenAPI 3.1 contract for server HTTP endpoints is available from /openapi.yaml or /openapi.json on each deployment.

Lifecycle

Command wire Kind
Login login Request
Heartbeat heartbeat Request
Ping ping Request

device-push

Command wire Kind
PushDeviceRegister push_device_register Request
PushDeviceUnregister push_device_unregister Request

Live room

Command wire Kind
ChatRoomSend chat_room_send Request
ChatRoomHistory chat_room_history Request
ChatRoomSearch chat_room_search Request
ChatRoomConversations chat_room_conversations Request
ChatRoomMarkRead chat_room_mark_read Request
ChatRoomMuteSet chat_room_mute_set Request
ChatRoomPinSet chat_room_pin_set Request
ChatRoomTyping chat_room_typing Request
ChatRoomEdit chat_room_edit Request
ChatRoomRecall chat_room_recall Request
ChatRoomDelete chat_room_delete Request
ChatRoomReact chat_room_react Request
ChatRoomExpand chat_room_expand Request

Group

Command wire Kind
ChatGroupSend chat_group_send Request
ChatGroupJoin chat_group_join Request
ChatGroupHistory chat_group_history Request
ChatGroupSearch chat_group_search Request
ChatGroupConversations chat_group_conversations Request
ChatGroupMarkRead chat_group_mark_read Request
ChatGroupMuteSet chat_group_mute_set Request
ChatGroupPinSet chat_group_pin_set Request
ChatGroupTyping chat_group_typing Request
ChatGroupEdit chat_group_edit Request
ChatGroupRecall chat_group_recall Request
ChatGroupDelete chat_group_delete Request
ChatGroupReact chat_group_react Request
ChatGroupExpand chat_group_expand Request

Direct messages

Command wire Kind
ChatDMSend chat_dm_send Request
ChatDMOpen chat_dm_open Request
ChatDMHistory chat_dm_history Request
ChatDMSearch chat_dm_search Request
ChatDMConversations chat_dm_conversations Request
ChatDMMarkRead chat_dm_mark_read Request
ChatDMPinSet chat_dm_pin_set Request
ChatDMTyping chat_dm_typing Request
ChatDMEdit chat_dm_edit Request
ChatDMRecall chat_dm_recall Request
ChatDMDelete chat_dm_delete Request
ChatDMReact chat_dm_react Request
ChatDMExpand chat_dm_expand Request
ChatStreamCancel chat_stream_cancel Request
ChatDMHandover chat_dm_handover Request
ChatDMRelease chat_dm_release Request
ChatReceipts chat_receipts Request

message

Command wire Kind
ChatCombinedDetail chat_combined_detail Request
ChatMessagePinSet chat_message_pin_set Request
ChatMessagePinList chat_message_pin_list Request
ChatSearchGlobal chat_search_global Request
ChatMessageTranslate chat_message_translate Request

Push events

Command wire Kind
ChatMessage chat_message Push
ChatMessagePinChanged chat_message_pin_changed Push
ChatStreamDelta chat.stream.delta Push
ChatStreamDone chat.stream.done Push
ChatStreamError chat.stream.error Push
ChatDMRoutingChanged chat_dm_routing_changed Push
ChatRoomConversationUpdate chat_room_conversation_update Push
ChatGroupConversationUpdate chat_group_conversation_update Push
ChatDMConversationUpdate chat_dm_conversation_update Push
ChatGroupRequestUpdate chat_group_request_update Push
ChatPresenceUpdate chat_presence_update Push
ChatDMReadReceipt chat_dm_read_receipt Push
ChatGroupReadReceipt chat_group_read_receipt Push
ChatDMDeliveryReceipt chat_dm_delivery_receipt Push
ChatMessageMutation chat_message_mutation Push
ChatTyping chat_typing Push

Room operations

Command wire Kind
RoomJoin room_join Request
RoomExit room_exit Request

Group operations

Command wire Kind
GroupJoin group_join Request
GroupExit group_exit Request

RTC signaling

Command wire Kind
RTCCallInvite rtc_call_invite Request
RTCCallAccept rtc_call_accept Request
RTCCallReject rtc_call_reject Request
RTCCallHangup rtc_call_hangup Request
RTCCallState rtc_call_state Request
RTCOffer rtc_offer Request
RTCAnswer rtc_answer Request
RTCICECandidate rtc_ice_candidate Request
RTCMultiJoin rtc_multi_join Request
RTCMultiSignal rtc_multi_signal Request
RTCMultiLeave rtc_multi_leave Request
RTCMultiState rtc_multi_state Push
RTCCSVoiceInvite rtc_cs_voice_invite Request
RTCCSVoiceCallback rtc_cs_voice_callback Request

Friends

Command wire Kind
ChatFriendList chat_friend_list Request
ChatFriendAdd chat_friend_add Request
ChatFriendRemove chat_friend_remove Request
ChatFriendRemarkSet chat_friend_remark_set Request
ChatFriendRequestList chat_friend_request_list Request
ChatFriendAccept chat_friend_accept Request
ChatFriendReject chat_friend_reject Request
ChatFriendRequestUpdate chat_friend_request_update Push
ChatFriendshipUpdated chat_friendship_updated Push
ChatProfileUpdated chat_profile_updated Push

Blocklist

Command wire Kind
ChatBlockAdd chat_block_add Request
ChatBlockRemove chat_block_remove Request
ChatBlockList chat_block_list Request

DM allowlist

Command wire Kind
ChatDMWhitelistAdd chat_dm_whitelist_add Request
ChatDMWhitelistRemove chat_dm_whitelist_remove Request
ChatDMWhitelistList chat_dm_whitelist_list Request

enterprise-directory

Command wire Kind
EnterpriseDepartmentCreate enterprise_department_create Request
EnterpriseDepartmentUpdate enterprise_department_update Request
EnterpriseDepartmentDelete enterprise_department_delete Request
EnterpriseDepartmentList enterprise_department_list Request
EnterpriseMemberUpsert enterprise_member_upsert Request
EnterpriseMemberRemove enterprise_member_remove Request
EnterpriseMemberList enterprise_member_list Request
EnterpriseMemberSearch enterprise_member_search Request

Room queries

Command wire Kind
ChatRoomMembers chat_room_members Request

Room members

Command wire Kind
ChatRoomMemberKick chat_room_member_kick Request
ChatRoomMemberMuteSet chat_room_member_mute_set Request

Group management

Command wire Kind
ChatGroupCreate chat_group_create Request
ChatGroupUpdate chat_group_update Request
ChatGroupInvite chat_group_invite Request
ChatGroupInviteApprovalSet chat_group_invite_approval_set Request
ChatGroupMembers chat_group_members Request

group-user-groups

Command wire Kind
ChatGroupUserGroupCreate chat_group_user_group_create Request
ChatGroupUserGroupUpdate chat_group_user_group_update Request
ChatGroupUserGroupDelete chat_group_user_group_delete Request
ChatGroupUserGroupList chat_group_user_group_list Request
ChatGroupUserGroupSearch chat_group_user_group_search Request
ChatGroupUserGroupMemberAdd chat_group_user_group_member_add Request
ChatGroupUserGroupMemberRemove chat_group_user_group_member_remove Request
ChatGroupUserGroupMemberList chat_group_user_group_member_list Request

Group management

Command wire Kind
ChatGroupMemberKick chat_group_member_kick Request
ChatGroupMemberMuteSet chat_group_member_mute_set Request
ChatGroupMemberMarkSet chat_group_member_mark_set Request
ChatGroupMemberMarkChanged chat_group_member_mark_changed Push
ChatGroupList chat_group_list Request
ChatGroupLeave chat_group_leave Request
ChatGroupMuteAllSet chat_group_mute_all_set Request
ChatGroupRoleSet chat_group_role_set Request
ChatGroupOwnerTransfer chat_group_owner_transfer Request
ChatGroupDisband chat_group_disband Request
ChatGroupApply chat_group_apply Request
ChatGroupRequestList chat_group_request_list Request
ChatGroupRequestApprove chat_group_request_approve Request
ChatGroupRequestReject chat_group_request_reject Request
ChatGroupHistoryPolicySet chat_group_history_policy_set Request
ChatGroupJoinPolicySet chat_group_join_policy_set Request

Community

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

Conversation operations

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

Presence

Command wire Kind
ChatStatusSend chat_status_send Request
ChatPresenceQuery chat_presence_query Request
ChatPresenceSubscribe chat_presence_subscribe Request
ChatPresenceSubscriptions chat_presence_subscriptions Request
ChatPresenceUnsubscribe chat_presence_unsubscribe Request

Room governance

Command wire Kind
ChatRoomAttributeSet chat_room_attribute_set Request
ChatRoomAttributeDelete chat_room_attribute_delete Request
ChatRoomBanSet chat_room_ban_set Request
ChatRoomGlobalMuteSet chat_room_global_mute_set Request
ChatRoomInfo chat_room_info Request
ChatRoomKeepAliveSet chat_room_keepalive_set Request
ChatRoomMuteAllSet chat_room_mute_all_set Request
ChatRoomPrioritySet chat_room_priority_set Request
ChatRoomUserProtectSet chat_room_user_protect_set Request

Compatibility

Command wire Kind
History history Request

Error codes

Name Code Meaning
OK 200 Success
NotLoggedIn 1000 Not logged in
ParameterIllegal 1001 Invalid parameter
UnauthorizedUserID 1002 Unauthorized user ID
Unauthorized 1003 Unauthorized
ServerError 1004 Server error
NotData 1005 No data
ModelAddError 1006 Create failed
ModelDeleteError 1007 Delete failed
ModelStoreError 1008 Store failed
OperationFailure 1009 Operation failed
RoutingNotExist 1010 Route not found
MessageTooLarge 1011 Message too large