意见反馈
更新时间:2018-12-24 19:42:31
意见反馈(Feedback)是智能生活平台提供的连接用户、商家和开发者的一种通道。通过意见反馈,开发者和商家可以及时和用户保持沟通,提升用户满意度。
服务列表:
提交一条意见反馈
定义描述
| path | 版本 | 描述 | 是否需要登陆 | 
|---|---|---|---|
| /feedback/add | 1.0.1 | API描述:提交一条意见反馈 | 是 | 
请求参数
| 参数名 | 类型 | 是否必须 | 默认值 | 示例值 | 描述 | 
|---|---|---|---|---|---|
| mobileSystem | String | 是 |  |  | 手机系统 | 
| appVersion | String | 是 | app版本号 | ||
| type | Int | 是 | 枚举值:D_DEVICE(1, "设备问题"), D_AWSS(2, "配网问题"), D_OTHER(3, "其他问题"), A_BUG(101, "故障反馈"), A_FUNCTION(102, "功能建议"), A_OTHER(103, "其他问题"); | ||
| productKey | String | 是 | 产品key | ||
| content | String | 是 | 意见反馈内容 | ||
| iotId | String | 是 | 设备Id | ||
| mobileModel | String | 是 | 手机型号 | ||
| contact | String | 是 | 联系方式 | ||
| topic | String | 是 | 意见反馈主题 | ||
| devicename | String | 是 | 设备名称 | 
返回参数
| 参数 | 类型 | 必有 | 描述 | 
|---|---|---|---|
| data | Long | 是 | 意见反馈记录ID | 
请求示例
{
    "id": "1509086454180",
    "version": "1.0",
    "request": {
        "apiVer": "1.0.1",
        "iotToken": "token"
    },
    "params": {
             "appVersion": "10.0.0",
             "type": 1,
             "productKey": "a1OwEjYFJNb",
             "content": "重试多次配网失败",
             "mobileModel": "iPhoneX",
             "contact": "15066666666",
             "mobileSystem": "ios",
             "appVersion": "1.1",
             "iotId": "fy2Z1oZFWZQVii6kkFVM00101edf00",
             "topic": "设备无法配网",
             "devicename": "手环"
    }
}
正常返回示例
{
  "code": 200,
  "data": 3,
  "message": "success",
  "localizedMsg": null,
  "class": "com.aliyun.iotx.common.base.service.IoTxResult"
错误码
请参考公共错误码
继续意见反馈
定义描述
| path | 版本 | 描述 | 是否需要登陆 | 
|---|---|---|---|
| /feedback/reply/add | 1.0.1 | API描述:继续意见反馈 | 是 | 
请求参数
| 参数名 | 类型 | 是否必须 | 默认值 | 示例值 | 描述 | 
|---|---|---|---|---|---|
| type | Integer | 是 |  |  | 运营为1,用户为2 | 
| topicid | Long | 是 |  |  | 反馈意见ID | 
| content | String | 是 |  |  | 回复内容 | 
| mobileSystem | String | 是 | 手机型号 | ||
| mobileModel | String | 是 | 手机系统 | ||
| appVersion | String | 是 | app版本 | 
返回参数
| 参数 | 类型 | 必有 | 描述 | 
|---|---|---|---|
| data | Long | 是 | 继续意见反馈记录ID | 
请求示例
{
    "id": "1509086454180",
    "version": "1.0",
    "request": {
        "apiVer": "1.0.1",
        "iotToken": "token"
    },
    "params": {
             "type": 1,           
             "content": "家里用的wifi网络配网",
             "mobileModel": "iPhoneX",         
             "mobileSystem": "ios",
             "appVersion": "1.1",
             "topicId": 3         
    }
}
正常返回示例
{
  "code": 200,
  "data": 8,
  "message": "success",
  "localizedMsg": null,
  "class": "com.aliyun.iotx.common.base.service.IoTxResult"
}
错误码
请参考公共错误码
判断是否显示小红点
定义描述
| path | 版本 | 描述 | 是否需要用户身份的鉴权 | 
| /feedback/redpoint/get
           | 1.0.1 | 判断是否显示小红点
           | 是,客户端SDK需启用身份的鉴权 | 
请求参数
| 参数 | 类型 | 必填 | 描述 | 
|---|---|---|---|
返回参数
| 参数 | 类型 | 必有 | 描述 | 
| data | Boolean | 是 | 是否需要显示红点 true:需要显示 false:不需要显示 | 
请求示例
{
    "id": "1509086454180",
    "version": "1.0",
    "request": {
        "apiVer": "1.0.1",
        "iotToken": "token"
    },
    "params": {
    }
}
正常返回示例
{
  "code": 200,
  "data": true,
  "message": "success",
  "localizedMsg": null,
  "class": "com.aliyun.iotx.common.base.service.IoTxResult"
}
错误码
请参考公共错误码
根据用户信息查询意见反馈列表
定义描述
| path | 版本 | 描述 | 是否需要用户身份的鉴权 | 
|---|---|---|---|
| Path:/feedbacklist/querybyuid | 1.0.1 | 根据用户信息查询意见反馈列表 | 是,客户端SDK需启用身份的鉴权 | 
请求参数
| 参数 | 类型 | 必填 | 描述 | 
|---|---|---|---|
| pageSize | String | 是 | 每页条数 | 
| pageNo | String | 是 | 页码 | 
返回参数
| 参数 | 类型 | 必有 | 描述 | 
|---|---|---|---|
| data | FeedbackTopicDTO | 是 | 意见反馈主题DTO,参考上面DTO描述 | 
需要用到的字段说明如下:
| mobileSystem | String | 手机系统 | 
|---|---|---|
| appVersion | String | app版本号 | 
| type | Int | 枚举值:D_DEVICE(1, "设备问题"), D_AWSS(2, "配网问题"), D_OTHER(3, "其他问题"), A_BUG(101, "故障反馈"), A_FUNCTION(102, "功能建议"), A_OTHER(103, "其他问题"); | 
| productKey | String | 产品key | 
| content | String | 意见反馈内容 | 
| iotId | String | 设备Id | 
| mobileModel | String | 手机型号 | 
| contact | String | 联系方式 | 
| topic | String | 意见反馈主题 | 
| devicename | String | 设备名称 | 
| gmtModified | Date | 记录最近修改时间 | 
| gmtCreate | Date | 记录创建时间 | 
| productKey | String | 产品key | 
| id | Long | 意见反馈记录ID | 
| devicename | String | 设备名称 | 
| replyStatus | Int | 回复状态,0未读,1已读 | 
请求示例
{
    "id": "1509086454180",
    "version": "1.0",
    "request": {
        "apiVer": "1.0.1",
        "iotToken": "token"
    },
    "params": {       
            "pageNo": 1,
            "pageSize": 10,     
    }
}
正常返回示例
返回值示例:
{
  "code": 200,
  "data": {
    "total": 1,
    "data": [
      {
        "mobileSystem": "安卓",
        "appVersion": "1.0",
        "gmtModified": 1539423792000,
        "gmtLastFeedback": 1539423676000,
        "isolationId": "2",
        "type": 2,
        "productKey": "2",
        "gmtCreate": 1539423792000,
        "content": "2",
        "tags": "2",
        "uid": "2",
        "lastFeedback": "2",
        "iotId": "2",
        "gmtLastReply": 1539423676000,
        "mobileModel": "华为",
        "lastReply": "2",
        "contact": "138",
        "tenantId": "2",
        "replyStatus": 0,
        "topic": "2",
        "devicename": "2",
        "id": 3,
        "class": "com.aliyun.iotx.ilop.business.facade.dto.FeedbackTopicDTO",
        "feedbackStatus": 0
      }
    ],
    "pageSize": 20,
    "pageId": null,
    "class": "com.aliyun.iotx.lego.facade.result.PaginationResult"
  },
  "message": "success",
  "localizedMsg": null,
  "class": "com.aliyun.iotx.common.base.service.IoTxResult"
}
错误码
请参考公共错误码
根据意见反馈ID查询意见反馈信息
定义描述
| path | 版本 | 描述 | 是否需要用户身份的鉴权 | 
|---|---|---|---|
| Path:/feedback/getbytopicId | 1.0.1 | 根据意见反馈ID查询意见反馈信息 | 
,包括反馈的回复,以及再次反馈的信息 | 是,客户端SDK需启用身份的鉴权 |
请求参数
| 参数 | 类型 | 必填 | 描述 | 
|---|---|---|---|
| feedbackTopicId | |||
| String | |||
| 是 | |||
| 意见反馈Id | |||
返回参数
| 参数 | 类型 | 必有 | 描述 | 
|---|---|---|---|
| data | FeedbackDTO | 是 | 意见反馈主题DTO,参考上面DTO描述 | 
FeedbackDTO需要用到的字段说明如下:
| mobileSystem | String | 手机系统 | 
|---|---|---|
| appVersion | String | app版本号 | 
| type | Int | 枚举值:D_DEVICE(1, "设备问题"), D_AWSS(2, "配网问题"), D_OTHER(3, "其他问题"), A_BUG(101, "故障反馈"), A_FUNCTION(102, "功能建议"), A_OTHER(103, "其他问题"); | 
| productKey | String | 产品key | 
| content | String | 意见反馈内容 | 
| iotId | String | 设备Id | 
| mobileModel | String | 手机型号 | 
| contact | String | 联系方式 | 
| topic | String | 意见反馈主题 | 
| devicename | String | 设备名称 | 
| gmtModified | Date | 记录最近修改时间 | 
| gmtCreate | Date | 记录创建时间 | 
| productKey | String | 产品key | 
| id | Long | 意见反馈记录ID | 
| devicename | String | 设备名称 | 
| replyStatus | Int | 回复状态,0未读,1已读 | 
| feedBackReplyList | List | 意见反馈回复以及再次反馈记录列表 | 
FeedbackReplyDTO需要用到的字段说明如下
| id | Long | 回复以及再次反馈记录ID | 
|---|---|---|
| appVersion | String | app版本号 | 
| type | Int | 2 回复;1 继续反馈; | 
| content | String | 回复内容或者再次反馈内容 | 
| gmtCreate | Date | 回复或者再次反馈的时间 | 
请求示例
{
    "id": "1509086454180",
    "version": "1.0",
    "request": {
        "apiVer": "1.0.1",
        "iotToken": "token"
    },
    "params": {       
        "feedbackTopicId": 10     
    }
}
正常返回示例:
{
  "code": 200,
  "data": {
    "gmtModified": 1540460427000,
    "appVersion": "V1.2.0",
    "gmtLastFeedback": 1539683646000,
    "type": 103,
    "productKey": "",
    "content": "其他",
    "uid": "5021op82c076b73ffcad94dd0e1788f5424b5384",
    "gmtLastReply": 1540460402000,
    "mobileModel": "M3X",
    "contact": "18373637272",
    "tenantNickName": "iot开发管理者",
    "id": 10,
    "userNickName": "18042006420",
    "class": "com.aliyun.iotx.ilop.business.facade.dto.FeedBackDTO",
    "feedbackStatus": 0,
    "mobileSystem": "Android 6.0.1",
    "isolationId": "a103cg3XCLYnTrF8",
    "gmtCreate": 1539683646000,
    "tags": "",
    "lastFeedback": "其他",
    "iotId": "",
    "lastReply": "<script>alert(1);</script>",
    "tenantId": "D99AEB09DCDB4B25ACF008B2DCE1E313",
    "replyStatus": 0,
    "topic": "其他反馈",
    "devicename": "测试灯",
    "feedBackReplyList": [
      {
        "uid": "1584611943708270",
        "topicid": 10,
        "gmtModified": 1540460401000,
        "id": 446,
        "type": 2,
        "gmtCreate": 1540460401000,
        "class": "com.aliyun.iotx.ilop.business.facade.dto.FeedbackReplyDTO",
        "content": "<script>alert(1);</script>"
      },
      {
        "uid": "1584611943708270",
        "topicid": 10,
        "gmtModified": 1540460271000,
        "id": 445,
        "type": 2,
        "gmtCreate": 1540460271000,
        "class": "com.aliyun.iotx.ilop.business.facade.dto.FeedbackReplyDTO",
        "content": "春节将近"
      }
    ]
  },
  "message": "success",
  "localizedMsg": null,
  "class": "com.aliyun.iotx.common.base.service.IoTxResult"
}
错误码
请参考公共错误码
批量更新反馈回复记录状态为已读
定义描述
| path | 版本 | 描述 | 是否需要用户身份的鉴权 | 
|---|---|---|---|
| Path:/feedback/reply/status/readable/update | 1.0.1 | 批量更新反馈回复记录状态为已读 | 是,客户端SDK需启用身份的鉴权 | 
请求参数
| 参数 | 类型 | 必填 | 描述 | 
|---|---|---|---|
| feedbackTopicId | Long | 是 | 意见反馈记录ID | 
返回参数
| 参数 | 类型 | 必有 | 描述 | 
|---|---|---|---|
| data | Boolean | 是 | 状态更新是否成功,true为成功,false为失败 | 
请求示例
{
    "id": "1509086454180",
    "version": "1.0",
    "request": {
        "apiVer": "1.0.0",
        "iotToken": "token"
    },
    "params": {       
           "feedbackTopicId": 10                 
    }
}
正常返回示例
{
  "code": 200,
  "data": true,
  "message": "success",
  "localizedMsg": null,
  "class": "com.aliyun.iotx.common.base.service.IoTxResult"
}
错误码
请参考公共错误码