API Reference

Generated from clients/protocol.yaml; lists every WebSocket command. For request/response payloads, see the Client Integration Guide.

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

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

Direct messages

Command	wire	Kind
ChatDMSend	`chat_dm_send`	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
ChatDMHandover	`chat_dm_handover`	Request
ChatDMRelease	`chat_dm_release`	Request

Push events

Command	wire	Kind
ChatMessage	`chat_message`	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
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

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

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
ChatGroupMemberKick	`chat_group_member_kick`	Request
ChatGroupMemberMuteSet	`chat_group_member_mute_set`	Request
ChatGroupList	`chat_group_list`	Request
ChatGroupLeave	`chat_group_leave`	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
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
CommunityCategoryCreate	`community_category_create`	Request
CommunityCategoryUpdate	`community_category_update`	Request
CommunityCategoryDelete	`community_category_delete`	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