Client API 全表

本页用于快速查找 Client SDK 的模块、方法、请求类型和返回类型。点击类型可跳转到对应模型定义；更详细的字段说明和多端代码示例请使用多端 API 浏览器。

使用方式

先按模块定位 API，例如 client.messages 或 client.conversations。
点击请求类型或返回类型查看模型字段、枚举值和集合别名。
回到 API 浏览器查看具体字段和平台示例。

client

初始化、登录、退出和客户端生命周期。

方法	请求	返回
`init`	SdkConfig	`Unit`
`login`	LoginRequest	`Unit`
`prepare`	LoginRequest	`Unit`
`connect`	LoginRequest	`Unit`
`updateAccessToken`	UpdateAccessTokenRequest	`Unit`
`setHeartbeatAppState`	SetHeartbeatAppStateRequest	`Unit`
`logout`	`Unit`	`Unit`
`dispose`	`Unit`	`Unit`
`currentUserId`	`Unit`	CurrentUserIdResponse
`isConnected`	`Unit`	BooleanResponse
`sessionActive`	`Unit`	BooleanResponse

client.connection

查询连接状态和主动断开连接。

方法	请求	返回
`getConnectionState`	`Unit`	ConnectionStateResponse
`disconnect`	`Unit`	`Unit`

client.conversations

会话列表、会话状态、已读、置顶、草稿和归档。

方法	请求	返回
`listConversations`	`Unit`	ListConversationsResponse
`listConversationsByQuery`	ConversationListQuery	ListConversationsResponse
`listConversationsIncludingArchived`	`Unit`	ListConversationsResponse
`getConversation`	GetConversationRequest	Conversation
`getOneConversation`	GetOneConversationRequest	Conversation
`getGroupConversationByUserIds`	GetGroupConversationByUserIdsRequest	Conversation
`getMultipleConversations`	GetMultipleConversationsRequest	ListConversationsResponse
`listConversationsPaginated`	ListConversationsPaginatedRequest	ListConversationsResponse
`listRawConversations`	`Unit`	ListConversationsResponse
`bootstrapHomeTimeline`	BootstrapHomeTimelineRequest	HomeTimelineSnapshot
`openConversationTimeline`	OpenConversationTimelineRequest	ConversationTimelineSnapshot
`markConversationRead`	MarkConversationReadRequest	`Unit`
`setConversationPinned`	SetConversationPinnedRequest	`Unit`
`setConversationMuted`	SetConversationMutedRequest	`Unit`
`setConversationArchived`	SetConversationArchivedRequest	`Unit`
`markConversationUnread`	MarkConversationUnreadRequest	`Unit`
`deleteConversation`	DeleteConversationRequest	`Unit`
`updateConversationDraft`	UpdateConversationDraftRequest	`Unit`
`clearLocalChatHistory`	ClearLocalChatHistoryRequest	`Unit`

client.messageBuilder

构建文本、图片、文件、富文本等消息内容。

方法	请求	返回
`listSupportedBuildOperations`	`Unit`	ListMessageBuildCatalogResponse
`normalizeRichDocFromMarkdown`	NormalizeRichDocFromMarkdownRequest	RichDocV2Normalized
`normalizeRichDocFromHtml`	NormalizeRichDocFromHtmlRequest	RichDocV2Normalized
`normalizeRichDocFromDocJson`	NormalizeRichDocFromDocJsonRequest	RichDocV2Normalized
`buildAnnouncement`	BuildAnnouncementMessageRequest	Message
`buildAudio`	BuildAudioMessageRequest	Message
`buildCard`	BuildCardMessageRequest	Message
`buildCustom`	BuildCustomMessageRequest	Message
`buildEmoji`	BuildEmojiMessageRequest	Message
`buildFile`	BuildFileMessageRequest	Message
`buildForward`	BuildForwardMessageRequest	Message
`buildImage`	BuildImageMessageRequest	Message
`buildImageGroup`	BuildImageGroupMessageRequest	Message
`buildLinkCard`	BuildLinkCardMessageRequest	Message
`buildLocation`	BuildLocationMessageRequest	Message
`buildMiniProgram`	BuildMiniProgramMessageRequest	Message
`buildNotification`	BuildNotificationMessageRequest	Message
`buildPlaceholder`	BuildPlaceholderMessageRequest	Message
`buildQuote`	BuildQuoteMessageRequest	Message
`buildRichDoc`	BuildRichDocMessageRequest	Message
`buildSchedule`	BuildScheduleMessageRequest	Message
`buildSticker`	BuildStickerMessageRequest	Message
`buildSystem`	BuildSystemMessageRequest	Message
`buildTask`	BuildTaskMessageRequest	Message
`buildText`	BuildTextMessageRequest	Message
`buildThreadReply`	BuildThreadReplyMessageRequest	Message
`buildVideo`	BuildVideoMessageRequest	Message
`buildVote`	BuildVoteMessageRequest	Message
`buildWithContent`	BuildWithContentMessageRequest	Message

client.messages

发送、查询、撤回、编辑、删除和消息互动。

方法	请求	返回
`createTextMessage`	CreateTextMessageRequest	Message
`dispatchMessage`	MessageDispatchRequest	`JsonValue`
`sendMessageNoOss`	SendMessageRequest	SendMessageResponse
`sendMessage`	SendMessageRequest	SendMessageResponse
`listMessages`	ListMessagesRequest	ListMessagesResponse
`recallMessage`	RecallMessageRequest	`Unit`
`editTextByMessageId`	EditTextByMessageIdRequest	`Unit`
`deleteMessage`	DeleteMessageRequest	`Unit`
`deleteMessageForSelf`	DeleteMessageRequest	`Unit`
`deleteMessageForEveryone`	DeleteMessageRequest	`Unit`
`markMessageReadAndBurn`	MarkMessageReadAndBurnRequest	`Unit`
`addReaction`	ReactionMutationRequest	`Unit`
`removeReaction`	ReactionMutationRequest	`Unit`
`pinMessage`	MessageMutationRequest	`Unit`
`unpinMessage`	MessageMutationRequest	`Unit`
`pinMessageById`	MessageMutationRequest	`Unit`
`unpinMessageById`	MessageMutationRequest	`Unit`
`markMessage`	MessageMutationRequest	`Unit`
`markMessageWithColor`	MessageMutationRequest	`Unit`
`unmarkMessage`	MessageMutationRequest	`Unit`
`markMessageById`	MessageMutationRequest	`Unit`
`unmarkMessageById`	MessageMutationRequest	`Unit`
`getMessage`	GetMessageRequest	Message
`getRawMessage`	GetMessageRequest	`JsonValue`
`searchMessages`	MessageSearchQuery	ListMessagesResponse
`searchMessagesByQuery`	MessageSearchQuery	ListMessagesResponse
`searchMessagesInConversation`	MessageSearchQuery	ListMessagesResponse
`editRichDocByMessageId`	EditRichDocByMessageIdRequest	`Unit`
`setTyping`	SetTypingRequest	`Unit`

client.sync

会话和消息同步。

方法	请求	返回
`syncConversationSummaries`	`Unit`	`Unit`
`syncConversationSummariesWithVersions`	SyncConversationSummariesRequest	SyncConversationSummariesResponse
`syncConversation`	SyncConversationRequest	`Unit`
`syncMessages`	SyncMessagesRequest	`Unit`

client.presence

用户在线状态查询和订阅。

方法	请求	返回
`getUserPresence`	GetUserPresenceRequest	UserPresence
`batchGetUserPresence`	BatchGetUserPresenceRequest	BatchGetUserPresenceResponse
`subscribeUserPresence`	SubscribeUserPresenceRequest	`Unit`

client.media

文件、图片、视频上传下载和缓存。

方法	请求	返回
`uploadFile`	UploadFileRequest	MediaUploadResponse
`uploadImage`	UploadFileRequest	MediaUploadResponse
`uploadVideo`	UploadFileRequest	MediaUploadResponse
`uploadBytes`	UploadBytesRequest	MediaUploadResponse
`deleteFile`	DeleteMediaFileRequest	DeleteMediaFileResponse
`getMediaUrl`	GetMediaUrlRequest	MediaAccessUrl
`getTempDownloadUrl`	TempDownloadUrlRequest	MediaAccessUrl
`resolveMediaAccess`	ResolveMediaAccessRequest	MediaResolvedAccess
`cacheRemoteMedia`	CacheRemoteMediaRequest	MediaCacheEntry
`getMediaCacheStats`	`Unit`	MediaCacheStats
`setMediaCacheMaxBytes`	SetMediaCacheMaxBytesRequest	`Unit`
`setMediaCacheRoot`	SetMediaCacheRootRequest	`Unit`
`clearMediaCache`	`Unit`	`Unit`
`getUserDownloadSubfolder`	`Unit`	UserDownloadSubfolderResponse
`setUserDownloadSubfolder`	SetUserDownloadSubfolderRequest	`Unit`
`getUserDownloadSavedPath`	GetUserDownloadSavedPathRequest	UserDownloadSavedPathResponse
`deleteUserDownloadRecord`	DeleteUserDownloadRecordRequest	`Unit`
`cancelUserFileDownload`	CancelUserFileDownloadRequest	BooleanResponse
`downloadFileToDownloads`	DownloadFileToDownloadsRequest	UserDownloadSavedPathResponse

client.capabilities

可选能力查询、授权和实时信令。

方法	请求	返回
`listCapabilities`	ListCapabilitiesRequest	ListCapabilitiesResponse
`listUserCapabilities`	ListUserCapabilitiesRequest	ListUserCapabilitiesResponse
`dispatchCapability`	DispatchCapabilityRequest	DispatchCapabilityResponse
`grantCapability`	GrantCapabilityRequest	`Unit`
`revokeCapability`	RevokeCapabilityRequest	`Unit`
`sendCallSignal`	SendCallSignalRequest	`Unit`

client.events

事件订阅和取消订阅。

方法	请求	返回
`subscribeEvents`	SubscribeEventsRequest	Subscription
`unsubscribe`	UnsubscribeRequest	`Unit`
`unsubscribeAll`	`Unit`	`Unit`

client.diagnostics

版本与诊断信息。

方法	请求	返回
`getSdkVersion`	`Unit`	SdkVersion