接口API

## 前言
为了方便开发岗位的用户，助手支持了接口API，通过username（app首页点击左上角查看）和auth_key（接口api鉴权key）鉴权来调用部分开放接口。
```
注意：接口API目前为实验功能，单个IP限制为300次/天，恶意使用将被封禁IP。新版本已支持device_id，cid优先级大于device_id，cid会随设备上下线而变化。
```

## 使用方法

### 重置auth_key
```
GET：https://smshelper.wisg.cn/api/send/{{username}}/{{auth_key}}/reset
```

### 访问云端信息页面
为了方便用户使用，我们提供了访问云端信息的页面。
```
GET：https://smshelper.wisg.cn/server-msg.html?username={{username}}&auth_key={{auth_key}}
```

### 获取云端信息列表
offset（跳过指定数量的记录，从第 offset + 1 条记录开始返回）、limit（返回多少条）和duration（最近多少秒）为可选参数，用于分页。
```
GET：https://smshelper.wisg.cn/api/send/{{username}}/{{auth_key}}/msg?offset=0&limit=10&duration=60
```
### 获取实时云端消息
使用socketio协议，连接到服务器获取最新云端信息。
```javascript
const socket = io(`https://api-smshelper.wisg.cn`, {
  path: "/live-msg",
  query: {
    username:"你的username",
    auth_key:"你的auth_key",
  }
});
socket.on("server-msg", (payload) => {
  // 当有新的云端消息，会实时推送到该事件，并携带信息payload
});
```

### 获取在线设备列表（cid为临时id，重启App会改变，device_id为设备ID，不会改变）
```
GET：https://smshelper.wisg.cn/api/send/{{username}}/{{auth_key}}/devices
```

### 发送设备通知
cid或device_id，通过在线设备列表接口获取；titile和content为推送的标题和内容。
```
GET：https://smshelper.wisg.cn/api/send/{{username}}/{{auth_key}}/notify?cid={{cid}}&title={{title}}&content={{content}}
```

### 发送短信
cid或device_id，通过在线设备列表接口获取；phone和content为对方手机号码和短信内容；slot（可选参数）为发短信的卡槽，值为0或1，代表卡槽一和卡槽二。
```
GET：https://smshelper.wisg.cn/api/send/{{username}}/{{auth_key}}/send-sms?cid={{cid}}&phone={{phone}}&content={{content}}&slot={{slot}}
```

### 短信列表
cid或device_id，通过在线设备列表接口获取；size（可选参数，默认为3）获取短信的条数。
```
GET：https://smshelper.wisg.cn/api/send/{{username}}/{{auth_key}}/recent-sms?cid={{cid}}&size={{size}}
```

### 未接来电列表
cid或device_id，通过在线设备列表接口获取；size（可选参数，默认为3）获取未接来电的条数。
```
GET：https://smshelper.wisg.cn/api/send/{{username}}/{{auth_key}}/missed-call?cid={{cid}}&size={{size}}
```

### 查询号码联系人名称
cid或device_id，通过在线设备列表接口获取；phone要查询的电话号码。
```
GET：https://smshelper.wisg.cn/api/send/{{username}}/{{auth_key}}/contact-name?cid={{cid}}&phone={{phone}}
```

### 获取联系人列表
cid或device_id，通过在线设备列表接口获取。
```
GET：https://smshelper.wisg.cn/api/send/{{username}}/{{auth_key}}/get-contact?cid={{cid}}
```

### 触发定位
cid或device_id，通过在线设备列表接口获取。
```
GET：https://smshelper.wisg.cn/api/send/{{username}}/{{auth_key}}/location?cid={{cid}}
```

### 获取定位信息
cid或device_id，通过在线设备列表接口获取。
```
GET：https://smshelper.wisg.cn/api/send/{{username}}/{{auth_key}}/get-locate?cid={{cid}}
```

### 获取IP信息
cid或device_id，通过在线设备列表接口获取。
```
GET：https://smshelper.wisg.cn/api/send/{{username}}/{{auth_key}}/get-ip?cid={{cid}}
```

### 锁屏
cid或device_id，通过在线设备列表接口获取。
```
GET：https://smshelper.wisg.cn/api/send/{{username}}/{{auth_key}}/lock-screen?cid={{cid}}
```

### 点亮屏幕
cid或device_id，通过在线设备列表接口获取。
```
GET：https://smshelper.wisg.cn/api/send/{{username}}/{{auth_key}}/wake-screen?cid={{cid}}
```

### 修改配置信息
cid或device_id，通过在线设备列表接口获取。支持修改的参数
【全局转发策略】
allow_error_retry：是否开启失败重试
only_send_when_screen_off：是否开启仅在息屏下转发
send_time_section：转发时段

【要转发的内容】
allow_sms：是否转发短信
allow_income_phone_send：是否转发未接来电
allow_notification_send：是否转发应用通知
allow_locate_send：是否转发定位信息
allow_receive_money_send：是否转发收款信息
allow_battery_send：是否转发电量信息

【选择转发方式】
allow_sms_send：开启或关闭短信转发
allow_email_send：开启或关闭邮箱转发
upload_to_server：开启或关闭转发到云端
allow_web_send：开启或关闭网络转发
allow_push_sms：开启或关闭通知转发
allow_mi_push：开启或关闭小米推送
allow_mp_send：开启或关闭微信转发
allow_qywx_send：开启或关闭企业微信转发
allow_script：开启或关闭脚本转发

```
POST：https://smshelper.wisg.cn/api/send/{{username}}/{{auth_key}}/alter-config?cid={{cid}}
Body：{"allow_sms":true,"send_time_section":"09:00-20:00"}
```