启停自动化接口

说明

本页由企业版 OpenAPI 文档整理，模块：自动化接口/启停自动化。

启动自动化

POST /openapi/startAutoEnv

请求 Body

1
{
2
    "deviceId":"6a290cdc0b6db0565955355b157acc090e33f76e"
3
}

请求示例

1
import requests
2

3
body = {
4
  "deviceId": "6a290cdc0b6db0565955355b157acc090e33f76e"
5
}
6
r = requests.post("http://127.0.0.1:8019/openapi/startAutoEnv", json=body, timeout=30)
7
print(r.json())

1
const body = {
2
  "deviceId": "6a290cdc0b6db0565955355b157acc090e33f76e"
3
};
4
const res = await fetch("http://127.0.0.1:8019/openapi/startAutoEnv", {
5
  method: "POST",
6
  headers: { "Content-Type": "application/json" },
7
  body: JSON.stringify(body),
8
});
9
const data = await res.json();
10
console.log(data);

1
curl -s -X POST "http://127.0.0.1:8019/openapi/startAutoEnv" \
2
  -H "Content-Type: application/json" \
3
  -d '{"deviceId":"6a290cdc0b6db0565955355b157acc090e33f76e"}'

1
using System.Text;
2
using var http = new HttpClient { Timeout = TimeSpan.FromSeconds(30) };
3
var json = "{\"deviceId\":\"6a290cdc0b6db0565955355b157acc090e33f76e\"}";
4
using var content = new StringContent(json, Encoding.UTF8, "application/json");
5
using var res = await http.PostAsync("http://127.0.0.1:8019/openapi/startAutoEnv", content);
6
var text = await res.Content.ReadAsStringAsync();
7
Console.WriteLine(text);

请求参数

名称	位置	类型	必选	中文名	说明
body	body	object	否		none
» deviceId	body	string	是		设备的ID

返回示例

200 Response

1
{
2
  "code": 0,
3
  "msg": "string",
4
  "data": true
5
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» code	integer	true	none	0 成功其他失败
» msg	string	true	none	错误的消息
» data	boolean	true	none	true 代表成功 false 代表失败

重置USB链接

POST /openapi/resetUsbConn

请求 Body

1
{
2
    "deviceId":"6a290cdc0b6db0565955355b157acc090e33f76e"
3
}

请求示例

1
import requests
2

3
body = {
4
  "deviceId": "6a290cdc0b6db0565955355b157acc090e33f76e"
5
}
6
r = requests.post("http://127.0.0.1:8019/openapi/resetUsbConn", json=body, timeout=30)
7
print(r.json())

1
const body = {
2
  "deviceId": "6a290cdc0b6db0565955355b157acc090e33f76e"
3
};
4
const res = await fetch("http://127.0.0.1:8019/openapi/resetUsbConn", {
5
  method: "POST",
6
  headers: { "Content-Type": "application/json" },
7
  body: JSON.stringify(body),
8
});
9
const data = await res.json();
10
console.log(data);

1
curl -s -X POST "http://127.0.0.1:8019/openapi/resetUsbConn" \
2
  -H "Content-Type: application/json" \
3
  -d '{"deviceId":"6a290cdc0b6db0565955355b157acc090e33f76e"}'

1
using System.Text;
2
using var http = new HttpClient { Timeout = TimeSpan.FromSeconds(30) };
3
var json = "{\"deviceId\":\"6a290cdc0b6db0565955355b157acc090e33f76e\"}";
4
using var content = new StringContent(json, Encoding.UTF8, "application/json");
5
using var res = await http.PostAsync("http://127.0.0.1:8019/openapi/resetUsbConn", content);
6
var text = await res.Content.ReadAsStringAsync();
7
Console.WriteLine(text);

请求参数

名称	位置	类型	必选	中文名	说明
body	body	object	否		none
» deviceId	body	string	是		设备ID

返回示例

200 Response

1
{
2
  "code": 0,
3
  "data": true,
4
  "msg": "string"
5
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» code	integer	true	none	0 成功其他失败
» data	boolean	true	none	true 成功 false 失败
» msg	string	true	none	错误消息

释放自动化

POST /openapi/closeEnv

请求 Body

1
{
2
    "deviceId":"6a290cdc0b6db0565955355b157acc090e33f76e"
3
}

请求示例

1
import requests
2

3
body = {
4
  "deviceId": "6a290cdc0b6db0565955355b157acc090e33f76e"
5
}
6
r = requests.post("http://127.0.0.1:8019/openapi/closeEnv", json=body, timeout=30)
7
print(r.json())

1
const body = {
2
  "deviceId": "6a290cdc0b6db0565955355b157acc090e33f76e"
3
};
4
const res = await fetch("http://127.0.0.1:8019/openapi/closeEnv", {
5
  method: "POST",
6
  headers: { "Content-Type": "application/json" },
7
  body: JSON.stringify(body),
8
});
9
const data = await res.json();
10
console.log(data);

1
curl -s -X POST "http://127.0.0.1:8019/openapi/closeEnv" \
2
  -H "Content-Type: application/json" \
3
  -d '{"deviceId":"6a290cdc0b6db0565955355b157acc090e33f76e"}'

1
using System.Text;
2
using var http = new HttpClient { Timeout = TimeSpan.FromSeconds(30) };
3
var json = "{\"deviceId\":\"6a290cdc0b6db0565955355b157acc090e33f76e\"}";
4
using var content = new StringContent(json, Encoding.UTF8, "application/json");
5
using var res = await http.PostAsync("http://127.0.0.1:8019/openapi/closeEnv", content);
6
var text = await res.Content.ReadAsStringAsync();
7
Console.WriteLine(text);

请求参数

名称	位置	类型	必选	中文名	说明
body	body	object	否		none
» deviceId	body	string	是		设备ID

返回示例

200 Response

1
{
2
  "code": 0,
3
  "data": true,
4
  "msg": "string"
5
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» code	integer	true	none	0 成功其他失败
» data	boolean	true	none	true 代表成功 false代表失败
» msg	string	true	none	错误消息

获取设备信息

POST /openapi/getDeviceInfo

获取设备信息。若缺少所需字段，请改用「获取刷新信息」接口 /openapi/refreshMsg 拉取更全量数据。

请求 Body

1
{
2
    "deviceId":"90e2f3834c0977205e441aa664916a9bdde81e8d"
3
}

请求示例

1
import requests
2

3
body = {
4
  "deviceId": "90e2f3834c0977205e441aa664916a9bdde81e8d"
5
}
6
r = requests.post("http://127.0.0.1:8019/openapi/getDeviceInfo", json=body, timeout=30)
7
print(r.json())

1
const body = {
2
  "deviceId": "90e2f3834c0977205e441aa664916a9bdde81e8d"
3
};
4
const res = await fetch("http://127.0.0.1:8019/openapi/getDeviceInfo", {
5
  method: "POST",
6
  headers: { "Content-Type": "application/json" },
7
  body: JSON.stringify(body),
8
});
9
const data = await res.json();
10
console.log(data);

1
curl -s -X POST "http://127.0.0.1:8019/openapi/getDeviceInfo" \
2
  -H "Content-Type: application/json" \
3
  -d '{"deviceId":"90e2f3834c0977205e441aa664916a9bdde81e8d"}'

1
using System.Text;
2
using var http = new HttpClient { Timeout = TimeSpan.FromSeconds(30) };
3
var json = "{\"deviceId\":\"90e2f3834c0977205e441aa664916a9bdde81e8d\"}";
4
using var content = new StringContent(json, Encoding.UTF8, "application/json");
5
using var res = await http.PostAsync("http://127.0.0.1:8019/openapi/getDeviceInfo", content);
6
var text = await res.Content.ReadAsStringAsync();
7
Console.WriteLine(text);

请求参数

名称	位置	类型	必选	中文名	说明
body	body	object	否		none
» deviceId	body	string	是	设备ID	none

返回示例

200 Response

1
{"code":0,"data":{"deviceName":"iPhone7","deviceId":"6a290cdc0b6db0565955355b157acc090e33f76e","serialNo":"F4GSPUAZHG6W","deviceAlias":"12","battery":98,"orientation":2,"orientationClick":1,"screenWidth":1334,"screenHeight":750,"productVersion":"15.2","model":"iPhone","charging":true}}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» code	integer	true	none	none
» data	object	true	none	none
»» deviceName	string	true	none	设备名称
»» deviceId	string	true	none	设备id
»» serialNo	string	true	none	none
»» deviceAlias	string	true	none	设备别名
»» battery	integer	true	none	当前电量
»» orientation	integer	true	none	屏幕实际方向 1竖屏 2横屏
»» orientationClick	integer	true	none	屏幕点击坐标系 1 竖屏 2横屏
»» screenWidth	integer	true	none	屏幕宽度
»» screenHeight	integer	true	none	屏幕高度
»» productVersion	string	true	none	系统版本
»» model	string	true	none	系统的型号
»» charging	boolean	true	none	是否在充电

获取电量

POST /openapi/getBattery

请求 Body

1
{
2
    "deviceId":"6a290cdc0b6db0565955355b157acc090e33f76e"
3
}

请求示例

1
import requests
2

3
body = {
4
  "deviceId": "6a290cdc0b6db0565955355b157acc090e33f76e"
5
}
6
r = requests.post("http://127.0.0.1:8019/openapi/getBattery", json=body, timeout=30)
7
print(r.json())

1
const body = {
2
  "deviceId": "6a290cdc0b6db0565955355b157acc090e33f76e"
3
};
4
const res = await fetch("http://127.0.0.1:8019/openapi/getBattery", {
5
  method: "POST",
6
  headers: { "Content-Type": "application/json" },
7
  body: JSON.stringify(body),
8
});
9
const data = await res.json();
10
console.log(data);

1
curl -s -X POST "http://127.0.0.1:8019/openapi/getBattery" \
2
  -H "Content-Type: application/json" \
3
  -d '{"deviceId":"6a290cdc0b6db0565955355b157acc090e33f76e"}'

1
using System.Text;
2
using var http = new HttpClient { Timeout = TimeSpan.FromSeconds(30) };
3
var json = "{\"deviceId\":\"6a290cdc0b6db0565955355b157acc090e33f76e\"}";
4
using var content = new StringContent(json, Encoding.UTF8, "application/json");
5
using var res = await http.PostAsync("http://127.0.0.1:8019/openapi/getBattery", content);
6
var text = await res.Content.ReadAsStringAsync();
7
Console.WriteLine(text);

请求参数

名称	位置	类型	必选	中文名	说明
body	body	object	否		none
» deviceId	body	string	是		设备ID

返回示例

200 Response

1
{
2
  "code": 0,
3
  "data": 0,
4
  "msg": "string"
5
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» code	integer	true	none	0 成功其他失败
» data	integer	true	none	0 - 100 手机电量
» msg	string	true	none	错误消息

充电状态

POST /openapi/isCharging

请求 Body

1
{
2
    "deviceId":"6a290cdc0b6db0565955355b157acc090e33f76e"
3
}

请求示例

1
import requests
2

3
body = {
4
  "deviceId": "6a290cdc0b6db0565955355b157acc090e33f76e"
5
}
6
r = requests.post("http://127.0.0.1:8019/openapi/isCharging", json=body, timeout=30)
7
print(r.json())

1
const body = {
2
  "deviceId": "6a290cdc0b6db0565955355b157acc090e33f76e"
3
};
4
const res = await fetch("http://127.0.0.1:8019/openapi/isCharging", {
5
  method: "POST",
6
  headers: { "Content-Type": "application/json" },
7
  body: JSON.stringify(body),
8
});
9
const data = await res.json();
10
console.log(data);

1
curl -s -X POST "http://127.0.0.1:8019/openapi/isCharging" \
2
  -H "Content-Type: application/json" \
3
  -d '{"deviceId":"6a290cdc0b6db0565955355b157acc090e33f76e"}'

1
using System.Text;
2
using var http = new HttpClient { Timeout = TimeSpan.FromSeconds(30) };
3
var json = "{\"deviceId\":\"6a290cdc0b6db0565955355b157acc090e33f76e\"}";
4
using var content = new StringContent(json, Encoding.UTF8, "application/json");
5
using var res = await http.PostAsync("http://127.0.0.1:8019/openapi/isCharging", content);
6
var text = await res.Content.ReadAsStringAsync();
7
Console.WriteLine(text);

请求参数

名称	位置	类型	必选	中文名	说明
body	body	object	否		none
» deviceId	body	string	是		none

返回示例

200 Response

1
{
2
  "code": 0,
3
  "data": true
4
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	中文名	说明
» code	integer	true	none		0 成功其他失败
» data	boolean	true	none		true 充电 false 未充电

自动化服务是否正常

POST /openapi/isServiceOk

请求 Body

1
{
2
    "deviceId":"6a290cdc0b6db0565955355b157acc090e33f76e"
3

4

5
}

请求示例

1
import requests
2

3
body = {
4
  "deviceId": "6a290cdc0b6db0565955355b157acc090e33f76e"
5
}
6
r = requests.post("http://127.0.0.1:8019/openapi/isServiceOk", json=body, timeout=30)
7
print(r.json())

1
const body = {
2
  "deviceId": "6a290cdc0b6db0565955355b157acc090e33f76e"
3
};
4
const res = await fetch("http://127.0.0.1:8019/openapi/isServiceOk", {
5
  method: "POST",
6
  headers: { "Content-Type": "application/json" },
7
  body: JSON.stringify(body),
8
});
9
const data = await res.json();
10
console.log(data);

1
curl -s -X POST "http://127.0.0.1:8019/openapi/isServiceOk" \
2
  -H "Content-Type: application/json" \
3
  -d '{"deviceId":"6a290cdc0b6db0565955355b157acc090e33f76e"}'

1
using System.Text;
2
using var http = new HttpClient { Timeout = TimeSpan.FromSeconds(30) };
3
var json = "{\"deviceId\":\"6a290cdc0b6db0565955355b157acc090e33f76e\"}";
4
using var content = new StringContent(json, Encoding.UTF8, "application/json");
5
using var res = await http.PostAsync("http://127.0.0.1:8019/openapi/isServiceOk", content);
6
var text = await res.Content.ReadAsStringAsync();
7
Console.WriteLine(text);

请求参数

名称	位置	类型	必选	中文名	说明
body	body	object	否		none
» deviceId	body	string	是		none

返回示例

200 Response

1
{
2
  "code": 0,
3
  "data": true,
4
  "msg": "string"
5
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» code	integer	true	none	0 成功其他失败
» data	boolean	true	none	true 成功 false 失败
» msg	string	true	none	错误消息

代理IPA设置

POST /openapi/setAgentSetting

请求 Body

1
{
2
    "deviceId":"6a290cdc0b6db0565955355b157acc090e33f76e",
3
    "screenStreamQuality":2,
4
    "nodeDepth":20,
5
    "screenStreamFramerate":30
6
}

请求示例

1
import requests
2

3
body = {
4
  "deviceId": "6a290cdc0b6db0565955355b157acc090e33f76e",
5
  "screenStreamQuality": 2,
6
  "nodeDepth": 20,
7
  "screenStreamFramerate": 30
8
}
9
r = requests.post("http://127.0.0.1:8019/openapi/setAgentSetting", json=body, timeout=30)
10
print(r.json())

1
const body = {
2
  "deviceId": "6a290cdc0b6db0565955355b157acc090e33f76e",
3
  "screenStreamQuality": 2,
4
  "nodeDepth": 20,
5
  "screenStreamFramerate": 30
6
};
7
const res = await fetch("http://127.0.0.1:8019/openapi/setAgentSetting", {
8
  method: "POST",
9
  headers: { "Content-Type": "application/json" },
10
  body: JSON.stringify(body),
11
});
12
const data = await res.json();
13
console.log(data);

1
curl -s -X POST "http://127.0.0.1:8019/openapi/setAgentSetting" \
2
  -H "Content-Type: application/json" \
3
  -d '{"deviceId":"6a290cdc0b6db0565955355b157acc090e33f76e","screenStreamQuality":2,"nodeDepth":20,"screenStreamFramerate":30}'

1
using System.Text;
2
using var http = new HttpClient { Timeout = TimeSpan.FromSeconds(30) };
3
var json = "{\"deviceId\":\"6a290cdc0b6db0565955355b157acc090e33f76e\",\"screenStreamQuality\":2,\"nodeDepth\":20,\"screenStreamFramerate\":30}";
4
using var content = new StringContent(json, Encoding.UTF8, "application/json");
5
using var res = await http.PostAsync("http://127.0.0.1:8019/openapi/setAgentSetting", content);
6
var text = await res.Content.ReadAsStringAsync();
7
Console.WriteLine(text);

请求参数

名称	位置	类型	必选	说明
body	body	object	否	none
» deviceId	body	string	是	设备id
» nodeDepth	body	integer	是	获取节点的深度 1 - 100 越大，获取时间越长
» screenStreamQuality	body	integer	是	投屏质量 1-100
» screenStreamFramerate	body	integer	是	投屏帧率 1-60

返回示例

200 Response

1
{
2
  "code": 0,
3
  "data": true,
4
  "msg": "string"
5
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» code	integer	true	none	0 成功其他失败
» data	boolean	true	none	true 成功 false 失败
» msg	string	true	none	错误消息

关闭隧道

POST /openapi/closeTunnel

关闭设备隧道。会关闭此前已建立的隧道，对 iOS 17+ 有效。适配 EC iOS USB 9.22.0+。

请求 Body

1
{
2
    "deviceId":"00008030-001529902ED0402E"
3

4

5
}

请求示例

1
import requests
2

3
body = {
4
  "deviceId": "00008030-001529902ED0402E"
5
}
6
r = requests.post("http://127.0.0.1:8019/openapi/closeTunnel", json=body, timeout=30)
7
print(r.json())

1
const body = {
2
  "deviceId": "00008030-001529902ED0402E"
3
};
4
const res = await fetch("http://127.0.0.1:8019/openapi/closeTunnel", {
5
  method: "POST",
6
  headers: { "Content-Type": "application/json" },
7
  body: JSON.stringify(body),
8
});
9
const data = await res.json();
10
console.log(data);

1
curl -s -X POST "http://127.0.0.1:8019/openapi/closeTunnel" \
2
  -H "Content-Type: application/json" \
3
  -d '{"deviceId":"00008030-001529902ED0402E"}'

1
using System.Text;
2
using var http = new HttpClient { Timeout = TimeSpan.FromSeconds(30) };
3
var json = "{\"deviceId\":\"00008030-001529902ED0402E\"}";
4
using var content = new StringContent(json, Encoding.UTF8, "application/json");
5
using var res = await http.PostAsync("http://127.0.0.1:8019/openapi/closeTunnel", content);
6
var text = await res.Content.ReadAsStringAsync();
7
Console.WriteLine(text);

请求参数

名称	位置	类型	必选	中文名	说明
body	body	object	否		none
» deviceId	body	string	是		none

返回示例

200 Response

1
{
2
  "code": 0,
3
  "data": true,
4
  "msg": "string"
5
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» code	integer	true	none	0 成功其他失败
» data	boolean	true	none	true 成功 false 失败
» msg	string	true	none	错误消息

启动隧道

POST /openapi/startTunnel

启动设备隧道。会先关闭此前隧道再启动，对 iOS 17+ 有效。适配 EC iOS USB 9.22.0+。

请求 Body

1
{
2
    "deviceId":"00008030-001529902ED0402E"
3

4

5
}

请求示例

1
import requests
2

3
body = {
4
  "deviceId": "00008030-001529902ED0402E"
5
}
6
r = requests.post("http://127.0.0.1:8019/openapi/startTunnel", json=body, timeout=30)
7
print(r.json())

1
const body = {
2
  "deviceId": "00008030-001529902ED0402E"
3
};
4
const res = await fetch("http://127.0.0.1:8019/openapi/startTunnel", {
5
  method: "POST",
6
  headers: { "Content-Type": "application/json" },
7
  body: JSON.stringify(body),
8
});
9
const data = await res.json();
10
console.log(data);

1
curl -s -X POST "http://127.0.0.1:8019/openapi/startTunnel" \
2
  -H "Content-Type: application/json" \
3
  -d '{"deviceId":"00008030-001529902ED0402E"}'

1
using System.Text;
2
using var http = new HttpClient { Timeout = TimeSpan.FromSeconds(30) };
3
var json = "{\"deviceId\":\"00008030-001529902ED0402E\"}";
4
using var content = new StringContent(json, Encoding.UTF8, "application/json");
5
using var res = await http.PostAsync("http://127.0.0.1:8019/openapi/startTunnel", content);
6
var text = await res.Content.ReadAsStringAsync();
7
Console.WriteLine(text);

请求参数

名称	位置	类型	必选	中文名	说明
body	body	object	否		none
» deviceId	body	string	是		none

返回示例

200 Response

1
{
2
  "code": 0,
3
  "data": true,
4
  "msg": "string"
5
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» code	integer	true	none	0 成功其他失败
» data	boolean	true	none	true 成功 false 失败
» msg	string	true	none	错误消息