Skip to content

中控接口

说明

本页由企业版 OpenAPI 文档整理,模块:中控接口

闪断USB(Windows)

POST /openapi/reconnectUsb

需要EC IOS USB版本8.15.0+

请求 Body

{
"deviceId": "20"
}

请求示例

import requests
body = {
"deviceId": "20"
}
r = requests.post("http://127.0.0.1:8019/openapi/reconnectUsb", json=body, timeout=30)
print(r.json())

请求参数

名称位置类型必选中文名说明
bodybodyobjectnone
» deviceIdbodystring设备ID

返回示例

200 Response

{
"msg": "string",
"code": 0,
"data": true
}

返回结果

状态码状态码含义说明数据模型
200OKnoneInline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» msgstringtruenone错误消息
» codeintegertruenone0 成功 其他失败
» databooleantruenonetrue 成功 false 失败

设备列表

POST /openapi/deviceList

请求 Body

{
"deviceId": "",
"groupId": ""
}

请求示例

import requests
body = {
"deviceId": "",
"groupId": ""
}
r = requests.post("http://127.0.0.1:8019/openapi/deviceList", json=body, timeout=30)
print(r.json())

请求参数

名称位置类型必选中文名说明
bodybodyobjectnone
» deviceIdbodystring设备的ID,模糊匹配
» groupIdbodystring分组的Id

返回示例

200 Response

{
"code": 0,
"data": {
"list": [
{
"bridgeUrl": "http://127.0.0.1:8020",
"deviceAlias": "222333",
"groupId": "1656302284985",
"deviceNo": "6a290cdc0b6db0565955355b157acc090e33f76e",
"deviceId": "6a290cdc0b6db0565955355b157acc090e33f76e",
"deviceName": "iPhone (2)",
"serialNo": "F4GSPUAZHG6W",
"groupName": "test",
"productVersion": "15.2"
}
],
"total": 1,
"page": 1
},
"msg": "string"
}

返回结果

状态码状态码含义说明数据模型
200OKnoneInline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenone0 成功 其他失败
» dataobjecttruenone数据
»» list[object]truenone设备列表数组
»»» bridgeUrlstringfalsenone设备桥接地址
»»» deviceAliasstringfalsenone设备别名
»»» groupIdstringfalsenone设备所在组
»»» deviceNostringfalsenone设备id
»»» deviceIdstringfalsenone设备id
»»» deviceNamestringfalsenone设备名称
»»» serialNostringfalsenone设备序列号
»»» groupNamestringfalsenone组名
»»» productVersionstringfalsenone设备版本
»» totalintegertruenonenone
»» pageintegertruenonenone
» msgstringtruenone错误消息

执行脚本

POST /openapi/startScript

请求 Body

{
"deviceIds": [
"6a290cdc0b6db0565955355b157acc090e33f76e",
"64",
"23",
"70"
],
"name": "太连指中",
"iecPath": "c:/dsdds/build/release.iec"
}

请求示例

import requests
body = {
"deviceIds": [
"6a290cdc0b6db0565955355b157acc090e33f76e",
"64",
"23",
"70"
],
"name": "太连指中",
"iecPath": "c:/dsdds/build/release.iec"
}
r = requests.post("http://127.0.0.1:8019/openapi/startScript", json=body, timeout=30)
print(r.json())

请求参数

名称位置类型必选中文名说明
bodybodyobjectnone
» deviceIdsbody[string]设备ID数组
» namebodystring脚本名称
» iecPathbodystring脚本所在的本机路径

返回示例

200 Response

{
"msg": "string",
"code": 0,
"data": true
}

返回结果

状态码状态码含义说明数据模型
200OKnoneInline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» msgstringtruenone错误消息
» codeintegertruenone0 成功 其他失败
» databooleantruenonetrue 成功 false 失败

停止脚本

POST /openapi/stopScript

请求 Body

{
"deviceIds": [
"6a290cdc0b6db0565955355b157acc090e33f76e",
"32",
"97"
]
}

请求示例

import requests
body = {
"deviceIds": [
"6a290cdc0b6db0565955355b157acc090e33f76e",
"32",
"97"
]
}
r = requests.post("http://127.0.0.1:8019/openapi/stopScript", json=body, timeout=30)
print(r.json())

请求参数

名称位置类型必选中文名说明
bodybodyobjectnone
» deviceIdsbody[string]设备的ID数组

返回示例

200 Response

{
"code": 0,
"data": true,
"msg": "string"
}

返回结果

状态码状态码含义说明数据模型
200OKnoneInline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenone0 成功 其他失败
» databooleantruenone数据
» msgstringtruenone错误消息

获取刷新信息

POST /openapi/refreshMsg

请求 Body

{
"deviceIds": [
"90e2f3834c0977205e441aa664916a9bdde81e8d",
"32",
"97"
]
}

请求示例

import requests
body = {
"deviceIds": [
"90e2f3834c0977205e441aa664916a9bdde81e8d",
"32",
"97"
]
}
r = requests.post("http://127.0.0.1:8019/openapi/refreshMsg", json=body, timeout=30)
print(r.json())

请求参数

名称位置类型必选中文名说明
bodybodyobjectnone
» deviceIdsbody[string]设备的ID数组

返回示例

200 Response

{
"code": 0,
"data": {
"6a290cdc0b6db0565955355b157acc090e33f76e": {
"msg": "脚本结束执行",
"deviceNo": "6a290cdc0b6db0565955355b157acc090e33f76e",
"deviceId": "6a290cdc0b6db0565955355b157acc090e33f76e",
"scriptName": "太连指中",
"serviceOk": "0",
"reportTime": "2022-07-23 10:23:03"
}
},
"msg": "string"
}

返回结果

状态码状态码含义说明数据模型
200OKnoneInline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenone0 成功 其他失败
» dataobjecttruenonenone
»» 6a290cdc0b6db0565955355b157acc090e33f76eobjecttruenone设备ID
»»» msgstringtruenone运行消息
»»» deviceNostringtruenone设备id
»»» deviceIdstringtruenone设备id
»»» scriptNamestringtruenone脚本名称
»»» serviceOkstringtruenone服务是否正常
»»» reportTimestringtruenone上报时间
» msgstringtruenonemsg 错误消息

设置设备别名

POST /openapi/setDeviceAlias

支持EC iOS中控 3.0.0+

请求 Body

{
"deviceId": "6a290cdc0b6db0565955355b157acc090e33f76e",
"deviceAlias": "phone1"
}

请求示例

import requests
body = {
"deviceId": "6a290cdc0b6db0565955355b157acc090e33f76e",
"deviceAlias": "phone1"
}
r = requests.post("http://127.0.0.1:8019/openapi/setDeviceAlias", json=body, timeout=30)
print(r.json())

请求参数

名称位置类型必选中文名说明
bodybodyobjectnone
» deviceIdbodystring设备ID
» deviceAliasbodystring别名,不要用特殊字符 空格等

返回示例

200 Response

{
"code": 0,
"data": true,
"msg": "string"
}

返回结果

状态码状态码含义说明数据模型
200OKnoneInline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenone0 成功 其他失败
» databooleantruenonetrue 成功 false 失败
» msgstringtruenone错误消息

暂停执行脚本

POST /openapi/pauseScript

需要EC IOS USB版本6.47.0+

请求 Body

{
"deviceIds": [
"6a290cdc0b6db0565955355b157acc090e33f76e",
"64",
"23",
"70"
]
}

请求示例

import requests
body = {
"deviceIds": [
"6a290cdc0b6db0565955355b157acc090e33f76e",
"64",
"23",
"70"
]
}
r = requests.post("http://127.0.0.1:8019/openapi/pauseScript", json=body, timeout=30)
print(r.json())

请求参数

名称位置类型必选中文名说明
bodybodyobjectnone
» deviceIdsbody[string]设备ID数组

返回示例

200 Response

{
"msg": "string",
"code": 0,
"data": true
}

返回结果

状态码状态码含义说明数据模型
200OKnoneInline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» msgstringtruenone错误消息
» codeintegertruenone0 成功 其他失败
» databooleantruenonetrue 成功 false 失败

继续执行脚本

POST /openapi/continueScript

需要EC IOS USB版本6.47.0+

请求 Body

{
"deviceIds": [
"6a290cdc0b6db0565955355b157acc090e33f76e",
"64",
"23",
"70"
]
}

请求示例

import requests
body = {
"deviceIds": [
"6a290cdc0b6db0565955355b157acc090e33f76e",
"64",
"23",
"70"
]
}
r = requests.post("http://127.0.0.1:8019/openapi/continueScript", json=body, timeout=30)
print(r.json())

请求参数

名称位置类型必选中文名说明
bodybodyobjectnone
» deviceIdsbody[string]设备ID数组

返回示例

200 Response

{
"msg": "string",
"code": 0,
"data": true
}

返回结果

状态码状态码含义说明数据模型
200OKnoneInline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» msgstringtruenone错误消息
» codeintegertruenone0 成功 其他失败
» databooleantruenonetrue 成功 false 失败

脚本是否暂停状态

POST /openapi/isScriptPause

需要EC IOS USB版本6.47.0+,用于判断这个设备的脚本是否是暂停状态

请求 Body

{
"deviceId": "6a290cdc0b6db0565955355b157acc090e33f76e",
"deviceAlias": "phone1"
}

请求示例

import requests
body = {
"deviceId": "6a290cdc0b6db0565955355b157acc090e33f76e",
"deviceAlias": "phone1"
}
r = requests.post("http://127.0.0.1:8019/openapi/isScriptPause", json=body, timeout=30)
print(r.json())

请求参数

名称位置类型必选中文名说明
bodybodyobjectnone
» deviceIdbodystring设备ID
» deviceAliasbodystring别名,不要用特殊字符 空格等

返回示例

200 Response

{
"code": 0,
"data": true,
"msg": "string"
}

返回结果

状态码状态码含义说明数据模型
200OKnoneInline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenone0 成功 其他失败
» databooleantruenonetrue 暂停中 false 不是暂停状态
» msgstringtruenone错误消息

恢复出厂

POST /openapi/erasePhone

需要EC IOS USB版本8.15.0+

请求 Body

{
"deviceId": "20"
}

请求示例

import requests
body = {
"deviceId": "20"
}
r = requests.post("http://127.0.0.1:8019/openapi/erasePhone", json=body, timeout=30)
print(r.json())

请求参数

名称位置类型必选中文名说明
bodybodyobjectnone
» deviceIdbodystring设备ID

返回示例

200 Response

{
"msg": "string",
"code": 0,
"data": true
}

返回结果

状态码状态码含义说明数据模型
200OKnoneInline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» msgstringtruenone错误消息
» codeintegertruenone0 成功 其他失败
» databooleantruenonetrue 成功 false 失败

开启开发者模式

POST /openapi/enableDeveloperMode

需要EC IOS USB版本8.15.0+

请求 Body

{
"deviceId": "20"
}

请求示例

import requests
body = {
"deviceId": "20"
}
r = requests.post("http://127.0.0.1:8019/openapi/enableDeveloperMode", json=body, timeout=30)
print(r.json())

请求参数

名称位置类型必选中文名说明
bodybodyobjectnone
» deviceIdbodystring设备ID

返回示例

200 Response

{
"msg": "string",
"code": 0,
"data": true
}

返回结果

状态码状态码含义说明数据模型
200OKnoneInline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» msgstringtruenone错误消息
» codeintegertruenone0 成功 其他失败
» databooleantruenonetrue 成功 false 失败

获取屏幕方向-无需自动化

POST /openapi/getOrientationNoAuto

需要EC IOS USB版本8.15.0+

请求 Body

{
"deviceId": "90e2f3834c0977205e441aa664916a9bdde81e8d"
}

请求示例

import requests
body = {
"deviceId": "90e2f3834c0977205e441aa664916a9bdde81e8d"
}
r = requests.post("http://127.0.0.1:8019/openapi/getOrientationNoAuto", json=body, timeout=30)
print(r.json())

请求参数

名称位置类型必选中文名说明
bodybodyobjectnone
» deviceIdbodystring设备ID

返回示例

200 Response

{
"msg": "string",
"code": 0,
"data": true
}

返回结果

状态码状态码含义说明数据模型
200OKnoneInline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» msgstringtruenone错误消息
» codeintegertruenone0 成功 其他失败
» databooleantruenonetrue 成功 false 失败