# 基本规范

## 示例

比如登录接口：

```typescript
const response = await client.user.login({ account: "xxx@xxx.com", password: "12345678", areaCode: "+1" });
```

正常情况下，返回的内容：

| 参数名          | 类型     | 描述                                                                                                                                                                                   |
|--------------|--------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| status       | String | HTTP 状态码                                                                                                                                                                             |
| responseTime | Number | 响应时长，单位毫秒                                                                                                                                                                            |
| error        | String | 错误码，0 成功，其他失败，具体见：https://coolkit-technologies.github.io/eWeLink-API/#/zh-cmn/%E6%8E%A5%E5%8F%A3%E4%B8%AD%E5%BF%83_v2?id=%e9%94%99%e8%af%af%e7%a0%81                                 |
| msg          | String | 返回错误的具体原因                                                                                                                                                                            |
| data         | Object | 请求得到的参数，见：https://coolkit-technologies.github.io/eWeLink-API/#/zh-cmn/OAuth2.0 、 https://coolkit-technologies.github.io/eWeLink-API/#/zh-cmn/%E6%8E%A5%E5%8F%A3%E4%B8%AD%E5%BF%83_v2 |

所有字符都是规定格式，data 中的内容根据接口的不同返回不同。
可看其他文档了解或者通过 [酷宅开放平台](https://ewelink.gitee.io/ewelink-api/) 的在线文档确定。

## 其他文档

- [自带方法](自带方法.md)
- [用户管理](用户管理.md)
- [设备管理](设备管理.md)
- [家庭房间](家庭房间.md)
- [消息中心](消息中心.md)
- [OAuth2.0](OAuth2.0.md)
- [长连接控制](长连接控制.md)
- [局域网控制](局域网控制.md)
- [其他](其他.md)