Client 模型索引

本页列出 Client SDK API 会直接使用到的请求模型、返回模型、实体模型、枚举和集合别名。API 浏览器和 API 全表中的可点击类型会跳转到本页对应定义。

如何阅读

Required = 是 表示调用时必须提供，或返回中一定存在。
字段名使用各端 SDK 的公开 lowerCamelCase 命名。
String、UInt64、JsonObject 等基础类型见下方“基础类型”。

基础类型

Type	说明
`String`	文本值。
`Boolean`	布尔值。
`Int32`	32 位有符号整数。
`Int64`	64 位有符号整数。
`UInt32`	32 位无符号整数。
`UInt64`	64 位无符号整数，常用于时间戳和序列号。
`Double`	双精度浮点数。
`StringList`	字符串数组。
`StringMap`	字符串键值映射。
`JsonObject`	JSON 对象。
`JsonValue`	任意 JSON 值。
`BinaryMap`	二进制负载映射。

Session

BooleanResponse

client.isConnected 的返回结果。

字段	类型	是否必填	说明
`value`	`Boolean`	是	布尔返回值。

CurrentUserIdResponse

client.currentUserId 的返回结果。

字段	类型	是否必填	说明
`userId`	`String`	否	会话激活时的当前用户 ID。

HeartbeatAppState

HeartbeatAppState 可选值。

值
`foreground`
`background`

LoginRequest

client.login 的请求参数。

字段	类型	是否必填	说明
`userId`	`String`	是	当前用户 ID。
`token`	`String`	是	SDK 访问令牌。
`storeConfigJson`	`String`	否	可选的本地存储配置 JSON。

SdkConfig

client.init 的请求参数。

字段	类型	是否必填	说明
`wsUrl`	`String`	否	实时服务端点。
`httpUrl`	`String`	否	HTTP API 端点。
`dataUrl`	`String`	否	数据服务端点。
`onlineUrl`	`String`	否	在线状态服务端点。
`capabilityUrl`	`String`	否	能力服务端点。
`tenantId`	`String`	否	租户标识。
`resourceProfile`	SdkResourceProfile	否	运行环境类型：桌面端或移动端。
`reconnectIntervalSecs`	`UInt32`	否	重连间隔，单位为秒。
`maxReconnectAttempts`	`UInt32`	否	最大重连次数。
`connectTimeoutSecs`	`UInt32`	否	连接超时时间，单位为秒。
`syncBatchSize`	`UInt32`	否	同步批大小。
`enableMetrics`	`Boolean`	否	是否启用运行时指标。
`mediaStorageProxyPrefix`	`String`	否	媒体代理 URL 前缀。
`mediaStorageProxyTargets`	`StringList`	否	允许的媒体代理目标。

SetHeartbeatAppStateRequest

client.setHeartbeatAppState 的请求参数。

字段	类型	是否必填	说明
`appState`	HeartbeatAppState	是	当前应用可见性状态。

UpdateAccessTokenRequest

client.updateAccessToken 的请求参数。

字段	类型	是否必填	说明
`accessToken`	`String`	是	新的 SDK 访问令牌。
`tenantId`	`String`	否	需要同步到请求上下文的租户标识。

Connection

ConnectionStateResponse

client.connection.getConnectionState 的返回结果。

字段	类型	是否必填	说明
`state`	ConnectionState	是	连接状态。

Conversations

BootstrapHomeTimelineRequest

client.conversations.bootstrapHomeTimeline 的请求参数。

字段	类型	是否必填	说明
`conversationLimit`	`UInt32`	是	会话数量限制。

ClearLocalChatHistoryRequest

client.conversations.clearLocalChatHistory 的请求参数。

字段	类型	是否必填	说明
`payload`	`JsonObject`	否	对象参数。

Conversation

client.conversations.getConversation 的返回结果。

字段	类型	是否必填	说明
`avatarUrl`	`String`	是	头像 URL。
`badge`	`String`	否	badge 字段。
`businessType`	`String`	是	业务类型。
`channelId`	`String`	是	会话路由 ID：单聊为对方 user_id；群/频道为业务 channel（与服务端 `channel_id` 一致）
`conversationId`	`String`	是	会话 ID。
`conversationType`	ConversationType	是	会话类型。
`createdAt`	`UInt64`	是	创建时间。
`description`	`String`	否	说明。
`displayName`	`String`	是	展示名（列表主标题）
`draft`	`String`	否	草稿。
`ext`	`StringMap`	是	扩展键值（与服务端 ext 对应）
`isArchived`	`Boolean`	是	是否归档。
`isMuted`	`Boolean`	是	是否静音。
`isPinned`	`Boolean`	是	是否置顶。
`lastMessage`	MessagePreview	否	最后一条消息。
`lastMessageAt`	`UInt64`	否	最后消息时间。
`lastMessageId`	`String`	否	最后消息 ID。
`lastMessagePreview`	`String`	否	最后消息预览。
`lastReadSeq`	`UInt64`	是	已读序列号（与 read_seq 同义）
`lastSenderAvatarUrl`	`String`	是	最后一条消息发送者头像 URL
`lastSenderId`	`String`	否	最后发送者 ID。
`lastSenderNickname`	`String`	是	最后一条消息发送者展示名（列表用）
`maxSeq`	`UInt64`	是	最大序列号。
`memberPreview`	ConversationParticipantList	是	摘要级成员预览，最多少量成员，不能作为完整成员列表使用。
`membersCount`	`UInt32`	是	成员数量。
`mentionCount`	`UInt32`	是	提及数量。
`mentionMe`	`Boolean`	是	是否提及我。
`participantVersion`	`UInt64`	是	服务端成员读模型版本。完整成员通过独立 participants 同步拉取。
`participants`	ConversationParticipantList	是	已按需同步到本地的完整成员快照；会话摘要同步不会填充该字段。
`peerReadSeq`	`UInt64`	是	对端（其他成员）最大已读序列号；用于发送方已读双勾在重连/重登后恢复。由服务端同步摘要 `ext.peer_read_seq` 下发并持久化。
`remark`	`String`	否	备注。
`role`	`String`	否	角色。
`unreadCount`	`UInt32`	是	未读数。
`updatedAt`	`UInt64`	是	更新时间。
`updatedAtTs`	`UInt64`	否	更新时间戳（毫秒，用于排序/筛选）
`version`	`UInt64`	是	版本。
`visibleAfterSeq`	`UInt64`	是	当前用户的历史可见边界；seq <= visible_after_seq 的消息不可见，不参与冷启动回灌。

ConversationListQuery

client.conversations.listConversationsByQuery 的请求参数。

字段	类型	是否必填	说明
`conversationTypes`	ConversationTypeList	是	会话类型列表。
`cursor`	`String`	否	cursor 为会话 ID，表示从该会话之后开始。
`hasDraftOnly`	`Boolean`	是	仅包含有草稿会话。
`hasMarkedMessages`	`Boolean`	是	标记消息所在会话。当前没有“会话标签”模型，因此只支持消息标记聚合。
`includeArchived`	`Boolean`	是	是否包含归档会话。
`keyword`	`String`	否	关键词。
`limit`	`UInt32`	否	数量限制。
`mentionMeOnly`	`Boolean`	是	仅包含提及我会话。
`mutedOnly`	`Boolean`	否	仅包含静音会话。
`pinnedOnly`	`Boolean`	是	仅包含置顶会话。
`unreadOnly`	`Boolean`	是	布尔标记。

ConversationParticipant

ConversationParticipant 数据模型。

字段	类型	是否必填	说明
`attributes`	`StringMap`	是	扩展属性。
`joinedAt`	`UInt64`	是	joinedAt 字段。
`muted`	`Boolean`	是	是否静音。
`nickname`	`String`	是	昵称。
`pinned`	`Boolean`	是	是否置顶。
`roles`	`StringList`	是	角色列表。
`userId`	`String`	是	用户 ID。

ConversationTimelineSnapshot

client.conversations.openConversationTimeline 的返回结果。

字段	类型	是否必填	说明
`conversation`	Conversation	否	会话。
`hasMore`	`Boolean`	是	是否还有更多。
`messages`	MessageList	是	消息列表。

ConversationType

ConversationType 可选值。

值
`unspecified`
`single`
`group`
`ai`
`system`
`customer`
`temp`
`channel`
`broadcast`

DeleteConversationRequest

client.conversations.deleteConversation 的请求参数。

字段	类型	是否必填	说明
`payload`	`JsonObject`	否	对象参数。

GetConversationRequest

client.conversations.getConversation 的请求参数。

字段	类型	是否必填	说明
`payload`	`JsonObject`	否	对象参数。

GetGroupConversationByUserIdsRequest

client.conversations.getGroupConversationByUserIds 的请求参数。

字段	类型	是否必填	说明
`payload`	`JsonObject`	否	对象参数。

GetMultipleConversationsRequest

client.conversations.getMultipleConversations 的请求参数。

字段	类型	是否必填	说明
`payload`	`JsonObject`	否	对象参数。

GetOneConversationRequest

client.conversations.getOneConversation 的请求参数。

字段	类型	是否必填	说明
`payload`	`JsonObject`	否	对象参数。

HomeTimelineSnapshot

client.conversations.bootstrapHomeTimeline 的返回结果。

字段	类型	是否必填	说明
`conversations`	ConversationList	是	会话列表。
`syncState`	TimelineSyncState	是	同步状态。
`totalUnread`	`UInt64`	是	未读总数。

ListConversationsPaginatedRequest

client.conversations.listConversationsPaginated 的请求参数。

字段	类型	是否必填	说明
`payload`	`JsonObject`	否	对象参数。

ListConversationsResponse

client.conversations.listConversations 的返回结果。

字段	类型	是否必填	说明
`conversations`	ConversationList	是	返回的会话列表。

MarkConversationReadRequest

client.conversations.markConversationRead 的请求参数。

字段	类型	是否必填	说明
`payload`	`JsonObject`	否	对象参数。

MarkConversationUnreadRequest

client.conversations.markConversationUnread 的请求参数。

字段	类型	是否必填	说明
`payload`	`JsonObject`	否	对象参数。

MessagePreview

MessagePreview 数据模型。

字段	类型	是否必填	说明
`messageId`	`String`	是	消息 ID。
`senderId`	`String`	是	发送者 ID。
`text`	`String`	是	文本内容。
`time`	`UInt64`	是	毫秒时间戳
`type`	`Int32`	是	类型。

OpenConversationTimelineRequest

client.conversations.openConversationTimeline 的请求参数。

字段	类型	是否必填	说明
`conversationId`	`String`	是	会话 ID。
`messageLimit`	`UInt32`	是	消息数量限制。

SetConversationArchivedRequest

client.conversations.setConversationArchived 的请求参数。

字段	类型	是否必填	说明
`payload`	`JsonObject`	否	对象参数。

SetConversationMutedRequest

client.conversations.setConversationMuted 的请求参数。

字段	类型	是否必填	说明
`payload`	`JsonObject`	否	对象参数。

SetConversationPinnedRequest

client.conversations.setConversationPinned 的请求参数。

字段	类型	是否必填	说明
`payload`	`JsonObject`	否	对象参数。

TimelineSyncState

TimelineSyncState 可选值。

值
`localReady`
`synced`
`partial`

UpdateConversationDraftRequest

client.conversations.updateConversationDraft 的请求参数。

字段	类型	是否必填	说明
`conversationId`	`String`	是	需要更新草稿的会话 ID。
`draft`	`String`	否	草稿文本；省略或传 null 可清空草稿。

Messages

CreateTextMessageRequest

client.messages.createTextMessage 的请求参数。

字段	类型	是否必填	说明
`conversationId`	`String`	是	目标会话 ID。
`text`	`String`	是	文本正文。

DeleteMessageRequest

client.messages.deleteMessage 的请求参数。

字段	类型	是否必填	说明
`payload`	`JsonObject`	否	对象参数。

EditRichDocByMessageIdRequest

client.messages.editRichDocByMessageId 的请求参数。

字段	类型	是否必填	说明
`payload`	`JsonObject`	否	对象参数。

EditTextByMessageIdRequest

client.messages.editTextByMessageId 的请求参数。

字段	类型	是否必填	说明
`payload`	`JsonObject`	否	对象参数。

GetMessageRequest

client.messages.getMessage 的请求参数。

字段	类型	是否必填	说明
`payload`	`JsonObject`	否	对象参数。

ListMessagesRequest

client.messages.listMessages 的请求参数。

字段	类型	是否必填	说明
`conversationId`	`String`	是	会话 ID。
`beforeSeq`	`UInt64`	是	拉取该序列号之前的消息；0 表示最新一页。
`limit`	`UInt32`	是	分页大小。

ListMessagesResponse

client.messages.listMessages 的返回结果。

字段	类型	是否必填	说明
`messages`	MessageList	是	返回的消息列表。

MarkMessageReadAndBurnRequest

client.messages.markMessageReadAndBurn 的请求参数。

字段	类型	是否必填	说明
`payload`	`JsonObject`	否	对象参数。

Message

client.messageBuilder.buildAnnouncement 的返回结果。

字段	类型	是否必填	说明
`attributes`	`StringMap`	是	扩展属性。
`channelId`	`String`	是	会话频道 ID：单聊=对方 user_id，群聊=群 ID，频道/话题=对应 ID
`clientCreatedAt`	`UInt64`	是	客户端本地创建时间，Unix epoch millis。
`clientMsgId`	`String`	是	客户端生成ID（去重）
`content`	MessageContent	否	服务端结构
`conversationId`	`String`	是	会话ID
`conversationSeq`	`UInt64`	是	会话内持久化 replay 序列号。
`conversationType`	`Int32`	是	会话类型
`createdAt`	`UInt64`	是	消息创建时间，Unix epoch millis。
`extensions`	`BinaryMap`	是	扩展数据；未提供时为空。
`isEdited`	`Boolean`	是	是否已编辑。
`isRead`	`Boolean`	是	是否已读。
`isRecalled`	`Boolean`	是	是否已撤回。
`localState`	MessageLocalState	否	本地状态。
`mentionAll`	`Boolean`	是	是否提及所有人。
`mentionUsers`	`StringList`	是	提及用户列表。
`messageType`	`Int32`	是	消息类型
`quotePreview`	`String`	否	引用预览。
`reactions`	ReactionEntryList	是	表情反应快照（由 ReactionEvent 驱动更新并持久化）
`replyTo`	`String`	否	回复目标。
`senderAvatar`	`String`	是	发送者头像。
`senderDisplayName`	`String`	是	SDK计算展示名
`senderId`	`String`	是	发送者
`senderName`	`String`	是	发送者名称。
`serverId`	`String`	是	服务端唯一ID
`source`	`Int32`	是	消息来源
`status`	`Int32`	是	状态。
`textPreview`	`String`	是	列表、搜索、绑定层使用的纯文本预览。
`threadId`	`String`	否	话题/线程根消息 ID；普通消息为空，话题回复使用该 typed field。
`updatedAt`	`UInt64`	是	更新时间。
`version`	`UInt64`	是	版本。
`timelineKey`	`String`	是	时间线稳定键。
`timelineSortTs`	`UInt64`	是	时间线排序时间。

MessageContent

MessageContent 数据模型。

字段	类型	是否必填	说明
`contentType`	MessageContentType	是	内容类型标识。
`data`	`JsonObject`	是	内容负载对象。

MessageContentType

MessageContentType 可选值。

值
`text`
`image`
`video`
`audio`
`file`
`location`
`card`
`sticker`
`emoji`
`quote`
`link_card`
`forward`
`thread`
`mini_program`
`rich_text`
`image_group`
`system`
`notification`
`vote`
`task`
`schedule`
`announcement`
`custom`
`placeholder`

MessageDispatchRequest

client.messages.dispatchMessage 的请求参数。

字段	类型	是否必填	说明
`payload`	`JsonObject`	否	对象参数。

MessageLocalState

MessageLocalState 数据模型。

字段	类型	是否必填	说明
`failed`	`Boolean`	是	是否失败
`isLocal`	`Boolean`	是	本地消息
`sending`	`Boolean`	是	是否发送中
`sortTs`	`UInt64`	是	本地列表排序时间（毫秒），不是服务端会话 `conversation_seq`。用途：待发/未 ACK 消息常保持 `conversation_seq == 0`，可用本字段稳定停留在本地时间线尾部。已分配 `conversation_seq` 的服务端消息必须回到 seq 优先排序，避免设备时钟偏移污染权威顺序。
`uploadProgress`	`UInt32`	是	本地媒体上传进度，范围 0…=100。
`uploading`	`Boolean`	是	本地媒体上传中；仅用于 SDK 本地时间线展示，不写入服务端协议语义。

MessageMutationRequest

client.messages.pinMessage 的请求参数。

字段	类型	是否必填	说明
`payload`	`JsonObject`	否	对象参数。

MessageSearchKind

MessageSearchKind 可选值。

值
`image`
`video`
`audio`
`message`
`text`
`media`
`file`

MessageSearchQuery

client.messages.searchMessages 的请求参数。

字段	类型	是否必填	说明
`conversationId`	`String`	否	会话 ID。
`fromTime`	`UInt64`	否	起始消息时间（毫秒，含）。
`includeRecalled`	`Boolean`	是	默认排除已撤回消息。
`keyword`	`String`	否	关键词。
`kinds`	MessageSearchKindList	是	类型列表。
`limit`	`UInt32`	是	数量限制。
`senderId`	`String`	否	发送者 ID。
`toTime`	`UInt64`	否	截止消息时间（毫秒，含）。

ReactionEntry

ReactionEntry 数据模型。

字段	类型	是否必填	说明
`count`	`UInt32`	是	count 字段。
`emoji`	`String`	是	emoji 字段。
`userIds`	`StringList`	是	用户 ID 列表。

ReactionMutationRequest

client.messages.addReaction 的请求参数。

字段	类型	是否必填	说明
`payload`	`JsonObject`	否	对象参数。

RecallMessageRequest

client.messages.recallMessage 的请求参数。

字段	类型	是否必填	说明
`payload`	`JsonObject`	否	对象参数。

SendMessageRequest

client.messages.sendMessageNoOss 的请求参数。

字段	类型	是否必填	说明
`message`	Message	是	要发送的消息。

SendMessageResponse

client.messages.sendMessageNoOss 的返回结果。

字段	类型	是否必填	说明
`ackId`	`String`	是	确认 ID。
`serverId`	`String`	是	服务端分配的消息 ID。
`clientMsgId`	`String`	是	服务端确认的客户端消息 ID。
`conversationId`	`String`	是	会话 ID。
`seq`	`UInt64`	是	分配的会话序列号。
`timestamp`	`UInt64`	是	服务端发送时间，单位为毫秒。
`success`	`Boolean`	是	是否成功。
`errorCode`	`Int32`	是	错误码。
`errorMessage`	`String`	是	错误消息。

SetTypingRequest

client.messages.setTyping 的请求参数。

字段	类型	是否必填	说明
`payload`	`JsonObject`	否	对象参数。

消息内容

AudioContentPayload

AudioContentPayload 数据模型。

字段	类型	是否必填	说明
`audioId`	`String`	否	已上传音频 ID。
`source`	MediaSourceInfo	否	音频来源。
`durationMs`	`Int32`	否	时长。

FileContentPayload

FileContentPayload 数据模型。

字段	类型	是否必填	说明
`fileId`	`String`	否	已上传文件 ID。
`name`	`String`	否	展示名称。
`url`	`String`	否	下载 URL。
`mimeType`	`String`	否	MIME 类型。
`size`	`UInt64`	否	字节大小。

ForwardSourceMessage

ForwardSourceMessage 数据模型。

字段	类型	是否必填	说明
`sourceMessageId`	`String`	是	原始消息 ID。
`sourceConversationId`	`String`	否	原始会话 ID。
`sourceSenderId`	`String`	否	原始发送者 ID。
`plainText`	`String`	否	预览文本。

ImageContentPayload

ImageContentPayload 数据模型。

字段	类型	是否必填	说明
`imageId`	`String`	否	已上传图片 ID。
`source`	MediaSourceInfo	否	来源描述。
`thumbnail`	MediaSourceInfo	否	缩略图描述。
`description`	`String`	否	说明文本。

ImageGroupContentPayload

ImageGroupContentPayload 数据模型。

字段	类型	是否必填	说明
`images`	ImageGroupItemList	是	分组图片。
`title`	`String`	否	分组标题。

ImageGroupItem

ImageGroupItem 数据模型。

字段	类型	是否必填	说明
`imageId`	`String`	是	图片 ID。
`url`	`String`	否	解析后的 URL。
`title`	`String`	否	条目标题。
`width`	`Int32`	否	宽度。
`height`	`Int32`	否	高度。

MediaSourceInfo

MediaSourceInfo 数据模型。

字段	类型	是否必填	说明
`uuid`	`String`	否	稳定媒体 UUID。
`imageId`	`String`	否	适用时的图片 ID。
`url`	`String`	否	解析后的 URL。
`mimeType`	`String`	否	MIME 类型。
`size`	`UInt64`	否	字节大小。
`width`	`Int32`	否	宽度，单位为像素。
`height`	`Int32`	否	高度，单位为像素。
`blurhash`	`String`	否	图片预览的 BlurHash 占位符。
`durationMs`	`Int32`	否	音频或视频时长。

StickerContentPayload

StickerContentPayload 数据模型。

字段	类型	是否必填	说明
`stickerId`	`String`	是	贴纸 ID。
`packageId`	`String`	否	贴纸包 ID。
`url`	`String`	否	贴纸 URL。
`width`	`Int32`	否	宽度。
`height`	`Int32`	否	高度。
`format`	`String`	否	webp/gif/png 格式。

VideoContentPayload

VideoContentPayload 数据模型。

字段	类型	是否必填	说明
`videoId`	`String`	否	已上传视频 ID。
`source`	MediaSourceInfo	否	视频来源。
`cover`	MediaSourceInfo	否	封面图。
`description`	`String`	否	说明文本。

Message Builder

BuildAnnouncementMessageRequest

client.messageBuilder.buildAnnouncement 的请求参数。

字段	类型	是否必填	说明
`conversationId`	`String`	是	目标会话 ID。
`title`	`String`	是	公告标题。
`body`	`String`	是	公告正文。

BuildAudioMessageRequest

client.messageBuilder.buildAudio 的请求参数。

字段	类型	是否必填	说明
`conversationId`	`String`	是	目标会话 ID。
`audioId`	`String`	是	已上传音频 ID。
`payload`	AudioContentPayload	否	可选音频负载。

BuildCardMessageRequest

client.messageBuilder.buildCard 的请求参数。

字段	类型	是否必填	说明
`conversationId`	`String`	是	目标会话 ID。
`id`	`String`	是	卡片目标 ID。
`cardType`	`String`	否	卡片类型标识。
`title`	`String`	否	展示标题。
`subtitle`	`String`	否	展示副标题。
`avatar`	`String`	否	头像 URL 或媒体 ID。

BuildCustomMessageRequest

client.messageBuilder.buildCustom 的请求参数。

字段	类型	是否必填	说明
`conversationId`	`String`	是	目标会话 ID。
`type`	`String`	是	扩展类型标识。

BuildEmojiMessageRequest

client.messageBuilder.buildEmoji 的请求参数。

字段	类型	是否必填	说明
`conversationId`	`String`	是	目标会话 ID。
`emoji`	`String`	是	表情标识。

BuildFileMessageRequest

client.messageBuilder.buildFile 的请求参数。

字段	类型	是否必填	说明
`conversationId`	`String`	是	目标会话 ID。
`fileId`	`String`	是	已上传文件 ID。
`payload`	FileContentPayload	否	可选文件负载。

BuildForwardMessageRequest

client.messageBuilder.buildForward 的请求参数。

字段	类型	是否必填	说明
`conversationId`	`String`	是	目标会话 ID。
`merge`	`Boolean`	否	是否合并为一张卡片。
`title`	`String`	是	转发标题。
`sourceMessages`	ForwardSourceMessageList	是	需要转发的消息列表。

BuildImageGroupMessageRequest

client.messageBuilder.buildImageGroup 的请求参数。

字段	类型	是否必填	说明
`conversationId`	`String`	是	目标会话 ID。
`payload`	ImageGroupContentPayload	是	图片组负载。

BuildImageMessageRequest

client.messageBuilder.buildImage 的请求参数。

字段	类型	是否必填	说明
`conversationId`	`String`	是	目标会话 ID。
`imageId`	`String`	是	已上传图片 ID。
`payload`	ImageContentPayload	否	用于 UI 预览的可选图片负载。

BuildLinkCardMessageRequest

client.messageBuilder.buildLinkCard 的请求参数。

字段	类型	是否必填	说明
`conversationId`	`String`	是	目标会话 ID。
`url`	`String`	是	链接 URL。
`title`	`String`	否	卡片标题。
`description`	`String`	否	卡片说明。
`thumbnailUrl`	`String`	否	缩略图 URL。
`siteName`	`String`	否	站点名称。

BuildLocationMessageRequest

client.messageBuilder.buildLocation 的请求参数。

字段	类型	是否必填	说明
`conversationId`	`String`	是	目标会话 ID。
`latitude`	`Double`	是	纬度。
`longitude`	`Double`	是	经度。
`title`	`String`	否	地点标题。
`address`	`String`	否	地址。

BuildMiniProgramMessageRequest

client.messageBuilder.buildMiniProgram 的请求参数。

字段	类型	是否必填	说明
`conversationId`	`String`	是	目标会话 ID。
`appId`	`String`	是	小程序应用 ID。
`pagePath`	`String`	否	入口路径。
`title`	`String`	否	展示标题。
`thumbnailUrl`	`String`	否	缩略图 URL。
`extra`	`StringMap`	否	小程序扩展字段。

BuildNotificationMessageRequest

client.messageBuilder.buildNotification 的请求参数。

字段	类型	是否必填	说明
`conversationId`	`String`	是	目标会话 ID。
`title`	`String`	是	通知标题。
`body`	`String`	是	通知正文。

BuildPlaceholderMessageRequest

client.messageBuilder.buildPlaceholder 的请求参数。

字段	类型	是否必填	说明
`conversationId`	`String`	是	目标会话 ID。
`reason`	`String`	是	占位原因。

BuildQuoteMessageRequest

client.messageBuilder.buildQuote 的请求参数。

字段	类型	是否必填	说明
`conversationId`	`String`	是	目标会话 ID。
`quotedMessageId`	`String`	是	被引用消息 ID。
`text`	`String`	是	回复文本。
`quotedSenderId`	`String`	否	被引用消息发送者 ID。
`quotedTextPreview`	`String`	否	被引用消息预览文本。
`quotedContent`	MessageContent	是	被引用消息内容元素。

BuildRichDocMessageRequest

client.messageBuilder.buildRichDoc 的请求参数。

字段	类型	是否必填	说明
`conversationId`	`String`	是	目标会话 ID。
`docJson`	`String`	是	富文档 JSON 内容。
`contentSchema`	`String`	是	内容结构标识，通常为 rich_doc。
`plainText`	`String`	是	可读纯文本。
`inputFormat`	`String`	否	已知时的原始来源格式。
`inputFormatVersion`	`Int32`	否	原始来源格式版本。
`sourcePayload`	`StringMap`	否	按格式保存的原始来源快照。
`title`	`String`	否	标题。
`searchText`	`String`	否	可用于搜索索引的文本。
`renderHintsJson`	`String`	否	渲染提示 JSON。

BuildScheduleMessageRequest

client.messageBuilder.buildSchedule 的请求参数。

字段	类型	是否必填	说明
`conversationId`	`String`	是	目标会话 ID。
`scheduleId`	`String`	是	日程 ID。
`title`	`String`	是	日程标题。
`startTimeMs`	`Int64`	是	开始时间，Unix epoch 毫秒。
`endTimeMs`	`Int64`	是	结束时间，Unix epoch 毫秒。
`participantUserIds`	`StringList`	是	日程参与者。

BuildStickerMessageRequest

client.messageBuilder.buildSticker 的请求参数。

字段	类型	是否必填	说明
`conversationId`	`String`	是	目标会话 ID。
`stickerId`	`String`	是	贴纸 ID。
`packageId`	`String`	否	贴纸包 ID。
`payload`	StickerContentPayload	否	可选贴纸负载。

BuildSystemMessageRequest

client.messageBuilder.buildSystem 的请求参数。

字段	类型	是否必填	说明
`conversationId`	`String`	是	目标会话 ID。
`eventKind`	`String`	是	系统事件类型。
`body`	`String`	是	系统事件正文。

BuildTaskMessageRequest

client.messageBuilder.buildTask 的请求参数。

字段	类型	是否必填	说明
`conversationId`	`String`	是	目标会话 ID。
`taskId`	`String`	是	任务 ID。
`title`	`String`	是	任务标题。
`status`	`String`	否	任务状态。
`participantUserIds`	`StringList`	是	任务参与者。

BuildTextMessageRequest

client.messageBuilder.buildText 的请求参数。

字段	类型	是否必填	说明
`conversationId`	`String`	是	目标会话 ID。
`text`	`String`	是	文本正文。
`mentionUsers`	`StringList`	否	提及用户列表。
`mentionAll`	`Boolean`	否	是否提及所有人。

BuildThreadReplyMessageRequest

client.messageBuilder.buildThreadReply 的请求参数。

字段	类型	是否必填	说明
`conversationId`	`String`	是	目标会话 ID。
`threadId`	`String`	是	会话线程根消息 ID。
`text`	`String`	是	回复文本。

BuildVideoMessageRequest

client.messageBuilder.buildVideo 的请求参数。

字段	类型	是否必填	说明
`conversationId`	`String`	是	目标会话 ID。
`videoId`	`String`	是	已上传视频 ID。
`payload`	VideoContentPayload	否	可选视频负载。

BuildVoteMessageRequest

client.messageBuilder.buildVote 的请求参数。

字段	类型	是否必填	说明
`conversationId`	`String`	是	目标会话 ID。
`voteId`	`String`	是	投票 ID。
`title`	`String`	是	投票标题。
`options`	`StringList`	是	投票选项。
`participantUserIds`	`StringList`	是	允许投票的参与者。

BuildWithContentMessageRequest

client.messageBuilder.buildWithContent 的请求参数。

字段	类型	是否必填	说明
`conversationId`	`String`	是	目标会话 ID。
`content`	MessageContent	是	已解析的内容封装。

ListMessageBuildCatalogResponse

client.messageBuilder.listSupportedBuildOperations 的返回结果。

字段	类型	是否必填	说明
`entries`	MessageBuildCatalogEntryList	是	条目列表。

MessageBuildCatalogEntry

MessageBuildCatalogEntry 数据模型。

字段	类型	是否必填	说明
`op`	MessageBuildOp	是	op 字段。
`method`	`String`	是	公开方法名，例如 buildText。
`requestType`	`String`	是	请求模型名称。
`contentType`	MessageContentType	是	内容类型标识。
`messageType`	`Int32`	是	消息类型。
`summary`	`String`	是	用于界面和文档的可读摘要。
`stability`	`String`	是	stability 字段。

MessageBuildOp

MessageBuildOp 可选值。

值
`create_text`
`create_quote`
`create_thread_reply`
`create_forward`
`create_image`
`create_image_group`
`create_video`
`create_audio`
`create_file`
`create_emoji`
`create_location`
`create_sticker`
`create_link_card`
`create_card`
`create_mini_program`
`create_rich_doc`
`create_system`
`create_notification`
`create_vote`
`create_task`
`create_schedule`
`create_announcement`
`create_custom`
`create_placeholder`
`create_with_content`

NormalizeRichDocFromDocJsonRequest

client.messageBuilder.normalizeRichDocFromDocJson 的请求参数。

字段	类型	是否必填	说明
`docJson`	`String`	是	RichDoc v2 文档 JSON。

NormalizeRichDocFromHtmlRequest

client.messageBuilder.normalizeRichDocFromHtml 的请求参数。

字段	类型	是否必填	说明
`html`	`String`	是	HTML 片段来源。

NormalizeRichDocFromMarkdownRequest

client.messageBuilder.normalizeRichDocFromMarkdown 的请求参数。

字段	类型	是否必填	说明
`markdown`	`String`	是	Markdown 来源文本。

RichDocV2Normalized

client.messageBuilder.normalizeRichDocFromMarkdown 的返回结果。

字段	类型	是否必填	说明
`docJson`	`String`	是	标准化 RichDoc v2 文档 JSON。
`contentSchema`	`String`	是	内容结构标识，通常为 rich_doc。
`version`	`UInt32`	是	RichDoc 结构版本。
`plainText`	`String`	是	从文档中提取的可读纯文本。
`searchText`	`String`	是	从文档中提取的可搜索文本。
`renderHints`	`JsonObject`	是	渲染提示对象。
`inputFormat`	`String`	否	已知时的原始来源格式。
`sourcePayload`	`JsonObject`	否	按格式保存的原始来源快照。

Sync

ConversationVersion

ConversationVersion 数据模型。

字段	类型	是否必填	说明
`conversationId`	`String`	是	会话 ID。
`version`	`UInt64`	是	版本。

SyncConversationRequest

client.sync.syncConversation 的请求参数。

字段	类型	是否必填	说明
`payload`	`JsonObject`	否	对象参数。

SyncConversationSummariesRequest

client.sync.syncConversationSummariesWithVersions 的请求参数。

字段	类型	是否必填	说明
`knownVersions`	ConversationVersionList	是	已知版本。

SyncConversationSummariesResponse

client.sync.syncConversationSummariesWithVersions 的返回结果。

字段	类型	是否必填	说明
`changedConversations`	ConversationVersionList	是	列表字段。

SyncMessagesRequest

client.sync.syncMessages 的请求参数。

字段	类型	是否必填	说明
`payload`	`JsonObject`	否	对象参数。

Presence

BatchGetUserPresenceRequest

client.presence.batchGetUserPresence 的请求参数。

字段	类型	是否必填	说明
`payload`	`JsonObject`	否	对象参数。

BatchGetUserPresenceResponse

client.presence.batchGetUserPresence 的返回结果。

字段	类型	是否必填	说明
`payload`	`JsonObject`	否	对象参数。

GetUserPresenceRequest

client.presence.getUserPresence 的请求参数。

字段	类型	是否必填	说明
`payload`	`JsonObject`	否	对象参数。

SubscribeUserPresenceRequest

client.presence.subscribeUserPresence 的请求参数。

字段	类型	是否必填	说明
`payload`	`JsonObject`	否	对象参数。

UserPresence

client.presence.getUserPresence 的返回结果。

字段	类型	是否必填	说明
`payload`	`JsonObject`	否	对象参数。

Media

CacheRemoteMediaRequest

client.media.cacheRemoteMedia 的请求参数。

字段	类型	是否必填	说明
`payload`	`JsonObject`	否	对象参数。

CancelUserFileDownloadRequest

client.media.cancelUserFileDownload 的请求参数。

字段	类型	是否必填	说明
`payload`	`JsonObject`	否	对象参数。

DeleteMediaFileRequest

client.media.deleteFile 的请求参数。

字段	类型	是否必填	说明
`payload`	`JsonObject`	否	对象参数。

DeleteMediaFileResponse

client.media.deleteFile 的返回结果。

字段	类型	是否必填	说明
`payload`	`JsonObject`	否	对象参数。

DeleteUserDownloadRecordRequest

client.media.deleteUserDownloadRecord 的请求参数。

字段	类型	是否必填	说明
`payload`	`JsonObject`	否	对象参数。

DownloadFileToDownloadsRequest

client.media.downloadFileToDownloads 的请求参数。

字段	类型	是否必填	说明
`payload`	`JsonObject`	否	对象参数。

GetMediaUrlRequest

client.media.getMediaUrl 的请求参数。

字段	类型	是否必填	说明
`payload`	`JsonObject`	否	对象参数。

GetUserDownloadSavedPathRequest

client.media.getUserDownloadSavedPath 的请求参数。

字段	类型	是否必填	说明
`payload`	`JsonObject`	否	对象参数。

MediaAccessUrl

client.media.getMediaUrl 的返回结果。

字段	类型	是否必填	说明
`payload`	`JsonObject`	否	对象参数。

MediaCacheEntry

client.media.cacheRemoteMedia 的返回结果。

字段	类型	是否必填	说明
`payload`	`JsonObject`	否	对象参数。

MediaCacheStats

client.media.getMediaCacheStats 的返回结果。

字段	类型	是否必填	说明
`payload`	`JsonObject`	否	对象参数。

MediaResolvedAccess

client.media.resolveMediaAccess 的返回结果。

字段	类型	是否必填	说明
`payload`	`JsonObject`	否	对象参数。

MediaUploadResponse

client.media.uploadFile 的返回结果。

字段	类型	是否必填	说明
`payload`	`JsonObject`	否	对象参数。

ResolveMediaAccessRequest

client.media.resolveMediaAccess 的请求参数。

字段	类型	是否必填	说明
`payload`	`JsonObject`	否	对象参数。

SetMediaCacheMaxBytesRequest

client.media.setMediaCacheMaxBytes 的请求参数。

字段	类型	是否必填	说明
`payload`	`JsonObject`	否	对象参数。

SetMediaCacheRootRequest

client.media.setMediaCacheRoot 的请求参数。

字段	类型	是否必填	说明
`payload`	`JsonObject`	否	对象参数。

SetUserDownloadSubfolderRequest

client.media.setUserDownloadSubfolder 的请求参数。

字段	类型	是否必填	说明
`payload`	`JsonObject`	否	对象参数。

TempDownloadUrlRequest

client.media.getTempDownloadUrl 的请求参数。

字段	类型	是否必填	说明
`payload`	`JsonObject`	否	对象参数。

UploadBytesRequest

client.media.uploadBytes 的请求参数。

字段	类型	是否必填	说明
`payload`	`JsonObject`	否	对象参数。

UploadFileRequest

client.media.uploadFile 的请求参数。

字段	类型	是否必填	说明
`payload`	`JsonObject`	否	对象参数。

UserDownloadSavedPathResponse

client.media.getUserDownloadSavedPath 的返回结果。

字段	类型	是否必填	说明
`payload`	`JsonObject`	否	对象参数。

UserDownloadSubfolderResponse

client.media.getUserDownloadSubfolder 的返回结果。

字段	类型	是否必填	说明
`payload`	`JsonObject`	否	对象参数。

Capabilities

DispatchCapabilityRequest

client.capabilities.dispatchCapability 的请求参数。

字段	类型	是否必填	说明
`payload`	`JsonObject`	否	对象参数。

DispatchCapabilityResponse

client.capabilities.dispatchCapability 的返回结果。

字段	类型	是否必填	说明
`payload`	`JsonObject`	否	对象参数。

GrantCapabilityRequest

client.capabilities.grantCapability 的请求参数。

字段	类型	是否必填	说明
`payload`	`JsonObject`	否	对象参数。

ListCapabilitiesRequest

client.capabilities.listCapabilities 的请求参数。

字段	类型	是否必填	说明
`payload`	`JsonObject`	否	对象参数。

ListCapabilitiesResponse

client.capabilities.listCapabilities 的返回结果。

字段	类型	是否必填	说明
`payload`	`JsonObject`	否	对象参数。

ListUserCapabilitiesRequest

client.capabilities.listUserCapabilities 的请求参数。

字段	类型	是否必填	说明
`payload`	`JsonObject`	否	对象参数。

ListUserCapabilitiesResponse

client.capabilities.listUserCapabilities 的返回结果。

字段	类型	是否必填	说明
`payload`	`JsonObject`	否	对象参数。

RevokeCapabilityRequest

client.capabilities.revokeCapability 的请求参数。

字段	类型	是否必填	说明
`payload`	`JsonObject`	否	对象参数。

SendCallSignalRequest

client.capabilities.sendCallSignal 的请求参数。

字段	类型	是否必填	说明
`payload`	`JsonObject`	否	对象参数。

Events

SubscribeEventsRequest

client.events.subscribeEvents 的请求参数。

字段	类型	是否必填	说明
`payload`	`JsonObject`	否	对象参数。

Subscription

client.events.subscribeEvents 的返回结果。

字段	类型	是否必填	说明
`payload`	`JsonObject`	否	对象参数。

UnsubscribeRequest

client.events.unsubscribe 的请求参数。

字段	类型	是否必填	说明
`payload`	`JsonObject`	否	对象参数。

Diagnostics

SdkVersion

client.diagnostics.getSdkVersion 的返回结果。

字段	类型	是否必填	说明
`payload`	`JsonObject`	否	对象参数。

Types

ConnectionState

ConnectionState 数据模型。

字段	类型	是否必填	说明
`payload`	`JsonObject`	否	对象参数。

ConversationList

ConversationList 集合别名。

Alias	Type
`ConversationList`	Conversation[]

ConversationParticipantList

ConversationParticipantList 集合别名。

Alias	Type
`ConversationParticipantList`	ConversationParticipant[]

ConversationTypeList

ConversationTypeList 集合别名。

Alias	Type
`ConversationTypeList`	ConversationType[]

ConversationVersionList

ConversationVersionList 集合别名。

Alias	Type
`ConversationVersionList`	ConversationVersion[]

ForwardSourceMessageList

ForwardSourceMessageList 集合别名。

Alias	Type
`ForwardSourceMessageList`	ForwardSourceMessage[]

ImageGroupItemList

ImageGroupItemList 集合别名。

Alias	Type
`ImageGroupItemList`	ImageGroupItem[]

MessageBuildCatalogEntryList

MessageBuildCatalogEntryList 集合别名。

Alias	Type
`MessageBuildCatalogEntryList`	MessageBuildCatalogEntry[]

MessageList

MessageList 集合别名。

Alias	Type
`MessageList`	Message[]

MessageSearchKindList

MessageSearchKindList 集合别名。

Alias	Type
`MessageSearchKindList`	MessageSearchKind[]

ReactionEntryList

ReactionEntryList 集合别名。

Alias	Type
`ReactionEntryList`	ReactionEntry[]

SdkResourceProfile

SdkResourceProfile 数据模型。

字段	类型	是否必填	说明
`payload`	`JsonObject`	否	对象参数。