方法参考
更新时间 2026-03-04 10:41:32
最近更新时间: 2026-03-04 10:41:32
API参考
Client 类
构造函数
new Client(options: ClientOptions): ClientClientOptions 参数说明:
| 参数名 | 类型 | 必需 | 说明 |
|---|---|---|---|
| apiKey | string | 是 | 控制台上的AccessKey ID 打开控制台 |
| apiSecret | string | 是 | 控制台上的AccessKey Secret |
| desktopCode | string | 是 | 桌面编码,控制台可查看 |
| serviceURL | string | 否 | 服务地址,默认 https://desk.ctyun.cn:8816 |
方法
createSession()
创建会话并返回会话对象。
async createSession(): Promise<Session>返回值:
| 属性名 | 类型 | 说明 |
|---|---|---|
| sessionId | string | 会话唯一标识 |
| computer | ComputerAPI | 计算机控制方法集合 |
| close | Function | 关闭会话方法 |
Session 对象
computer 对象
返回值说明
对computer类下面的所有方法的调用都是异步调用,返回值遵循相同的返回格式:
{
"code": 0,
"data":null,
"msg":null
}| 参数名 | 类型 | 说明 |
|---|---|---|
| code | number | 状态码,为0代表成功,其他表示失败 |
| data | number | 结果,code为0时不为空 |
| msg | number | code不为0时记录错误信息 |
move_mouse(x, y)
移动鼠标到指定坐标。
| 参数名 | 类型 | 说明 |
|---|---|---|
| x | number | 目标 X 坐标 |
| y | number | 目标 Y 坐标 |
click_mouse(x, y, clickMode?, pressMode?,releaseMode?)
在指定位置点击鼠标。
| 参数名 | 类型 | 必需 | 说明 |
|---|---|---|---|
| x | number | 是 | X 坐标 |
| y | number | 是 | Y 坐标 |
| clickMode | string | 否 | 点击模式:'left'(默认)、'right'、'middle'、double_left |
| pressMode | Boolean | 否 | 鼠标按下状态:true保持按下,false(默认)不按下 |
| releaseMode | Boolean | 否 | 鼠标松开状态:true松开鼠标,false(默认)不松开 |
提示
pressMode=true&releaseMode=true:鼠标点下又松开pressMode=false&releaseMode=false:鼠标点下又松开pressMode=true&releaseMode=false`:鼠标点下不松开pressMode=false&releaseMode=true:鼠标松开
drag_mouse(startX, startY, endX, endY)
拖拽鼠标。
| 参数名 | 类型 | 说明 |
|---|---|---|
| startX | number | 起始 X 坐标 |
| startY | number | 起始 Y 坐标 |
| endX | number | 目标 X 坐标 |
| endY | number | 目标 Y 坐标 |
scroll(startX, startY, direction, amount)
滚动页面。
| 参数名 | 类型 | 说明 |
|---|---|---|
| startX | number | 滚动位置 X 坐标 |
| startY | number | 滚动位置 Y 坐标 |
| direction | string | 滚动方向:'up' 或 'down' |
| amount | number | 滚动量,单位:px |
press_key(key)
按下键盘按键。
| 参数名 | 类型 | 说明 |
|---|---|---|
| key | string | 按键名称,如 'Enter'、'Escape' 等 |
type_text(text)
输入文本。
| 参数名 | 类型 | 说明 |
|---|---|---|
| text | string | 要输入的文本内容 |
screen_shot()
截取屏幕。
get_cursor_position()
获取当前鼠标位置。
close()
关闭当前会话。
返回值: 关闭结果
FAQ
常见错误码
错误码 | 说明 |
|---|---|
| 52060 | 指定桌面不属于当前用户 |
| 92006 | 桌面不在线 |
| 92100 | 通过 sessionId 找不到 session |
| 92101 | 消息发送失败 |
| 92102 | 消息长度不能超过 2000 字符 |
| 92103 | 找不到消息记录 |
| 92104 | 功能未开放,请联系管理员 |
| 92105 | 功能未开放,请联系管理员 |