无影云手机 Web SDK 被集成文档_无影云手机(Cloud Phone)-阿里云帮助中心

无影Web SDK是用于连接云电脑、云应用、云手机的无影Web Client开放接口。通过集成Web Client SDK，您可以根据业务需求快速定制和搭建Web客户端。

1. 背景信息

1.1 获取SDK及Demo

下载Web Client SDK
下载Web.SDK.Demo

说明

本平台所有文档、SDK、客户端程序仅限于本人或本企业使用，未经阿里云同意不会转发给第三方个人或企业。

1.2 目录结构说明

├── WuyingWebDemo.html  //SDK示例。
├── WuyingWebSDK.js     //SDK的接口文件，需要在前端页面中引用该文件。
├── HDXEngine.html      //云电脑相关文件，若不需要使用，可以移除。
├── HDXLauncher.js      //云电脑相关文件，若不需要使用，可以移除。
└── sdk                 //iframe内嵌资源文件
     └── ASP
          └── container.html

2. 接口说明

2.1 类

2.1.1 WebSDK

2.1.1.1 Members

Name	Type	Description

Name	Type	Description
apiVersion	string	WebSDK的版本号

2.1.1.2 Methods

createSession(sessionId:string, sessionParams: SessionParam)

创建一个云手机的会话，这里的会话与管控的会话是不同的概念。

名称	类型	描述

名称	类型	描述
id	string	创建者自定义的会话唯一标识
sessionParams	SessionParam	创建会话参数

var userInfo = {
  authCode: authCode,
};

var appInfo = {
  appId: "android", 
  resourceGroupId: gid, 
  resourceld: pid, 
  appInstanceGroupId: gid, 
  productType: "AndroidCloud",
  connectionProperties: JSON.stringify({ authMode: "Session" }) ,
};
var sessionParam = {
  openType: openType,
  iframeId: 'sessionIframe',
  resourceType: "local",
  connectType: 'app',
  userInfo: userInfo,
  appInfo: appInfo,
};

var wuyingSdk = Wuying.WebSDK;
var session = wuyingSdk.createSession('appstream', sessionParam);

创建会话参数说明：

userInfo：用户鉴权相关参数。authCode的获取方法，请参考无影云手机快速集成最佳实践。
appInfo：实例相关信息。
- resourceGroupId: gid填DescribeAndroidInstances - 查询实例详细信息中返回的AppInstanceGroupId。
- resourceld: pid填DescribeAndroidInstances - 查询实例详细信息中返回的PersistentAppInstanceId。
- appInstanceGroupId：同resourceGroupId。
openType: 参考文中枚举类型中的说明。

2.1.2 Session

2.1.2.1 start() 开始建立连接

var session = wuyingSdk.createSession('appstream', sessionParam);
session.start();

2.1.2.2 stop() 断开连接

var session = wuyingSdk.createSession('appstream', sessionParam);
session.start();
...
session.stop();

2.1.2.3 addHandle(name: SessionEventType, callback: Function) 增加监听事件

名称	类型	描述

名称	类型	描述
name	string	监听事件的类型，参考SessionEventType枚举定义
callback	Function	回调函数

session.addHandle('getConnectionTicketInfo', (data) => {
  console.log(data);
});

session.addHandle('onConnected', (data) => {
  console.log('connected', data);
});

session.addHandle('onDisConnected', (data) => {
  console.log('disconnect', data);
});

session.addHandle('onRuntimeMsg', (data) => {
  document.getElementById('GuestMsgContext').value = JSON.stringify(data);
});

session.start();

2.1.2.4 enableInput(param: boolean) 打开和关闭输入操作

名称	类型	描述

名称	类型	描述
param	bool	是否打开

2.1.2.5 setInputEnabled(param: boolean) 打开和关闭输入操作

名称	类型	描述

名称	类型	描述
param	bool	是否打开

说明：

关闭输入操作以后，对于本地键盘、鼠标、触摸板的输入事件，云手机都不会响应。
enableInput和setInputEnabled功能相同，推荐使用setInputEnabled。

2.1.2.6 enableKeyBoard(param: boolean) 唤起移动端的键盘

名称	类型	描述

名称	类型	描述
param	bool	是否打开

2.1.2.7 setClipboardEnabled(param: boolean) 剪贴板控制

名称	类型	描述

名称	类型	描述
param	bool	是否打开

2.1.2.8 setMicrophoneEnabled(param: boolean) 麦克风控制

名称	类型	描述

名称	类型	描述
param	bool	是否打开

2.1.2.9 setInputEnabled(param: boolean) 键盘鼠标输入控制

名称	类型	描述

名称	类型	描述
param	bool	是否打开

2.1.2.10 setTouchEnabled(param: boolean) 触摸控制

名称	类型	描述

名称	类型	描述
param	bool	是否打开

2.1.2.11 setUiParams(param: UiConfig) session建立后主动设置UI配置（如菜单是否显示/是否强制横屏）

名称	类型	描述

名称	类型	描述
param	UiConfig	UI选项

var uiConfig = {
  toolbar: {
    visible: false,
  },
  rotateDegree: 90,
};
session.setUiParams(uiConfig);

说明

关于UIConfig的详细信息，请参见2.2.4 UiConfig。

2.2 参数

2.2.1 SessionParam

创建会话的参数。

名称	类型	必填	描述

名称	类型	必填	描述
openType	OpenType	是	iframe内嵌还是新标签页打开
iframeId	string	否	如果iframe打开，则需要填入iframeId
sdkPath	string	否	配置SDK文件所在路径，不填则默认为相对路径，例如`./ASP/container.html`
resourceType	ResourceType	是	目前只支持打开本地连接页面
connectType	ConnectType	是	打开云手机还是云电脑
isOverseas	boolean	否	是否海外访问，默认false
userInfo	UserInfo	是	用户的登录态信息
regionId	string	是	打开云手机时必填为云手机所在的地域
appInfo	AppInfo	否	云手机相关信息
fileInfo	FileInfo	否	网盘相关参数
uiConfig	UiConfig	否	UI设置项
fileTransferConfig	FileTransferConfig	否	文件传输配置
logDisabled	bool	否	是否关闭ARMS统计，默认为false不关闭
loginType	LoginType	否	默认无影账号登录
networkAccessType	string	否	默认不填，支持VPC登录

2.2.2 UserInfo

用户的登录态信息，若连接无影云手机，推荐使用authCode。

名称	类型	必填	描述

名称	类型	必填	描述
authCode	string	是	只能用一次的登录态凭证，优先级最高
ticket	string	是	1.4.7版本之后支持直接传入Ticket建立连接
loginToken	string	是	用户登录态信息（已弃用）
sessionId	string	是	用户登录态信息（已弃用）

2.2.3 AppInfo

打开云手机的参数。

名称	类型	必填	描述

名称	类型	必填	描述
appId	string	是	填入 PersistentAppInstanceId （示例值：p-0caoet4e18cui****）
appVersion	string	否	打开应用的版本
loginRegionId	string	是	云应用资源所在的地域
connConfig	ConnConfig	否	连接配置参数
appInstanceGroupId	string	否	交付组ID
appInstanceId	string	否	实例ID，若使用ticket连接为必填（示例值：ai-0cc7s3n1iagyq****）
taskId	string	否	应用启动任务ID
bizRegionId	string	否	应用资源所在的地域
productType	string	否	交付组类型，云手机填默认`AndroidCloud`

2.2.4 UiConfig

连接页面UI设置。

名称	类型	必填	描述

名称	类型	必填	描述
toolbar	ToolBarConfig	否	连接页面工具栏显示设置
exitCheck	bool	否	退出当前页面浏览器二次确认，默认开启
rotateDegree	number	否	强制横屏（目前只支持0：正常 90：强制横屏）
vconsoleVisiable	bool	否	是否显示vconsole调试框
debugPanelVisiable	bool	否	是否显示码流、帧率等信息框
reconnectType	ReconnectType	否	重连提示框样式
defaultResolution	ResolutionType	否	首次连接的默认分辨率，默认为'A'
language	Language	否	设置内部弹窗提示的语言，默认为中文

2.2.5 ToolBarConfig

工具栏显示设置。

名称	类型	必填	描述

名称	类型	必填	描述
visible	bool	否	工具栏是否显示
noMenu	bool	否	悬浮球式否支持打开右键菜单，默认false，1.4.20以上支持

2.2.6 ConnConfig

连接配置参数。

名称	类型	必填	描述

名称	类型	必填	描述
decodeType	ConnDecodeType（数字枚举）	否	编码方式配置
playSoundBackground	bool	否	切换后台后是否继续播放声音

2.3 枚举类型

2.3.1 OpenType

打开云手机的方式。

名称	含义

名称	含义
newTab	新的tab页面打开
inline	内嵌Iframe页面打开
urlScheme	支持本地原生客户端打开，需安装6.2以上版本无影桌面端

2.3.2 ConnectType

打开云电脑或者云手机。

名称	含义

名称	含义
app	打开云应用（打开云手机）
desktop	打开云电脑

目前云手机复用app类型，连接云手机时，connectType固定填app。

2.3.3 ResourceType

打开本地连接页面还是无影WebClient。

名称	含义

名称	含义
local	打开本地连接HTML页面

无影云手机集成固定填local。

2.3.4 ReconnectType

重连提示弹窗的UI。

名称	含义

名称	含义
simple	简单的loading
normal	倒计时弹窗

2.3.5 ResolutionType

初始化连接默认分辨率（连接时优先取用户设置过的分辨率）。

名称	含义

名称	含义
A	速度优先，当前窗口大小
B	质量优先，当前窗口大小乘以window.devicePixelRatio

2.3.6 ChargeType

云手机付费类型。

名称	含义	开始支持版本

名称	含义	开始支持版本
PostPaid	按量付费	1.4.0
PrePaid	包年包月付费	1.4.0

2.3.7 Language

语言设置选项，默认为zh-CN。

名称	含义

名称	含义
zh-CN	中文
en-US	英文
ja-JP	日文

2.3.8 LoginType

登录云手机方式。

名称	含义

名称	含义
aliyunLogin	阿里云账号登录
normalLogin	无影账号登录（云手机只支持`normalLogin`）。

2.3.9 SessionEventType 事件说明

会话的事件类型映射（加云手机事件说明）

名称	含义	开始支持版本

名称	含义	开始支持版本
getConnectionTicketInfo	连接云手机事件	1.0.0
onConnected	云手机建立连接事件	1.0.0
onDisConnected	云手机断开连接事件	1.0.0
onRuntimeMsg	Runtime内发送给SDK的消息	1.1.0
networkData	网络性能参数	1.3.1
onError	接受连接过程中的错误	1.4.1

2.3.10 ConnDecodeType 流的解码类型

名称	含义	开始支持版本

名称	含义	开始支持版本
0	软解	1.2.0
1	硬解	1.2.0
2	webrtc	1.2.0

2.3.11 ProtocolType 协议类型

名称	含义	开始支持版本

名称	含义	开始支持版本
ASP	ASP协议（云手机只支持ASP协议）	1.3.0
HDX	Citrix协议	1.3.0

3. 错误代码

3.1 onDisconnected接收断连的报错信息

名称	含义	代码

名称	含义	代码
ASP_CLIENT_DISCONNECT_CONNECT_ERROR	断开连接	0
ASP_CLIENT_DISCONNECT_SOCKET_CLOSE	socket关闭	1
ASP_CLIENT_DISCONNECT_WEBRTC_CLOSE	webrtc关闭	2
ASP_CLIENT_DISCONNECT_CLOUD_APP_STOP	云应用关闭	2001
ASP_CLIENT_DISCONNECT_CLIENT_PREEMPTION	被抢占	2002
ASP_CLIENT_DISCONNECT_GUEST_SHUTDOWN_REBOOT	Guest重启	2003
ASP_CLIENT_RTT_TIMEOUT	RTT超时	2200
ASP_CLIENT_NET_ERROR_IO	网络IO错误	2201
ASP_CLIENT_UPDATE_TICKET_FAILED	更新ticket错误	2202

3.2 onError接收连接过程的错误信息

接收格式：{code: string, message: string, api: string}，message包含requestId，api为报错的请求。

错误码	错误说明

错误码	错误说明
AccountNotAvailable	域账号被锁定、禁用或已过期，请联系IT管理员或系统域控管理员解决。
ApplicationCenterDownloading	请前往无影应用中心下载“无影晓颖AI助手”客户端。
ApplicationDownloading	正在下载应用，请稍候...
ClientLockedForAliasFailed	输入错误次数达到上限，请5分钟后再试。
content-monthpackageenterpostpaidphase	此台云电脑在本月度周期内的时长包已使用完毕，开机或唤醒后将按需计费。
content-recordingscreen	您的云电脑已被企业IT管理员启用了录屏审计功能，您在云电脑内的所有操作将会被录制，如对录屏审计功能有任何疑问请您联系您的管理员。
desktop-AgentUnbinding	由于您之前连接的临时云电脑尚在解绑中导致新的临时云电脑连接失败。请稍候再次连接。
desktop-AssignUserFailed	云电脑分配失败，请稍候重试。
desktop-ConnectTicket.Timeout	由于连接超时导致云电脑连接失败。请重启云电脑后再重新连接。
desktop-DesktopAgentFileLose	云电脑的核心进程文件已丢失，导致连接失败。请重启云电脑后再次连接。如仍旧出现连接失败，请联系IT管理员。
desktop-DesktopContainSecuritySoftware	此台云电脑安装了安全软件导致云电脑的网络出现异常，云环境和管控的连接已中断。请联系您的IT管理员退出安全软件后再次连接。
desktop-DesktopContainVpn	此台云电脑安装了VPN软件导致云电脑的网络出现异常，云环境和管控的连接已中断。您可通过重启云电脑修复此问题。如仍旧出现连接失败，请联系IT管理员。
desktop-DesktopCpuHighLoad	此台云电脑的CPU负载过高，导致连接超时。请重新连接或重启云电脑。如仍旧出现连接失败，请联系IT管理员。
desktop-DesktopCpuHighLoad.2901	此台云电脑的CPU负载过高，导致连接超时。请重新连接或重启云电脑。如仍旧出现连接失败，请联系IT管理员。
desktop-DesktopCpuHighLoad.2902	此台云电脑的CPU负载过高，导致连接超时。请重新连接或重启云电脑。如仍旧出现连接失败，请联系IT管理员。
desktop-DesktopCpuHighLoad.2903	此台云电脑的CPU负载过高，导致连接超时。请重新连接或重启云电脑。如仍旧出现连接失败，请联系IT管理员。
desktop-DesktopCpuHighLoad.2904	此台云电脑的CPU负载过高，导致连接超时。请重新连接或重启云电脑。如仍旧出现连接失败，请联系IT管理员。
desktop-DesktopCpuHighLoad.2905	此台云电脑的CPU负载过高，导致连接超时。请重新连接或重启云电脑。如仍旧出现连接失败，请联系IT管理员。
desktop-DesktopCpuHighLoad.2906	此台云电脑的CPU负载过高，导致连接超时。请重新连接或重启云电脑。如仍旧出现连接失败，请联系IT管理员。
desktop-DesktopCpuHighLoad.2907	此台云电脑的CPU负载过高，导致连接超时。请重新连接或重启云电脑。如仍旧出现连接失败，请联系IT管理员。
desktop-DesktopCpuHighLoad.2908	此台云电脑的CPU负载过高，导致连接超时。请重新连接或重启云电脑。如仍旧出现连接失败，请联系IT管理员。
desktop-DesktopCpuHighLoad.broken	此台云电脑的CPU负载过高，导致连接超时。请重新连接或重启云电脑。如仍旧出现连接失败，请联系IT管理员。
desktop-DesktopCrash	云电脑发生内核转储（Core dump）事件，导致云电脑连接失败。请重启云电脑后再次连接。
desktop-DesktopDiskHighLoad	此台云电脑的系统磁盘使用率过高导致连接超时。请重新连接或重启云电脑。如仍旧出现连接失败，请联系IT管理员。
desktop-DesktopDiskHighLoad.2901	此台云电脑的系统磁盘使用率过高导致连接超时。请重新连接或重启云电脑。如仍旧出现连接失败，请联系IT管理员。
desktop-DesktopDiskHighLoad.2902	此台云电脑的系统磁盘使用率过高导致连接超时。请重新连接或重启云电脑。如仍旧出现连接失败，请联系IT管理员。
desktop-DesktopDiskHighLoad.2903	此台云电脑的系统磁盘使用率过高导致连接超时。请重新连接或重启云电脑。如仍旧出现连接失败，请联系IT管理员。
desktop-DesktopDiskHighLoad.2904	此台云电脑的系统磁盘使用率过高导致连接超时。请重新连接或重启云电脑。如仍旧出现连接失败，请联系IT管理员。
desktop-DesktopDiskHighLoad.2905	此台云电脑的系统磁盘使用率过高导致连接超时。请重新连接或重启云电脑。如仍旧出现连接失败，请联系IT管理员。
desktop-DesktopDiskHighLoad.2906	此台云电脑的系统磁盘使用率过高导致连接超时。请重新连接或重启云电脑。如仍旧出现连接失败，请联系IT管理员。
desktop-DesktopDiskHighLoad.2907	此台云电脑的系统磁盘使用率过高导致连接超时。请重新连接或重启云电脑。如仍旧出现连接失败，请联系IT管理员。
desktop-DesktopDiskHighLoad.2908	此台云电脑的系统磁盘使用率过高导致连接超时。请重新连接或重启云电脑。如仍旧出现连接失败，请联系IT管理员。
desktop-DesktopDiskHighLoad.broken	此台云电脑的系统磁盘使用率过高导致连接超时。请重新连接或重启云电脑。如仍旧出现连接失败，请联系IT管理员。
desktop-DesktopGuestStop	此台云电脑非“运行中”状态导致连接失败。请在客户端内点击“刷新”查看最新状态。
desktop-DesktopMemoryHighLoad	此台云电脑的内存使用率过高导致连接超时。请重新连接或重启云电脑。如仍旧出现连接失败，请联系IT管理员。
desktop-DesktopMemoryHighLoad.2901	此台云电脑的内存使用率过高导致连接超时。请重新连接或重启云电脑。如仍旧出现连接失败，请联系IT管理员。
desktop-DesktopMemoryHighLoad.2902	此台云电脑的内存使用率过高导致连接超时。请重新连接或重启云电脑。如仍旧出现连接失败，请联系IT管理员。
desktop-DesktopMemoryHighLoad.2903	此台云电脑的内存使用率过高导致连接超时。请重新连接或重启云电脑。如仍旧出现连接失败，请联系IT管理员。
desktop-DesktopMemoryHighLoad.2904	此台云电脑的内存使用率过高导致连接超时。请重新连接或重启云电脑。如仍旧出现连接失败，请联系IT管理员。
desktop-DesktopMemoryHighLoad.2905	此台云电脑的内存使用率过高导致连接超时。请重新连接或重启云电脑。如仍旧出现连接失败，请联系IT管理员。
desktop-DesktopMemoryHighLoad.2906	此台云电脑的内存使用率过高导致连接超时。请重新连接或重启云电脑。如仍旧出现连接失败，请联系IT管理员。
desktop-DesktopMemoryHighLoad.2907	此台云电脑的内存使用率过高导致连接超时。请重新连接或重启云电脑。如仍旧出现连接失败，请联系IT管理员。
desktop-DesktopMemoryHighLoad.2908	此台云电脑的内存使用率过高导致连接超时。请重新连接或重启云电脑。如仍旧出现连接失败，请联系IT管理员。
desktop-DesktopMemoryHighLoad.broken	此台云电脑的内存使用率过高导致连接超时。请重新连接或重启云电脑。如仍旧出现连接失败，请联系IT管理员。
desktop-DesktopNetworkAnomaly	此台云电脑的网络出现异常，导致云环境和管控的连接已中断。您可通过重启云电脑修复此问题。如仍旧出现连接失败，请联系IT管理员。
desktop-DesktopNetworkError	此台云电脑的网络出现异常，导致云环境和管控的连接已中断。您可重启云电脑修复此问题。如仍旧出现连接失败，请联系IT管理员。
desktop-DesktopResourceStatusInvalid	云服务器ECS当前非运行状态，导致云电脑连接失败。请重启云电脑后再次连接。
desktop-DesktopResourceStop	云服务器ECS已关机，导致云电脑连接失败。请重启云电脑后再次连接。
desktop-DesktopsUnderMaintenance	此台云电脑非“运行中”状态导致连接失败。在客户端内点击“刷新”后查看到云电脑的最新状态。
desktop-DesktopUnavailable	连接失败，请稍候重试。如仍旧出现连接失败，请联系IT管理员更新此台云电脑的状态。
desktop-DistributeLockFailed	由于当前连接临时云电脑的用户量过多导致连接失败，请稍候再次连接。
desktop-GENERAL_ERROR	出现服务异常，请重新连接云电脑。如仍旧无法连接，请联系IT管理员。
desktop-GET_TICKET_LOCK	云电脑连接请求频繁，请稍候再试。
desktop-INSUFFICIENT_QUOTA	由于IT管理员账号下的云电脑配额不足导致当前无可用的临时云电脑，请联系IT管理员寻求运维帮助。
desktop-INTERNAL_ERROR	出现服务异常，请重新连接云电脑。如仍旧无法连接，请联系IT管理员。
desktop-InvalidBundleId.NotFound	此台云电脑的镜像模板出现异常，请联系IT管理员。
desktop-InvalidClientIp.Policy	IT管理员设置了IP白名单策略导致无法在您目前的IP环境下连接此台云电脑，请联系IT管理员。
desktop-InvalidClientType.AccessDenied	IT管理员设置了禁止在此客户端内运行此台云电脑。如需继续使用此台云电脑，请联系IT管理员。
desktop-InvalidDesktopId.NotFound	IT管理员已取消您使用此台云电脑的权限，请点击客户端的“刷新”按钮获取云电脑最新状态。
desktop-InvalidDesktopId.Status	此台云电脑非“运行中”状态导致连接失败。在客户端内点击“刷新”后查看到云电脑的最新状态。
desktop-InvalidDesktopStatus.InMaintenance	由于IT管理员将此台云电脑设置为维护模式，此状态下不支持使用云电脑。请联系IT管理员。
desktop-InvalidDesktopStatus.NotRunning	服务端异常导致关机失败，请稍后重试或联系您的IT管理员。
desktop-InvalidDesktopStatus.NotStopped	服务端异常导致开机失败，请稍后重试或联系您的IT管理员。
desktop-InvalidDesktopStatusInvalid	此台云电脑当前非运行状态导致连接失败，请点击客户端的“刷新”按钮获取云电脑最新状态。
desktop-InvalidHibernateOperation	休眠状态的云电脑无法进行“恢复至初始镜像”操作，请先唤醒此台云电脑。
desktop-InvalidLiteConnectionCheck	由于协议服务出现异常导致云电脑重连失败，请尝试重新连接。
desktop-NoEnoughDesktops	由于IT管理员的设置导致当前无可分配的临时云电脑，请联系IT管理员。
desktop-NotFindDesktopId	此台云电脑已被IT管理员释放。
desktop-NotFoundUserDesktop	IT管理员已取消您使用此台云电脑的权限。
desktop-PermissionDeny.Desktop	IT管理员已取消您的使用权限。如需继续使用云电脑，请联系IT管理员重新授权。
desktop-RES_GW_ERROR	出现服务异常，请重新连接云电脑。如仍旧无法连接，请联系IT管理员。
desktop-SDK.ReadTimeout	出现服务异常，请重新连接云电脑。如仍旧无法连接，请联系IT管理员。
desktop-ServiceUnavailable	服务连接超时，请重新连接云电脑。如仍旧无法连接，请联系IT管理员。
desktop-THROTTLING_USER	出现服务异常，请重新连接云电脑。如仍旧无法连接，请联系IT管理员。
desktop-UnavailableDesktop	云电脑登录超时，您可通过重连或重启云电脑修复此问题。如仍旧出现连接失败，请联系IT管理员。
desktop-UnavailableDesktop.2901	协议服务与云环境连接失败导致云电脑连接失败。您可通过重启云电脑修复此问题。如仍旧出现连接失败，请联系IT管理员。
desktop-UnavailableDesktop.2902	协议服务无响应，导致云电脑连接失败。您可通过重启云电脑修复此问题。如仍旧出现连接失败，请联系IT管理员。
desktop-UnavailableDesktop.2903	云环境出现异常，导致云电脑连接失败，您可通过重启云电脑修复此问题，如仍旧出现连接失败，请联系IT管理员。
desktop-UnavailableDesktop.2904	云环境出现异常云电脑连接失败。您可通过重启云电脑修复此问题。如仍旧出现连接失败，请联系IT管理员。
desktop-UnavailableDesktop.2905	此台云电脑被分配给了多个用户，为其他用户注销会话时出现超时导致连接失败。请重新连接或重启云电脑。
desktop-UnavailableDesktop.2906	由于登录系统时出现响应超时导致连接失败，请重新连接或重启云电脑。
desktop-UnavailableDesktop.2907	由于协议服务仍在启动中，导致云电脑连接失败。请稍后重新连接或重启云电脑，如仍旧出现连接失败，请联系IT管理员。
desktop-UnavailableDesktop.2908	由于云电脑的系统窗口管理器出现异常导致连接失败，请重启云电脑。
desktop-UnavailableDesktop.ConnectionBroken	由于Agent进程出现异常导致云电脑连接失败。您可尝试通过“恢复快照”修复此问题（路径：云电脑卡片>管理>快照）。此方式将清除您在云电脑内未保存的数据。如问题依旧存在，请联系IT管理员。
desktop-UnavailableDesktop.NotRegistered	IT管理员已删除此台云电脑。请在客户端内点击“刷新”查看最新状态。
desktop-UnavailableDesktop.ServerNotReady	由于登录系统时出现异常导致连接失败，请联系IT管理员重新为您授权云电脑的使用权限。
desktop.linux-UnavailableDesktop.AuthFailed	可能由于脱域问题导致云电脑连接失败。请重启云电脑后再重新连接或联系您的IT管理员。
DesktopNetworkError.AbortBySoftware	此台云电脑的网络出现异常，导致云环境和管控的连接已中断。您可重启云电脑修复此问题。
DesktopNetworkError.BadHandShake	此台云电脑的网络出现异常，导致云环境和管控的连接已中断。您可重启云电脑修复此问题。
DesktopNetworkError.BindAddressFailed	此台云电脑的网络出现异常，导致云环境和管控的连接已中断。您可重启云电脑修复此问题。
DesktopNetworkError.ConnectAddressFailed	此台云电脑的网络出现异常，导致云环境和管控的连接已中断。您可重启云电脑修复此问题。
DesktopNetworkError.ConnectionClosedError	此台云电脑的网络出现异常，导致云环境和管控的连接已中断。您可重启云电脑修复此问题。
DesktopNetworkError.ConnectionRefusedError	此台云电脑的网络出现异常，导致云环境和管控的连接已中断。您可重启云电脑修复此问题。
DesktopNetworkError.ConnectionResetError	此台云电脑的网络出现异常，导致云环境和管控的连接已中断。您可重启云电脑修复此问题。
DesktopNetworkError.ConnectionTimeout	此台云电脑的网络出现异常，导致云环境和管控的连接已中断。您可重启云电脑修复此问题。
DesktopNetworkError.DnsLookupFailed	此台云电脑的网络出现异常，导致云环境和管控的连接已中断。您可重启云电脑修复此问题。
DesktopNetworkError.Forbidden	此台云电脑的网络出现异常，导致云环境和管控的连接已中断。您可重启云电脑修复此问题。
DesktopNetworkError.ReceivedUnexpectedEOF	此台云电脑的网络出现异常，导致云环境和管控的连接已中断。您可重启云电脑修复此问题。
DesktopNetworkError.SystemOutOfResource	此台云电脑的网络出现异常，导致云环境和管控的连接已中断。您可重启云电脑修复此问题。
DesktopNetworkError.UnKnowError	此台云电脑的网络出现异常，导致云环境和管控的连接已中断。您可重启云电脑修复此问题。
DesktopStatus-Desc-Updating	正在变更此台云电脑的配置，暂时不可使用。
DesktopStatus-Repairing	修复中
DesktopStatus-Updating	变配中
DeviceNotInManage	无法登录。该办公网络或组织已开启可信设备认证，需请管理员关闭可信设备认证或手动将当前终端纳管为可信设备。
DirectoryLoginUnsupported	输入信息有误，请使用组织ID登录。
DISK_NOT_ENOUGH_SPACE_FOR_FOTA	云电脑“%s”的镜像版本更新失败，原因：云电脑的系统盘不足5GiB。请手动清理磁盘空间后再次预约更新，或联系IT管理员。
DomainFailed	由于系统加域失败导致云电脑连接失败。
DomainRelationshipFailed	由于系统域关系出现异常导致云电脑连接失败。
DriverLoadFailed	检测到此台云电脑的GPU显卡驱动出现异常，建议进行一键修复。修复时将重启云电脑，操作“一键修复”前请先保存云电脑内的数据，以防止数据丢失。
ExistedEmail	该邮箱地址已被占用。请输入其他邮箱地址。
ExistedEndUserId	该用户名已被占用。请输入其他用户名。
ExistedPhoneNumber	该手机号码已被占用。请输入其他手机号码。
ExpiredEmailVerifyCode	邮箱验证码已过期，请重新获取。
FailedToSendEmailVerifyCode	邮箱验证码获取失败，请重试。
ForbidByClientVersionForBusiness	该组织ID为商业版，须将当前客户端升级至最新版本才能登录。
ForbidByPasswordPolicy	修改失败，您的IT管理员已禁用“修改登录密码”。
Forbidden.KmsServiceNotEnabled	如需为多台共享型云电脑创建NAS文件系统以实现用户数据漫游，请先授权开通KMS密钥管理服务。<a href=\https
FOTA_DESKTOP_IN_USE	云电脑“%s”正在使用中，请断开连接后重试“更新”。
FOTA_POWER_SHELL_NOT_FOUND	云电脑“%s”的镜像版本更新失败。导致失败的原因：云电脑中的PowerShell程序无法正常运行。请修复PowerShell程序后重试更新，或联系IT管理员。
FOTA_SECURITY_SOFTWARE_ERROR	云电脑“%s”的镜像版本更新失败，原因：云电脑中的安全软件可能导致升级失败，请关闭安全软件后重试升级，或联系IT管理员。
FOTA_SNAPSHOT_IN_PROGRESS	由于云电脑“%s”正在创建系统快照中，当前无法执行镜像更新，请稍后重试。
FOTA_SNAPSHOT_NOT_READY	云电脑“%s”的镜像版本更新失败。导致失败的原因：快照系统繁忙导致镜像更新所需系统盘快照仍未就绪，请稍后重试。
FOTA_UPDATE_CLOUD_ASSIST_NOT_READY	云电脑“%s”的镜像版本更新失败，原因：云助手进程状态异常。一键修复过程中此云电脑将自动重启。如修复后仍无法更新镜像版本，请联系企业IT管理员。
FunctionDisabled	春节期间部分功能暂时停用，预计于2025年1月31日恢复，如您在此期间有需要，请提交工单反馈。
game-BindError.CandidateAppInstanceGroupIsNull	云游戏服务异常，我们正在努力修复中...
game-DirectionalSchedulingFailed.AppInstanceIsUnavailable	云游戏服务异常，请稍后再试。
game-InternalError	云游戏服务异常，我们正在努力修复中...
game-InvalidAppInstanceState.notIdle	云游戏服务异常，请稍后再试。
game-InvalidBindStage	云游戏服务异常，请稍后再试。
game-ResourceUnavailable.AllBoundAppInstanceIsUnavailable	当前游戏火爆，请3分钟后重试。
game-ResourceUnavailable.AllCandidatesHaveNoIdleAppInstance	当前游戏火爆，请3分钟后重试。
game-ResourceUnavailable.AllCandidatesHaveNoldleAppInstance	当前游戏火爆，请3分钟后重试。
game-ResourceUnavailable.AppInstanceGroupIsFull	当前游戏火爆，请稍后重试。
game-ResourceUnavailable.BindBusy	当前游戏火爆，请3分钟后重试。
game-ResourceUnavailable.IdleInstanceUnavailable	当前游戏火爆，请稍后重试。
game-ResourceUnavaliable.AllBoundAppInstanceIsUnavailable	当前游戏火爆，请稍后重试。
game-TryBind.AppRegionBindLockFailed	当前游戏火爆，请3分钟后重试。
game-TryBind.AutoAuthAppInstancePersistentLockFailed	当前游戏火爆，请3分钟后重试。
game-TryBind.NoCandidateAppInstanceGroup	当前游戏火爆，请3分钟后重试。
game-TryBind.NoPermissionForApp	云游戏服务异常，我们正在努力修复中...
game-TryBind.PackageGroupInsufficient	共享核时包时长不足，请充值。
game-TryRegionBind.NoCandidateAppInstanceGroup	当前游戏火爆，请3分钟后重试。
GetAppisNotDistributed	AI助手功能未授权，请联系管理员
GuestOperateDesktopFail	云电脑关机或重启失败
GuestOperateDesktopTimeout	由于响应超时导致您在云电脑内操作的关机或重启执行失败。请在客户端内的“云电脑卡片>电源”中重新执行此操作。
GuestRebootOperateFail	云电脑重启失败
GuestRebootOperateTimeout	由于响应超时导致您在云电脑内操作的重启执行失败。请在客户端内的“云电脑卡片>电源”中重新执行此操作。
GuestStopOperateFail	云电脑关机失败
GuestStopOperateTimeout	由于响应超时导致您在云电脑内操作的关机执行失败。请在客户端内的“云电脑卡片>电源”中重新执行此操作。
InvalidDesktopStatus.InMaintenance	由于IT管理员将此台云电脑设置为维护模式，此状态下不支持使用云电脑。请联系IT管理员。
InvalidDirectoryType	RAM账号已下线，请联系IT管理员。
InvalidEmailVerifyCode	邮箱验证码错误，请重新输入。
InvalidHibernateOperation	休眠状态的云电脑无法进行“恢复至初始镜像”操作，请先唤醒此台云电脑。
InvalidMfaDeviceStatus	虚拟多因素认证设备错误。请使用与您的账号绑定的设备。
InvalidPassword	用户名或密码输入错误
LoginError.MissingConcatForVerify	由于此账号为管理员激活账号，无法完成身份安全校验，请联系IT管理员。
LoginForbidden	无法登录。该办公网络或组织已开启可信设备认证，需请管理员关闭可信设备认证或手动将当前终端纳管为可信设备。
LoginForbidden.LockedByAdmin	该便捷账号已被锁定，请联系您的IT管理员前往无影云电脑企业版控制台手动解锁。
LoginForbiddenByDevice	无法登录。管理员限定该终端只能被特定用户登录，当前账号不在限定范围内。
LoginForbiddenByUntrustedDevice	无法登录，管理员已开启“拦截不可信终端登录 ”，需要管理员将此终端纳管为可信设备或禁用此功能。
LoginForbiddenByUser	无法登录。管理员开启用户登录终端限制，请至指定终端进行登录。
MfaClientNotSupport	客户端版本过低，不支持该多因素认证方式，请升级客户端。
MfaNotAllowed	您的账号缺少该多因素认证方式要求的信息，请联系IT管理员补充。
MfaTypeNotAllowed	您的IT管理员尚未启用该多因素认证方式
MfaUserGoingToBeLocked	验证码错误。若连续错误达10次，您的账号将被锁定20分钟。
MfaUserNotExist	此账号已被删除。请向您的IT管理员咨询详情。
MfaVerifyCodeDiscarded	该验证码已失效，请重新获取。
PhoneIsNotRegistered	手机号输入错误或管理员未将手机号绑定到账号。
SessionForceQuit	已自动退登。原因：已在其他终端注销或登录终端数量超出IT管理员限制。
SEStartDesktopStockFail	电竞模式库存不足
SEStartDesktopStockout	电竞模式库存不足，请切换至其他规格模式开机，或稍后重试。
StartApplicationGuestTimeout	网络信号不稳定，应用打开失败，请重试。
StartDesktopCheckEcsHealthStatus	云电脑开机过程中出现蓝屏等异常状态导致开机失败。请重启云电脑，如仍旧出现开机失败，请尝试恢复快照或联系IT管理员。注意：恢复快照时会清空您尚未保存的文件数据。
StartDesktopCheckSystemEvent	云电脑出现宕机导致开机失败。请重启云电脑，如仍旧出现开机失败，请尝试恢复快照或联系IT管理员。注意：恢复快照时会清空您尚未保存的文件数据。
StartDesktopFail	云电脑开机失败
ThrottlingSendEmailVerifyCodeLimit	一分钟只能发送一次验证码
UnavailableDesktop.2907	由于协议服务仍在启动中，导致云电脑连接失败。请稍后重新连接或重启云电脑，如仍旧出现连接失败，请联系IT管理员。
WakeupFailed	由于服务出现异常导致云电脑唤醒失败，可尝试关机或稍后再唤醒。
XIAO_YING_APPLICATION_CENTER_DOWNLOADING	请前往无影应用中心下载“无影晓颖AI助手”客户端。

4. 无影云手机Web SDK快速集成最佳实践

快速集成总体方案见无影云手机快速集成最佳实践。此处介绍Web端SDK如何快速集成。

假设您已经完成了服务端集成环节，Web端快速集成的时序图如下：

Web端已经在SDK代码中封装了上图中的第7~11步，因此代码可大幅简化。简化后的流程图为：

具体代码可以参考接口说明中的createSession的参考代码。

5. 常见问题

如何关闭悬浮球？

创建会话（createSession）阶段初始化uiConfig时，可以关闭悬浮球。

uiConfig: {
  toolbar: {
    visible: false,
  },
},

怎么通过ASP通道发送ADB命令？

创建会话（createSession）时初始化lyncChannelConfig。

lyncChannelConfig: [
  {
    lyncChannelName: "lync_adb_shell",
  },
],

需要发送命令时，可以调用session.sendLyncMessage，例如：

session.sendLyncMessage(
    "lync_adb_shell",
    JSON. stringify({
        id: crypto. randomUUID(), 
        cmd: 'input keyevent KEYCODE_VOLUME_UP',
    })
    );