本文介绍网易云信即时通讯 SDK（简称 NIM SDK）客户端接口类和枚举信息。

类

NIMResult

操作结果回调。T 表示操作返回的数据类型。

dartNIMResult.success({String? message, dynamic data}) : this(0, data, message);
NIMResult.failure({int code = -1, String? message})
    : this(code, null, message);
NIMResult(this.code, this.data, this.errorDetails);
factory NIMResult.fromMap(Map<String, dynamic> map,
    {NIMResultDataConvert<T>? convert}) {
  var data = map['data'];
  var code = map['code'];
  var errorDetails = map['errorDetails'];
  if (data != null && convert != null) {
    final result = NIMResult(
        code, convert(Map<String, dynamic>.from(data)), errorDetails);
    assert(() {
      result._sourceMap = map;
      return true;
    }());
    return result;
  } else {
    return NIMResult(code, data as T?, errorDetails);
  }
}

成员函数

• success：操作成功回调
• failure：操作失败回调
• fromMap：数据转换回调
• 错误信息，具体错误码请参考 API 错误码文档。

NIMError

错误信息。具体错误码请参考 API 错误码文档。

DartNIMError({
int? code,
String? desc,
Map<String, dynamic>? detail,
})

NIMLoginOption

登录配置参数。

dartNIMLoginOption({
int? retryCount,
int? timeout,
NIMLoginAuthType? authType,
bool? forceMode,
NIMDataSyncLevel? syncLevel,
bool extensionProvider = false,
bool tokenProvider = false,
})

NIMLoginClient

当前处于登录状态的客户端信息对象。

dartNIMLoginClient({
NIMLoginClientType? type,
String? clientId,
String? os,
int? customClientType,
String? customTag,
int? timestamp,
String? clientIP,
})

NIMKickedOfflineDetail

登录客户端被踢详细信息对象。

dartNIMKickedOfflineDetail({
  int? customClientType,
  NIMLoginClientType? clientType,
  NIMKickedOfflineReason? reason,
  String? reasonDesc,
})

NIMDataSyncDetail

数据同步状态详细信息对象。

dartNIMDataSyncDetail({
  NIMDataSyncType? type,
  NIMDataSyncState? state,
})

NIMLoginClientChangeEvent

登录客户端变更事件。

dartNIMLoginClientChangeEvent({
NIMLoginClientChange? change,
List<NIMLoginClient>? clients,
})

NIMConversationOption

会话查询选项。

dartNIMConversationOption({
  required List<NIMConversationType> conversationTypes,
  required bool onlyUnread,
  required List<String> conversationGroupIds,
})

NIMConversationResult

会话查询结果。

dartNIMConversationResult({
  List<NIMConversation>? conversationList,
  required int offset,
  required bool finished,
})

NIMConversation

会话对象。

dartNIMConversation({
required String conversationId,
required NIMConversationType type,
String? name,
String? avatar,
required bool mute,
required bool stickTop,
List<String>? groupIds,
String? localExtension,
String? serverExtension,
NIMLastMessage? lastMessage,
int? unreadCount,
int? sortOrder,
required int createTime,
required int updateTime,
})

NIMConversationFilter

会话过滤器对象。

dartNIMConversationFilter({
  List<NIMConversationType>? conversationTypes,
  String? conversationGroupId,
  bool? ignoreMuted,
})

NIMConversationOperationResult

单条会话操作结果。

dartNIMConversationOperationResult({
  String? conversationId,
  NIMError? error,
})

NIMConversationUpdate

会话更新对象。

dartNIMConversationUpdate({
  required String serverExtension,
})

ConversationIdUtil

会话 ID 构建工具。

成员函数

• p2pConversationId

  构造单聊会话 ID。

  参数名称	类型	说明
  accountId	String	聊天对象账号

• teamConversationId

  构造群聊（高级群）会话 ID。

  参数名称	类型	说明
  teamId	String	高级群的群组 ID

• superTeamConversationId

  构造群聊（超大群）会话 ID。

  参数名称	类型	说明
  superTeamId	String	超大群的群组 ID

• conversationType

  解析会话类型。提取拼接的中间段。

  参数名称	类型	说明
  conversationId	String	会话 ID

  返回值：NIMConversationType

• conversationTargetId

  解析会话目标账号。提取拼接的最后一段。

  参数名称	类型	说明
  conversationId	String	会话 ID

  返回值：String targetId

NIMMessage

单聊、群组会话内消息对象。

dartNIMMessage({
bool? isSelf,
NIMMessageAttachmentUploadState? attachmentUploadState,
NIMMessageSendingState? sendingState,
NIMMessageType? messageType,
int? subType,
String? text,
NIMMessageAttachment? attachment,
String? serverExtension,
String? localExtension,
String? callbackExtension,
NIMMessageConfig? messageConfig,
NIMMessagePushConfig? pushConfig,
NIMMessageRouteConfig? routeConfig,
NIMMessageAntispamConfig? antispamConfig,
NIMMessageRobotConfig? robotConfig,
NIMMessageRefer? threadRoot,
NIMMessageRefer? threadReply,
NIMMessageAIConfig? aiConfig,
NIMMessageStatus? messageStatus,
int? modifyTime,
String? modifyAccountId,
})

NIMMessageFilter

消息过滤器。

dartNIMMessageFilter = Future<bool> Function(
NIMMessage message
)
NIMMessageFilter? shouldIgnore;

回调函数

• shouldIgnore

  该消息是否过滤。返回 true 表示需要过滤该消息，false 表示不过滤。

  参数名称	类型	是否只读	说明
  message	NIMMessage	是	当前接收到的消息。

NIMMessageStatus

消息状态对象，包含消息发送失败的错误码以及是否已发送过已读回执。

dartNIMMessageStatus({
int? errorCode,
bool? readReceiptSent,
})

NIMMessageConfig

消息相关配置。

dartNIMMessageConfig({
bool? readReceiptEnabled,
bool? lastMessageUpdateEnabled,
bool? historyEnabled,
bool? roamingEnabled,
bool? onlineSyncEnabled,
bool? offlineEnabled,
bool? unreadEnabled,
})

NIMMessagePushConfig

消息第三方推送相关配置。

dartNIMMessagePushConfig({
bool? pushEnabled,
bool? pushNickEnabled,
String? pushContent,
String? pushPayload,
bool? forcePush,
String? forcePushContent,
List<String?>? forcePushAccountIds,
})

NIMMessageRouteConfig

消息事件抄送相关配置。

dartNIMMessageRouteConfig({
bool? routeEnabled,
String? routeEnvironment,
})

NIMMessageAntispamConfig

消息反垃圾配置，包括客户端本地反垃圾和安全通的相关配置。

dartNIMMessageAntispamConfig({
bool? antispamEnabled,
String? antispamBusinessId,
String? antispamCustomMessage,
String? antispamCheating,
String? antispamExtension,
})

NIMMessageRobotConfig

消息机器人相关配置。

dartNIMMessageRobotConfig({
String? accountId,
String? topic,
String? function,
String? customContent,
})

NIMLastMessage

会话最后一条消息。包含以下场景：

• 发送的最后一条消息
• 接收的最后一条消息
• 插入的最后一条消息
• 撤回消息的通知

dartNIMLastMessage({
NIMLastMessageState? lastMessageState,
NIMMessageRefer? messageRefer,
NIMMessageType? messageType,
int? subType,
NIMMessageSendingState? sendingState,
String? text,
NIMMessageAttachment? attachment,
String? revokeAccountId,
NIMMessageRevokeType? revokeType,
String? serverExtension,
String? callbackExtension,
String? senderName,
})

NIMMessageQuickComment

消息快捷评论对象。

dartNIMMessageQuickComment({
NIMMessageRefer? messageRefer,
String? operatorId,
int? index,
int? createTime,
String? serverExtension,
})

NIMMessageQuickCommentPushConfig

快捷评论推送配置。

dartNIMMessageQuickCommentPushConfig({
bool? pushEnabled,
bool? needBadge,
String? pushTitle,
String? pushContent,
String? pushPayload,
})

NIMMessagePin

Pin 消息对象。

dartNIMMessagePin({
NIMMessageRefer? messageRefer,
String? operatorId,
String? serverExtension,
int? createTime,
int? updateTime,
})

NIMCollection

消息收藏对象。

dartNIMCollection({
String? collectionId,
int? collectionType,
String? collectionData,
String? serverExtension,
int? createTime,
int? updateTime,
String? uniqueId,
})

NIMAddCollectionParams

消息收藏配置参数。

dartNIMAddCollectionParams({
int? collectionType,
String? collectionData,
String? serverExtension,
String? uniqueId,
})

NIMCollectionOption

分页查询消息收藏选项。

dartNIMCollectionOption({
int? beginTime,
int? endTime,
NIMQueryDirection? direction,
NIMCollection? anchorCollection,
int? limit,
int? collectionType,
})

NIMCollectionListResult

分页查询收藏信息结果。

dartNIMCollectionListResult({
int? totalCount,
List<NIMCollection>? collectionList,
})

NIMSendMessageParams

消息发送参数配置。

dartNIMSendMessageParams({
NIMMessageConfig? messageConfig,
NIMMessageRouteConfig? routeConfig,
NIMMessagePushConfig? pushConfig,
NIMMessageAntispamConfig? antispamConfig,
NIMMessageRobotConfig? robotConfig,
NIMMessageAIConfigParams? aiConfig,
bool? clientAntispamEnabled,
String? clientAntispamReplace,
})

NIMMessageTargetConfig

群定向消息数据结构。

dartNIMMessageTargetConfig({
bool inclusive = true,
bool newMemberVisible = false,
List<String>? receiverIds,
})

NIMModifyMessageParams

消息更新参数配置。

dartNIMModifyMessageParams({
NIMMessageAttachment? attachment,
String? serverExtension,
NIMMessagePushConfig? pushConfig,
String? text,
NIMMessageAntispamConfig? antispamConfig,
bool clientAntispamEnabled = false,
String? clientAntispamReplace,
NIMMessageRouteConfig? routeConfig,
int? subType,
})

NIMModifyMessageResult

更新消息结果信息。

DartNIMModifyMessageResult({
NIMMessage? message,
String? antispamResult,
NIMClientAntispamResult? clientAntispamResult,
int? errorCode,
})

NIMUpdateLocalMessageParams

本地插入消息更新的配置参数。

dartNIMUpdateLocalMessageParams({
int? subType,
String? text,
NIMMessageAttachment? attachment,
String? localExtension,
NIMMessageSendingState? sendingState,
})

NIMMessageRefer

消息参考信息对象。

dartNIMMessageRefer({
String? senderId,
String? receiverId,
String? messageClientId,
String? messageServerId,
NIMConversationType? conversationType,
String? conversationId,
int? createTime,
})

NIMMessageAttachment

消息附件对象。

dartNIMMessageAttachment({
  String? raw,
})

NIMDownloadMessageAttachmentParams

下载消息附件的请求配置参数。

dartNIMDownloadMessageAttachmentParams({
required NIMMessageAttachment attachment,
required NIMDownloadAttachmentType type,
required NIMSize thumbSize,
String? messageClientId,
String? saveAs,
})

NIMGetMediaResourceInfoResult

下载消息附件的返回结果。

dartNIMGetMediaResourceInfoResult({
String? url,
Map<String, String>? authHeaders,
})

NIMSize

二维平面大小。

dartNIMSize({
int? width,
int? height,
})

NIMMessageFileAttachment

文件类型消息的附件对象，继承自 NIMMessageAttachment。

dartNIMMessageFileAttachment({
String? path,
int? size,
String? md5,
String? url,
String? ext,
String? name,
String? sceneName,
NIMMessageAttachmentUploadState? uploadState,
})

NIMMessageImageAttachment

图片附件对象，继承自 NIMMessageFileAttachment。

dartNIMMessageImageAttachment({
int? width,
int? height,
})

NIMMessageAudioAttachment

语音附件对象，继承自 NIMMessageFileAttachment。

dartNIMMessageAudioAttachment({
int? duration,
})

NIMMessageVideoAttachment

视频附件对象，继承自 NIMMessageFileAttachment。

dartNIMMessageVideoAttachment({
int? duration,
int? width,
int? height,
})

NIMMessageCallAttachment

话单消息附件对象，继承自 NIMMessageAttachment。

dartNIMMessageCallAttachment({
int? type,
String? channelId,
int? status,
List<NIMMessageCallDuration?>? durations,
})

NIMMessageCallDuration

话单消息单人通话时长对象。

dartNIMMessageCallDuration({
  String? accountId,
  int? duration,
})

NIMMessageLocationAttachment

地理位置附件对象，继承自 NIMMessageAttachment。

dartNIMMessageLocationAttachment({
double? longitude,
double? latitude,
String? address,
})

NIMMessageNotificationAttachment

通知附件对象，继承自 NIMMessageAttachment。

dartNIMMessageNotificationAttachment({
NIMMessageNotificationType? type,
String? serverExtension,
List<String?>? targetIds,
bool? chatBanned,
NIMUpdatedTeamInfo? updatedTeamInfo,
})

NIMSendMessageResult

消息发送成功结果回包。

dartNIMSendMessageResult({
NIMMessage? message,
String? antispamResult,
NIMClientAntispamResult? clientAntispamResult,
})

NIMMessageListOption

消息分页查询选项。

dartNIMMessageListOption({
String? conversationId,
List<int>? messageTypes,
int? beginTime,
int? endTime,
int? limit,
NIMMessage? anchorMessage,
NIMQueryDirection? direction,
bool? strictMode,
bool onlyQueryLocal = false,
})

NIMMessageListResult

查询消息列表结果。

dartNIMMessageListResult({
List<NIMMessage>? messages,
NIMMessage? anchorMessage,
})

NIMThreadMessageListOption

Thread 消息分页查询选项。

dartNIMThreadMessageListOption({
NIMMessageRefer? messageRefer,
int? beginTime,
int? endTime,
String? excludeMessageServerId,
int? limit,
NIMQueryDirection? direction,
})

NIMThreadMessageListResult

Thread 消息查询结果。

dartNIMThreadMessageListResult({
NIMMessage? message,
int? timestamp,
int? replyCount,
List<NIMMessage?>? replyList,
})

NIMP2PMessageReadReceipt

单聊消息已读回执对象。

dartNIMP2PMessageReadReceipt({
String? conversationId,
int? timestamp,
})

NIMTeamMessageReadReceipt

群组消息已读回执对象。

dartNIMTeamMessageReadReceipt({
String? conversationId,
String? messageServerId,
String? messageClientId,
int? readCount,
int? unreadCount,
String? latestReadAccount,
})

NIMTeamMessageReadReceiptDetail

群组消息已读回执详情。

dartNIMTeamMessageReadReceiptDetail({
NIMTeamMessageReadReceipt? readReceipt,
List<String?>? readAccountList,
List<String?>? unreadAccountList,
})

NIMMessageRevokeParams

消息撤回配置参数。

dartNIMMessageRevokeParams({
String? postscript,
String? serverExtension,
String? pushContent,
String? pushPayload,
String? env,
})

NIMMessageRevokeNotification

消息撤回通知。

dartNIMMessageRevokeNotification({
NIMMessageRefer? messageRefer,
String? serverExtension,
String? revokeAccountId,
String? postscript,
NIMMessageRevokeType? revokeType,
String? callbackExtension,
})

NIMMessageDeletedNotification

消息删除通知。

dartNIMMessageDeletedNotification({
NIMMessageRefer? messageRefer,
int? deleteTime,
String? serverExtension,
})

NIMMessageQuickCommentNotification

消息快捷评论操作通知。

dartNIMMessageQuickCommentNotification({
NIMMessageQuickCommentType? operationType,
NIMMessageQuickComment? quickComment,
})

NIMMessagePinNotification

Pin 消息通知。

dartNIMMessagePinNotification({
NIMMessagePin? pin,
NIMMessagePinState? pinState,
})

NIMClearHistoryMessageOption

历史消息清空选项。

dartNIMClearHistoryMessageOption({
String? conversationId,
bool? deleteRoam,
bool? onlineSync,
String? serverExtension,
})

NIMClearHistoryNotification

会话历史消息清空通知。

dartNIMClearHistoryNotification({
String? conversationId,
double? deleteTime,
String? serverExtension,
})

NIMSendMessageProgress

消息发送进度。

dartNIMSendMessageProgress({
String? messageClientId,
int? progress,
})

NIMMessageSearchParams

历史消息全文检索查询参数。

dartNIMMessageSearchParams({
String? keyword,
int? beginTime,
int? endTime,
int? conversationLimit,
int? messageLimit,
NIMSortOrder? sortOrder,
List<String?>? p2pAccountIds,
List<String?>? teamIds,
List<String?>? senderAccountIds,
List<int>? messageTypes,
List? messageSubtypes,
})

NIMMessageSearchExParams

历史消息全文检索查询参数。

dartNIMMessageSearchExParams({
String? pageToken,
String? conversationId,
List<String>? keywordList,
NIMSearchKeywordMatchType? keywordMatchType,
List<String>? senderAccountIds,
List<NIMMessageType>? messageTypes,
List<int>? messageSubtypes,
int? searchStartTime,
int? searchTimePeriod,
int? limit,
NIMSearchDirection? direction,
NIMSearchStrategy? strategy,
})

NIMMessageSearchResult

历史消息全文检索查询结果。

dartNIMMessageSearchResult({
int? count,
List<NIMMessageSearchItem>? items,
String? nextPageToken,
bool hasMore = false,
})

NIMMessageSearchItem

消息检索单条会话的返回结果。

dartNIMMessageSearchItem({
required String conversationId,
List<NIMMessage>? messages,
required int count,
})

NIMClientAntispamResult

文本消息客户端本地反垃圾结果。

dartNIMClientAntispamResult({
NIMClientAntispamOperateType? operateType,
String? replacedText,
})

NIMVoiceToTextParams

语音转文字配置参数。

dartNIMVoiceToTextParams({
String? voicePath,
String? voiceUrl,
String? mimeType,
String? sampleRate,
int? duration,
String? sceneName,
})

NIMStorageScene

网易对象存储 NOS 文件存储场景信息。

dartNIMStorageScene({
String? sceneName,
int? expireTime,
})

NIMCustomNotification

自定义通知。

dartNIMCustomNotification({
String? senderId,
String? receiverId,
NIMConversationType? conversationType,
required int timestamp,
String? content,
NIMNotificationConfig? notificationConfig,
NIMNotificationPushConfig? pushConfig,
NIMNotificationAntispamConfig? antispamConfig,
NIMNotificationRouteConfig? routeConfig,
})

NIMNotificationConfig

系统通知相关配置。

dartNIMNotificationConfig({
bool? offlineEnabled,
bool? unreadEnabled,
})

NIMNotificationPushConfig

系统通知第三方推送相关配置。

dartNIMNotificationPushConfig({
bool? pushEnabled,
bool? pushNickEnabled,
String? pushContent,
String? pushPayload,
bool? forcePush,
String? forcePushContent,
List<String>? forcePushAccountIds,
})

NIMNotificationRouteConfig

系统通知事件抄送相关配置。

dartNIMNotificationRouteConfig({
bool? routeEnabled,
String? routeEnvironment,
})

NIMNotificationAntispamConfig

系统通知反垃圾配置，包括本地反垃圾和安全通的相关配置。

dartNIMNotificationAntispamConfig({
bool? antispamEnabled,
String? antispamCustomNotification,
})

NIMSendCustomNotificationParams

自定义通知发送参数。

dartNIMSendCustomNotificationParams({
NIMNotificationConfig? notificationConfig,
NIMNotificationPushConfig? pushConfig,
NIMNotificationAntispamConfig? antispamConfig,
NIMNotificationRouteConfig? routeConfig,
})

NIMBroadcastNotification

广播通知。

dartNIMBroadcastNotification({
required int id,
String? senderId,
required int timestamp,
String? content,
})

NIMTeam

群组对象。

dartNIMTeam({
required String teamId,
required NIMTeamType teamType,
required String name,
required String ownerAccountId,
required int memberLimit,
required int memberCount,
required int createTime,
required int updateTime,
String? intro,
String? announcement,
String? avatar,
String? serverExtension,
String? customerExtension,
required NIMTeamJoinMode joinMode,
required NIMTeamAgreeMode agreeMode,
required NIMTeamInviteMode inviteMode,
required NIMTeamUpdateInfoMode updateInfoMode,
required NIMTeamUpdateExtensionMode updateExtensionMode,
required NIMTeamChatBannedMode chatBannedMode,
required bool isValidTeam,
})

NIMTeamMember

群成员对象。

dartNIMTeamMember({
required String teamId,
required NIMTeamType teamType,
required String accountId,
required NIMTeamMemberRole memberRole,
String? teamNick,
String? serverExtension,
required int joinTime,
int? updateTime,
required bool inTeam,
bool? chatBanned,
})

NIMCreateTeamParams

群组创建配置参数。

dartNIMCreateTeamParams({
required String name,
required NIMTeamType teamType,
int? memberLimit,
String? intro,
String? announcement,
String? avatar,
String? serverExtension,
NIMTeamJoinMode? joinMode,
NIMTeamAgreeMode? agreeMode,
NIMTeamInviteMode? inviteMode,
NIMTeamUpdateInfoMode? updateInfoMode,
NIMTeamUpdateExtensionMode? updateExtensionMode,
NIMTeamChatBannedMode? chatBannedMode,
})

NIMTeamMemberQueryOption

群成员分页查询选项。

dartNIMTeamMemberQueryOption({
required NIMTeamMemberRoleQueryType roleQueryType,
bool? onlyChatBanned,
NIMQueryDirection? direction,
String? nextToken,
int? limit,
})

NIMUpdateTeamInfoParams

群组信息更新参数。

dartNIMUpdateTeamInfoParams({
String? name,
int? memberLimit,
String? intro,
String? announcement,
String? avatar,
String? serverExtension,
NIMTeamJoinMode? joinMode,
NIMTeamAgreeMode? agreeMode,
NIMTeamInviteMode? inviteMode,
NIMTeamUpdateInfoMode? updateInfoMode,
NIMTeamUpdateExtensionMode? updateExtensionMode,
})

NIMCreateTeamResult

创建群组返回结果。

dartNIMCreateTeamResult({
NIMTeam? team,
List<String>? failedList,
})

NIMTeamInviteParams

邀请成员入群的配置参数。

dartNIMTeamInviteParams({
required List<String> inviteeAccountIds,
String? postscript,
String? serverExtension,
})

NIMUpdateSelfMemberInfoParams

修改本人群成员信息参数。

dartNIMUpdateSelfMemberInfoParams({
String? teamNick,
String? serverExtension,
})

NIMTeamMemberListResult

分页获取群成员列表返回结果。

dartNIMTeamMemberListResult({
required bool finished,
String? nextToken,
List<NIMTeamMember>? memberList,
})

NIMTeamJoinActionInfo

入群操作信息。

dartNIMTeamJoinActionInfo({
required NIMTeamJoinActionType actionType,
required String teamId,
required NIMTeamType teamType,
String? operatorAccountId,
String? postscript,
int? timestamp,
required NIMTeamJoinActionStatus actionStatus,
String? serverExtension,
})

NIMTeamJoinActionInfoQueryOption

入群操作信息分页查询选项。

dartNIMTeamJoinActionInfoQueryOption({
List<int>? types,
int? offset,
int? limit = 50,
List<int>? status,
})

NIMTeamJoinActionInfoResult

入群操作信息分页查询结果。

dartNIMTeamJoinActionInfoResult({
List<NIMTeamJoinActionInfo>? infos,
required int offset,
required bool finished,
})

NIMTeamMemberSearchOption

根据关键字搜索群成员信息的配置参数。

dartNIMTeamMemberSearchOption({
required String keyword,
required NIMTeamType teamType,
String? teamId,
required String nextToken,
NIMSortOrder? order,
int? limit,
})

NIMTeamMemberSearchResult

根据关键字搜索群成员信息的搜索结果。

dartNIMTeamMemberSearchResult({
List<NIMTeamMember>? teamMemberList,
required String pageToken,
required bool finished,
})

NIMDndConfig

推送全局免打扰配置信息。

dartNIMDndConfig({
bool? showDetail,
bool? dndOn,
int? fromH,
int? fromM,
int? toH,
int? toM,
})

NIMUserInfo

用户资料对象。

dartNIMUserInfo({
String? accountId,
String? name,
String? avatar,
String? sign,
int? gender,
String? email,
String? birthday,
String? mobile,
String? serverExtension,
int? createTime,
int? updateTime,
})

NIMAIUser

数字人配置的 LLM（Large Language Models）模型类型及相关配置。

dartNIMAIUser({
NIMAIModelType? modelType,
NIMAIModelConfig? modelConfig,
String? accountId,
String? name,
String? avatar,
String? sign,
int? gender,
String? email,
String? birthday,
String? mobile,
String? serverExtension,
int? createTime,
int? updateTime,
})

JSON{
    "apiKey": "Bearer d1**2a", //必填
    "model": "qwen-turbo", //必填
    "workspace": "ws_QTggmeAxxxxx", //可选
    "prompt": "xxx",//必填
    "max_tokens": 2000，//可选
    "top_p": 0.85，//可选
    "repetition_penalty": 1.1,//可选
    ///....
}

JSON{
    "apiKey": "xxxx",//必填
    "apiVersion": "2023-06-01-preview",//必填
    "deploymentId": "gpt_35_turbo",//必填
    "resourceName": "yunxintest",//必填
    "prompt": "xxx",//必填
    "max_tokens": 16,//可选
    "temperature": 1,//可选
    "top_p": 1,//可选
    "logit_bias": {},//可选
    "user": "xx",//可选
    "presence_penalty": 0,//可选
    "frequency_penalty": 0,//可选
    "best_of": 1,//可选
    ///....
}

JSON{
    "model": "xxxx",//必填
    "url": "xxx",//必填
    "prompt": "xxx",//必填
    "mirostat": 1,//可选
    "mirostat_eta": 1，//可选
    "temperature": 0.8，//可选
    "top_p": 1,//可选
    ///....
}

NIMAIModelConfig

数字人配置的 LLM（Large Language Models）模型的配置。

dartNIMAIModelConfig({
String? model,
String? prompt,
List? promptKeys,
int? maxTokens,
double? topP,
double? temperature,
})

NIMProxyAIModelCallParams

数字人发起 LLM（Large Language Models）模型请求的配置参数。

dartNIMProxyAIModelCallParams({
String? accountId,
String? requestId,
NIMAIModelCallContent? content,
List<NIMAIModelCallMessage?>? messages,
String? promptVariables,
NIMAIModelConfigParams? modelConfigParams,
NIMProxyAICallAntispamConfig? antispamConfig,
bool aiStream = false,
})

NIMProxyAICallAntispamConfig

数字人收发消息，是否需要经过安全通校验，即透传反垃圾内容配置。

dartNIMProxyAICallAntispamConfig({
bool? antispamEnabled,
String? antispamBusinessId,
})

NIMAIModelCallContent

数字人请求大模型或者大模型响应的消息内容。

dartNIMAIModelCallContent({
String? msg,
required int type,
})

NIMAIModelCallMessage

数字人请求大模型或者大模型响应的消息的上下文内容。

dartNIMAIModelCallMessage({
NIMAIModelRoleType? role,
String? msg,
required int type,
})

NIMAIModelConfigParams

数字人请求的 LLM 大模型配置覆盖设置。配置了该字段后，默认覆盖您在网易云信控制台上的相关配置。

• 如果所有字段均为空，则以您在网易云信控制台上的配置为准，本地不做格式校验。
• 如果设置参数超过范围，则会主动纠正到正确范围。

dartNIMAIModelConfigParams({
String? prompt,
int? maxTokens,
double? topP,
double? temperature,
})

以下参数取值的详细说明，可参考 NIMAIModelConfig。

NIMMessageAIConfigParams

消息体中数字人配置的 LLM 大模型相关配置字段。

dartNIMMessageAIConfigParams({
String? accountId,
NIMAIModelCallContent? content,
List<NIMAIModelCallMessage?>? messages,
String? promptVariables,
NIMAIModelConfigParams? modelConfigParams,
bool aiStream = false,
})

以下参数取值的详细说明，可参考 NIMAIModelConfig。

NIMAIModelCallResult

透传接口下数字人回复消息的的结构体。

dartNIMAIModelCallResult({
String? accountId,
String? requestId,
NIMAIModelCallContent? content,
int? code,
List<NIMAIRAGInfo>? aiRAGs,
int timestamp = 0,
bool aiStream = false,
V2NIMAIModelStreamCallStatus? aiStreamStatus,
})

NIMMessageAIConfig

消息体中数字人消息收发相关配置字段。

dartNIMMessageAIConfig({
String? accountId,
NIMMessageAIStatus? aiStatus,
List<NIMAIRAGInfo>? aiRAGs,
bool aiStream = false,
V2NIMMessageAIStreamStatus? aiStreamStatus,
NIMMessageAIStreamChunk? aiStreamLastChunk,
})

NIMAIRAGInfo

数字人回复内容的引用资源。

dartNIMAIRAGInfo({
String url = '',
String name = '',
int time = 0,
String description = '',
String icon = '',
String title = '',
})

NIMMessageAIStreamChunk

数字人流式消息最近一个分片。

dartNIMMessageAIStreamChunk({
String? content,
int? messageTime,
int? chunkTime,
int type = 0,
int? index,
})

NIMMessageAIStreamStopParams

停止数字人流式输出配置参数。

dartNIMMessageAIStreamStopParams({
required V2NIMMessageAIStreamStopOpType operationType,
String? updateContent,
})

NIMMessageAIRegenParams

重新输出数字人消息配置参数。

dartNIMMessageAIRegenParams({
required V2NIMMessageAIRegenOpType operationType,
})

NIMAIModelStreamCallChunk

透传接口的 AI 流式消息分片信息。

dartNIMAIModelStreamCallChunk({
String? content,
int? chunkTime,
int type = 0,
int index = 0,
})

NIMAIModelStreamCallContent

透传接口的 AI 流式消息回复内容。

dartNIMAIModelStreamCallContent({
String? msg,
int type = 0,
NIMAIModelStreamCallChunk? lastChunk,
})

NIMAIModelStreamCallResult

透传接口的 AI 流式回复的结构体。

dartNIMAIModelStreamCallResult({
int code = 200,
required String accountId,
required String requestId,
NIMAIModelStreamCallContent? content,
List<NIMAIRAGInfo>? aiRAGs,
int? timestamp,
})

NIMAIModelStreamCallStopParams

停止透传接口的 AI 流式回复。

dartNIMAIModelStreamCallStopParams({
required String accountId,
required String requestId,
})

NIMUserUpdateParam

用户资料更新参数。

dartNIMUserUpdateParam({
String? name,
String? avatar,
String? sign,
int? gender,
String? email,
String? birthday,
String? mobile,
String? serverExtension,
})

NIMUserSearchOption

根据关键字搜索用户信息的配置参数。

dartNIMUserSearchOption({
required String keyword,
bool? searchName,
bool? searchAccountId,
bool? searchMobile,
})

NIMFriend

好友信息对象。

dartNIMFriend({
required String accountId,
String? alias,
String? serverExtension,
String? customerExtension,
required int createTime,
int? updateTime,
NIMUserInfo? userProfile,
})

NIMFriendAddParams

添加好友的配置参数。

dartNIMFriendAddParams({
required NIMFriendAddMode addMode,
String? postscript,
})

NIMFriendAddApplication

申请添加好友相关操作信息。

dartNIMFriendAddApplication({
String? applicantAccountId,
String? recipientAccountId,
String? operatorAccountId,
String? postscript,
NIMFriendAddApplicationStatus? status,
int? timestamp,
bool? read,
})

NIMFriendDeleteParams

删除好友的配置参数。

dartNIMFriendDeleteParams({
bool? deleteAlias,
})

NIMFriendSetParams

设置好友信息的配置参数。

可以设置别名和扩展字段，两字段都可选，但是不能都不传，都不传回返回参数错误。

dartNIMFriendSetParams({
String? alias,
String? serverExtension,
})

NIMFriendAddApplicationQueryOption

申请添加好友相关操作信息的查询参数。

dartNIMFriendAddApplicationQueryOption({
required int? offset,
required int? limit,
List<NIMFriendAddApplicationStatus>? status,
})

NIMFriendAddApplicationResult

查询申请添加好友相关操作信息列表的返回结果。

dartNIMFriendAddApplicationResult({
List<NIMFriendAddApplication>? infos,
required int offset,
bool? finished,
})

NIMFriendSearchOption

根据关键字搜索好友信息的配置参数。

dartNIMFriendSearchOption({
required String keyword,
bool searchAlias = true,
bool searchAccountId = true,
})

V2NIMUserInfoConfig

消息发送方的用户信息配置。

dartV2NIMUserInfoConfig({
String? senderAvatar,
String? senderExtension,
String? senderNick,
int? userInfoTimestamp,
})

NIMUploadFileTask

文件上传任务。

dartNIMUploadFileTask({
String? taskId,
NIMUploadFileParams? uploadParams,
})

NIMUploadFileParams

文件上传任务。

dartNIMUploadFileParams({
String? filePath,
String? sceneName,
})

NIMAntispamConfig

dartNIMAntispamConfig({
String? antispamBusinessId,
})

NIMSDKOption（仅 iOS）

初始化配置选项。

Objective-C@interface NIMSDKOption : NSObject
@property (nonatomic,copy)          NSString    *appKey;
@property (nullable,nonatomic,copy) NSString    *apnsCername;
@property (nullable,nonatomic,copy) NSString    *pkCername;
+ (instancetype)optionWithAppKey:(NSString *)appKey;
@end

类方法

注册网易云信应用 AppKey。

Objective-C+ (instancetype)optionWithAppKey:(NSString *)appKey;

NIMPCSDKOptions(仅 macOS/Windows)

10.x.x 版本 SDK 的 macOS/Windows 平台初始化配置选项。

dartNIMPCSDKOptions({
required NIMBasicOption basicOption,
NIMLinkOption? linkOption,
NIMDatabaseOption? databaseOption,
NIMFCSOption? fcsOption,
NIMPrivateServerOption? privateServerOption,
required String appKey,
String? sdkRootDir,
})

NIMUpdatedTeamInfo

群信息更新。

dartNIMUpdatedTeamInfo({
String? name,
int? memberLimit,
String? intro,
String? announcement,
String? avatar,
String? serverExtension,
NIMTeamJoinMode? joinMode,
NIMTeamAgreeMode? agreeMode,
NIMTeamInviteMode? inviteMode,
NIMTeamUpdateInfoMode? updateInfoMode,
NIMTeamUpdateExtensionMode? updateExtensionMode,
int? chatBannedMode,
})

NIMDownloadFileProgress

文件下载进度。

dartNIMDownloadFileProgress({
  String? url,
  int? progress,
});