辅助助手接口

说明

本页由企业版 OpenAPI 文档整理，模块：辅助助手接口。

设置辅助助手参数

POST /openapi/appHelper/setParam

支持EC iOS中控 6.1.0+

请求 Body

1
{
2
    "deviceId": "6a290cdc0b6db0565955355b157acc090e33f76e",
3
    "bundleIdPrefix": "com.example.helper",
4
    "appHelperPort": 8199
5
}

请求示例

1
import requests
2

3
body = {
4
  "deviceId": "6a290cdc0b6db0565955355b157acc090e33f76e",
5
  "bundleIdPrefix": "com.example.helper",
6
  "appHelperPort": 8199
7
}
8
r = requests.post("http://127.0.0.1:8019/openapi/appHelper/setParam", json=body, timeout=30)
9
print(r.json())

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

1
curl -s -X POST "http://127.0.0.1:8019/openapi/appHelper/setParam" \
2
  -H "Content-Type: application/json" \
3
  -d '{"deviceId":"6a290cdc0b6db0565955355b157acc090e33f76e","bundleIdPrefix":"com.example.helper","appHelperPort":8199}'

1
using System.Text;
2
using var http = new HttpClient { Timeout = TimeSpan.FromSeconds(30) };
3
var json = "{\"deviceId\":\"6a290cdc0b6db0565955355b157acc090e33f76e\",\"bundleIdPrefix\":\"com.example.helper\",\"appHelperPort\":8199}";
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/appHelper/setParam", content);
6
var text = await res.Content.ReadAsStringAsync();
7
Console.WriteLine(text);

请求参数

名称	位置	类型	必选	说明
body	body	object	否	none
» deviceId	body	string	是	设备ID
» bundleIdPrefix	body	string	是	助手app的bundleId，多个用英文都好隔开
» appHelperPort	body	integer	是	辅助app的运行端口

返回示例

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	none
» msg	string	true	none	错误消息

设置剪切板

POST /openapi/appHelper/setPasteboard

支持EC iOS中控 6.0.0+

请求 Body

1
{
2
    "deviceId": "6a290cdc0b6db0565955355b157acc090e33f76e",
3
    "content": "hello",
4
    "openApp": true
5
}

请求示例

1
import requests
2

3
body = {
4
  "deviceId": "6a290cdc0b6db0565955355b157acc090e33f76e",
5
  "content": "hello",
6
  "openApp": True
7
}
8
r = requests.post("http://127.0.0.1:8019/openapi/appHelper/setPasteboard", json=body, timeout=30)
9
print(r.json())

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

1
curl -s -X POST "http://127.0.0.1:8019/openapi/appHelper/setPasteboard" \
2
  -H "Content-Type: application/json" \
3
  -d '{"deviceId":"6a290cdc0b6db0565955355b157acc090e33f76e","content":"hello","openApp":true}'

1
using System.Text;
2
using var http = new HttpClient { Timeout = TimeSpan.FromSeconds(30) };
3
var json = "{\"deviceId\":\"6a290cdc0b6db0565955355b157acc090e33f76e\",\"content\":\"hello\",\"openApp\":true}";
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/appHelper/setPasteboard", content);
6
var text = await res.Content.ReadAsStringAsync();
7
Console.WriteLine(text);

请求参数

名称	位置	类型	必选	说明
body	body	object	否	none
» deviceId	body	string	是	设备ID
» content	body	string	是	要粘贴的内容
» openApp	body	boolean	是	运行的时候是否打开辅助助手app

返回示例

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	none
» msg	string	true	none	错误消息

读取剪切板

POST /openapi/appHelper/getPasteboard

支持EC iOS中控 6.1.0+

请求 Body

1
{
2
    "deviceId": "6a290cdc0b6db0565955355b157acc090e33f76e",
3
    "openApp": true
4
}

请求示例

1
import requests
2

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

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

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

1
using System.Text;
2
using var http = new HttpClient { Timeout = TimeSpan.FromSeconds(30) };
3
var json = "{\"deviceId\":\"6a290cdc0b6db0565955355b157acc090e33f76e\",\"openApp\":true}";
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/appHelper/getPasteboard", content);
6
var text = await res.Content.ReadAsStringAsync();
7
Console.WriteLine(text);

请求参数

名称	位置	类型	必选	说明
body	body	object	否	none
» deviceId	body	string	是	设备ID
» openApp	body	boolean	是	运行的时候是否打开辅助助手app

返回示例

200 Response

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

返回结果

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

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» code	integer	true	none	0 成功其他失败
» data	string	true	none	剪切板的数据
» msg	string	true	none	错误消息

打开URL

POST /openapi/appHelper/openUrl

支持EC iOS中控 6.1.0+

请求 Body

1
{
2
    "deviceId": "6a290cdc0b6db0565955355b157acc090e33f76e",
3
    "openApp": true,
4
    "url": "https://www.baidu.com"
5
}

请求示例

1
import requests
2

3
body = {
4
  "deviceId": "6a290cdc0b6db0565955355b157acc090e33f76e",
5
  "openApp": True,
6
  "url": "https://www.baidu.com"
7
}
8
r = requests.post("http://127.0.0.1:8019/openapi/appHelper/openUrl", json=body, timeout=30)
9
print(r.json())

1
const body = {
2
  "deviceId": "6a290cdc0b6db0565955355b157acc090e33f76e",
3
  "openApp": true,
4
  "url": "https://www.baidu.com"
5
};
6
const res = await fetch("http://127.0.0.1:8019/openapi/appHelper/openUrl", {
7
  method: "POST",
8
  headers: { "Content-Type": "application/json" },
9
  body: JSON.stringify(body),
10
});
11
const data = await res.json();
12
console.log(data);

1
curl -s -X POST "http://127.0.0.1:8019/openapi/appHelper/openUrl" \
2
  -H "Content-Type: application/json" \
3
  -d '{"deviceId":"6a290cdc0b6db0565955355b157acc090e33f76e","openApp":true,"url":"https://www.baidu.com"}'

1
using System.Text;
2
using var http = new HttpClient { Timeout = TimeSpan.FromSeconds(30) };
3
var json = "{\"deviceId\":\"6a290cdc0b6db0565955355b157acc090e33f76e\",\"openApp\":true,\"url\":\"https://www.baidu.com\"}";
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/appHelper/openUrl", content);
6
var text = await res.Content.ReadAsStringAsync();
7
Console.WriteLine(text);

请求参数

名称	位置	类型	必选	说明
body	body	object	否	none
» deviceId	body	string	是	设备ID
» openApp	body	boolean	是	运行的时候是否打开辅助助手app
» url	body	string	是	网址

返回示例

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	none
» msg	string	true	none	错误消息

上传到相册

POST /openapi/appHelper/uploadToAlbum

支持EC iOS中控 6.1.0+

请求 Body

1
{
2
    "deviceId": "6a290cdc0b6db0565955355b157acc090e33f76e",
3
    "openApp": true,
4
    "path": "C:/a.png"
5
}

请求示例

1
import requests
2

3
body = {
4
  "deviceId": "6a290cdc0b6db0565955355b157acc090e33f76e",
5
  "openApp": True,
6
  "path": "C:/a.png"
7
}
8
r = requests.post("http://127.0.0.1:8019/openapi/appHelper/uploadToAlbum", json=body, timeout=30)
9
print(r.json())

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

1
curl -s -X POST "http://127.0.0.1:8019/openapi/appHelper/uploadToAlbum" \
2
  -H "Content-Type: application/json" \
3
  -d '{"deviceId":"6a290cdc0b6db0565955355b157acc090e33f76e","openApp":true,"path":"C:/a.png"}'

1
using System.Text;
2
using var http = new HttpClient { Timeout = TimeSpan.FromSeconds(30) };
3
var json = "{\"deviceId\":\"6a290cdc0b6db0565955355b157acc090e33f76e\",\"openApp\":true,\"path\":\"C:/a.png\"}";
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/appHelper/uploadToAlbum", content);
6
var text = await res.Content.ReadAsStringAsync();
7
Console.WriteLine(text);

请求参数

名称	位置	类型	必选	说明
body	body	object	否	none
» deviceId	body	string	是	设备ID
» openApp	body	boolean	是	运行的时候是否打开辅助助手app
» path	body	string	是	图片或者视频地址在电脑上的路径

返回示例

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	方向 1 正常的竖屏，2 向右旋转90度(顺时针)
» msg	string	true	none	错误消息

开启端口转发

POST /openapi/appHelper/startForwardPort

支持EC iOS中控 6.1.0+

请求 Body

1
{
2
    "deviceId": "6a290cdc0b6db0565955355b157acc090e33f76e",
3
    "openApp": true,
4
    "remotePort": 8080
5
}

请求示例

1
import requests
2

3
body = {
4
  "deviceId": "6a290cdc0b6db0565955355b157acc090e33f76e",
5
  "openApp": True,
6
  "remotePort": 8080
7
}
8
r = requests.post("http://127.0.0.1:8019/openapi/appHelper/startForwardPort", json=body, timeout=30)
9
print(r.json())

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

1
curl -s -X POST "http://127.0.0.1:8019/openapi/appHelper/startForwardPort" \
2
  -H "Content-Type: application/json" \
3
  -d '{"deviceId":"6a290cdc0b6db0565955355b157acc090e33f76e","openApp":true,"remotePort":8080}'

1
using System.Text;
2
using var http = new HttpClient { Timeout = TimeSpan.FromSeconds(30) };
3
var json = "{\"deviceId\":\"6a290cdc0b6db0565955355b157acc090e33f76e\",\"openApp\":true,\"remotePort\":8080}";
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/appHelper/startForwardPort", content);
6
var text = await res.Content.ReadAsStringAsync();
7
Console.WriteLine(text);

请求参数

名称	位置	类型	必选	说明
body	body	object	否	none
» deviceId	body	string	是	设备ID
» openApp	body	boolean	是	运行的时候是否打开辅助助手app
» remotePort	body	integer	是	远程端口

返回示例

200 Response

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

返回结果

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

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» code	integer	true	none	0 成功其他失败
» data	integer	true	none	远程端口映射到本机的端口地址
» msg	string	true	none	错误消息

关闭端口转发

POST /openapi/appHelper/closeForwardPort

支持EC iOS中控 6.1.0+

请求 Body

1
{
2
    "deviceId": "6a290cdc0b6db0565955355b157acc090e33f76e",
3
    "localPort": 51947
4
}

请求示例

1
import requests
2

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

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

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

1
using System.Text;
2
using var http = new HttpClient { Timeout = TimeSpan.FromSeconds(30) };
3
var json = "{\"deviceId\":\"6a290cdc0b6db0565955355b157acc090e33f76e\",\"localPort\":51947}";
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/appHelper/closeForwardPort", content);
6
var text = await res.Content.ReadAsStringAsync();
7
Console.WriteLine(text);

请求参数

名称	位置	类型	必选	说明
body	body	object	否	none
» deviceId	body	string	是	设备ID
» localPort	body	integer	是	本机的端口

返回示例

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	成功或者失败
» msg	string	true	none	错误消息

关闭所有端口转发

POST /openapi/appHelper/closeAllForwardPort

支持EC iOS中控 6.1.0+

请求 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/appHelper/closeAllForwardPort", 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/appHelper/closeAllForwardPort", {
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/appHelper/closeAllForwardPort" \
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/appHelper/closeAllForwardPort", 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	方向 1 正常的竖屏，2 向右旋转90度(顺时针)
» msg	string	true	none	错误消息