跳到主要内容

接口清单

本页由代码生成,与线上路由一一对应。

对外承诺兼容的是 /v1/...。/api/... 是网页端自用的,随时可能改,不要对它编程。

设备与会话​

方法路径权限说明
POST/v1/device/{did}/autorenewdevice自动续费开关。
GET/v1/device/{did}/proxy—当前出口状态。上游读不到时不编造,把 error 如实带出去。
POST/v1/device/{did}/proxydevice应用代理并对齐身份。会重启设备。
DELETE/v1/device/{did}/proxydevice取消出口代理,还原 IP/SIM/GPS/时区。同样会重启设备。
POST/v1/device/{did}/proxy/checkdevice先验代理再应用。不改设备任何状态,可以随便点。
GET/v1/device/{did}/renew—
POST/v1/device/{did}/renewbilling续费。扣费顺序与下单一致:先扣额度,失败再退。
GET/v1/device/{did}/selfcheck—
POST/v1/device/{did}/sessionstream签发串流会话。归属校验在 owned_device 里,签发前必过。
DELETE/v1/device/{did}/sessionstream
GET/v1/devices—
POST/v1/previewsstream批量取预览图。宫格的低成本形态。
POST/v1/sessionsstream

操作设备​

方法路径权限说明
POST/v1/actinput按选择器(或坐标)执行单步操作。单台,异步,返回 task_id。
GET/v1/act/{task_id}input查单步操作的结果。
POST/v1/injectinput往实例里注入数据:短信、通话记录、通讯录。
POST/v1/inputinput不开串流驱动设备:点按、滑动、长按、按键、输入文本。
POST/v1/uiinput取设备当前屏幕的可交互节点树。单台,同步。

自动化​

方法路径权限说明
POST/v1/automation/dispatchinput批量派发流程任务。
DELETE/v1/automation/schedule/{sid}input删除一条定时任务。
POST/v1/automation/schedule/{sid}/toggleinput启停一条定时任务。
GET/v1/automation/schedules—定时任务列表。
POST/v1/automation/schedulesinput创建定时任务。每台设备生成一条,所以返回的是数组。
GET/v1/automation/scripts—流程模板列表。只读,归 read 档。
POST/v1/automation/task/{task_id}/cancelinput取消待执行或运行中的任务。
GET/v1/automation/task/{task_id}/logs—任务的步骤级日志。
GET/v1/automation/tasks—流程任务列表。

目录与开通​

方法路径权限说明
GET/v1/catalog—售卖目录。只输出我方售价,不含上游成本。
GET/v1/orders—
POST/v1/ordersbilling
POST/v1/orders/{oid}/claimbilling认领订单对应的实例。

账号​

方法路径权限说明
GET/v1/client/me—

权限一览​

密钥按应用签发,权限也挂在应用上。没标权限的端点只需要有效密钥。

权限含义
device_read看设备:查看设备与任务,不能做任何更改
stream开画面:签发串流会话(含批量)
device改设备:出口代理、自动续费开关
input操作设备:点按、滑动、按键、输入文本、注入数据
billing花钱:开通新设备、续费