新增自有设备
新增一个自有设备,支持代理设备、远程设备,透传字段与浏览器自有设备新增接口保持一致。
调用方式
通过本地 WebSocket 发送 JSON 请求,method 固定为 createSelfDevice。
{
"method": "createSelfDevice"
}
请求参数
| 参数 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
| equipmentName / name / deviceName | string | 是 | 设备名称。 |
| proxyType | string | 否 | 代理协议,例如 http、https、socks5、shadowsocks。 |
| proxyIpAddress | string | 否 | 代理地址。 |
| proxyPort | string | number | 否 | 代理端口。 |
| proxyAccount | string | 否 | 代理账号。 |
| proxyPassword | string | 否 | 代理密码。 |
| vpsIpAddress | string | 否 | 远程设备地址。 |
| vpsPort | string | number | 否 | 远程设备端口。 |
| vpsAccount | string | 否 | 远程设备账号。 |
| vpsPassword | string | 否 | 远程设备密码。 |
| tagIdList / tagIds | array | 否 | 设备标签 ID 列表。 |
| localType | number | 否 | 网络类型,1 静态,2 动态。 |
| encryptType | string | 否 | shadowsocks 加密方式。 |
| encryptSecret | string | 否 | shadowsocks 加密密钥。 |
| apiVersion / useV2Api | string | boolean | 否 | 传 apiVersion=v2 或 useV2Api=true 时使用 v2 新增接口。 |
| exportIp | string | 否 | v2 接口出口 IP。 |
| ipInfoIoVO / ipInfo | object | 否 | v2 接口 IP 归属信息。 |
请求示例
{
"method": "createSelfDevice",
"equipmentName": "测试自有设备",
"proxyType": "socks5",
"proxyIpAddress": "1.2.3.4",
"proxyPort": 1080,
"proxyAccount": "user",
"proxyPassword": "password",
"tagIdList": [
1001
],
"localType": 1
}{
"method": "createSelfDevice",
"equipmentName": "测试自有设备-v2",
"apiVersion": "v2",
"proxyType": "http",
"proxyIpAddress": "example.com",
"proxyPort": 8080,
"exportIp": "1.2.3.4",
"ipInfoIoVO": {
"ip": "1.2.3.4",
"city": "Los Angeles",
"region": "California",
"country": "US"
}
}
返回示例
{
"method": "createSelfDevice",
"response": {
"code": 200,
"msg": "success",
"data": 123456
}
}
说明
- 仅新增设备,不负责检测设备连通性;后端校验失败时会返回错误信息。
- 如果传入 exportIp、ipInfoIoVO 或 apiVersion=v2,会自动调用新增自有设备 v2 后端接口。
错误返回
{
"method": "createSelfDevice",
"status": "error",
"code": "400",
"msg": "error message"
}