消息中心

更新时间:2024-06-05 03:15:12下载pdf

API 列表

action 说明
message.checkNew 查询用户是否收到新信息
message.alarmGroupList 查询告警汇总消息
message.alarmList 查询告警消息详细列表
message.homeList 查询家庭消息列表
message.notificationList 查询通知消息列表
message.deleteAlarmGroup 删除告警汇总消息
message.deleteById 删除消息详情
message.readAlarmGroup 设置告警汇总消息已读

查询用户是否收到新信息

接口说明

根据用户 ID,获取是否收到三种类型的新消息。

接口地址

action: message.checkNew

请求参数

参数名 参数类型 说明 是否必填
uid String 用户唯一 ID

响应参数

参数名 类型 说明
code Integer 响应码(详情见 错误码
success Boolean 是否成功:
  • true:成功
  • false:失败
  • msg String 请求失败的信息,成功为空
    result Object 返回结果:
  • alarm:告警类
  • home:家庭类
  • notification:通知类
  • true:有新消息
  • false:无新消息
  • 请求示例

    {
      "action": "message.checkNew",
      "params": {
        "uid": "ay15742xxxxx"
      }
    }
    

    响应示例

    {
        "success":true,
        "t":1540799929837,
        "result":{
          "alarm":false,
          "home":true,
          "notification":false
        }
    }
    

    错误码

    以下为该接口常见的业务异常。更多的异常错误,请参见 全局错误码

    错误码 说明
    500 系统错误
    1106 权限非法

    查询告警汇总消息

    接口说明

    支持分页获取指定用户的告警汇总消息列表。一个告警汇总消息是一个设备或者一个统计模型的汇总,需要再通过获取告警消息详细列表接口获得详细的告警消息。

    接口地址

    action: message.alarmGroupList
    

    请求参数

    参数名 参数类型 说明 是否必填
    uid String 用户唯一 ID
    time_zone_id String 时区 ID。仅只支持 “Asia/Shanghai” (中国区)
    page_no Integer 页数,从 1 开始,默认第 1 页
    page_size Integer 每页数量,默认 15 条,最大值 100 条

    响应参数

    参数名 类型 说明
    code Integer 响应码(详情见 错误码
    success Boolean 是否成功:
  • true:成功
  • false:失败
  • msg String 请求失败的信息,成功为空
    result Object 返回结果

    result 说明

    参数名 类型 说明
    messages List 告警汇总消息列表
    page_no Integer 页数
    total_count Integer 总条数

    messages 说明

    参数名 类型 说明
    id Long 告警汇总 ID
    date_time String 告警时间
    read_status Integer 消息读取状态:
  • 0:未读
  • 1:已读
  • home_id Integer 所在家庭 ID
    home_name String 所在家庭名称
    icon String 推荐图标
    message_content String 告警消息内容
    message_title String 告警消息标题
    message_group_id String 告警汇总资源 ID。用于后续查询告警消息明细列表和删除告警汇总消息

    请求示例

    {
      "action": "message.alarmGroupList",
      "params": {
        "uid": "ay1578921339xxxxxxxx",
        "time_zone_id": "Asia/Shanghai"
      }
    }
    

    响应示例

    {
        "success": true,
        "t":1540799929837,
        "result": {
            "messages":[
            {
                "id":556446,
                "date_time":"2020-8-11 19:59",
                "read_status":0,
                "home_id":10694416,
                "home_name":"我的测试家庭",
                "icon":"https://images.tuyacn.com/smart/icon/axxxxxxlV6/5yyyyyyyy42dd.png",
                "message_content":"测试亮度告警消息推送",
                "message_group_id":"vdexxxxxx6223",
                "message_title":"测试亮度告警消息推送"
            },
            {
                "id":547450,
                "date_time":"2020-8-10 05:59",
                "read_status":0,
                "home_id":10694416,
                "home_name":"我的测试家庭",
                "icon":"https://airtake.cos.ap-shanghai.test.com/misc/test.png",
                "message_content":"**测试灯的自动化**中有任务未触发",
                "message_group_id":"Vhh00osEGkmdF8RS",
                "message_title":"自动化消息提醒"
            }
        ],
        "pageNo":1,
        "totalCount":2
        }
    }
    

    错误码

    以下为该接口常见的业务异常。更多的异常错误,请参见 全局错误码

    错误码 说明
    500 系统错误
    1106 权限非法
    1109 参数非法

    查询告警消息详细列表

    接口说明

    根据告警汇总消息,获取告警的明细列表数据。

    接口地址

    action: message.alarmList
    

    请求参数

    参数名 类型 参数类型 说明 是否必填
    uid String URI 用户唯一 ID
    message_group_id String URI 告警汇总资源 ID
    time_zone_id String 时区 ID。仅只支持 “Asia/Shanghai” (中国区)
    page_no Integer URL 页数,从 1 开始,默认第 1 页
    page_size Integer URL 每页数量,默认 15 条,最大值 100 条

    响应参数

    参数名 类型 说明
    code Integer 响应码(详情见 错误码
    success Boolean 是否成功:
  • true:成功
  • false:失败
  • msg String 请求失败的信息,成功为空
    result Object 返回结果

    result 说明

    参数名 类型 说明
    messages List 告警消息列表
    page_no Integer 页数
    total_count Integer 总条数

    messages 说明

    参数名 类型 说明
    id Long 告警消息 ID
    date_time String 告警时间
    icon String 推荐图标
    message_content String 告警消息内容
    message_title String 告警消息标题
    message_source_id String 触发告警消息来源 ID

    请求示例

    {
      "action": "message.alarmList",
      "params": {
        "uid": "ay1578921339xxxxxxxx",
        "message_group_id": "vdexxxxxx6223",
        "time_zone_id": "Asia/Shanghai"
      }
    }
    

    响应示例

    {
        "success": true,
        "t":1540799929837,
        "result": {
            "messages":[
            {
                "id": 1491082638,
                "date_time":"2020-8-11 19:59",
                "icon":"https://images.tuyacn.com/smart/icon/axxxxxxlV6/5yyyyyyyy42dd.png",
                "message_content":"测试亮度告警消息推送",
                "message_title":"测试亮度告警消息推送",
                "message_source_id": "vdexxxxxx6223"
            },
              {
                "id": 1491079892,
                "date_time":"2020-8-11 19:58",
                "icon":"https://images.tuyacn.com/smart/icon/axxxxxxlV6/5yyyyyyyy42dd.png",
                "message_content":"测试亮度告警消息推送",
                "message_title":"测试亮度告警消息推送",
                "message_source_id": "vdexxxxxx6223"
            }
        ],
        "pageNo":1,
        "totalCount":2
        }
    }
    

    错误码

    以下为该接口常见的业务异常。更多的异常错误,请参见 全局错误码

    错误码 说明
    500 系统错误
    1106 权限非法
    1109 参数非法

    查询家庭消息列表

    接口说明

    查询指定用户的家庭类消息。

    接口地址

    action: message.homeList
    

    请求参数

    参数名 类型 参数类型 说明 是否必填
    uid String URI 用户唯一 ID
    time_zone_id String 时区 ID。仅只支持 “Asia/Shanghai” (中国区)
    page_no Integer URL 页数,从 1 开始,默认第 1 页
    page_size Integer URL 每页数量,默认 15 条,最大值 100 条

    响应参数

    参数名 类型 说明
    code Integer 响应码(详情见 错误码
    success Boolean 是否成功:
  • true:成功
  • false:失败
  • msg String 请求失败的信息,成功为空
    result Object 返回结果

    result 说明

    参数名 类型 说明
    messages List 家庭消息和通知消息的列表
    page_no Integer 页数
    total_count Integer 总条数

    messages 说明

    参数名 类型 说明
    id Long 消息 ID
    date_time String 消息时间
    icon String 推荐图标
    message_content String 消息内容
    message_title String 消息标题
    message_source_id String 消息资源 ID

    请求示例

    {
      "action": "message.homeList",
      "params": {
        "uid": "ay1578xxxxxxxx",
        "time_zone_id": "Asia/Shanghai"
      }
    }
    

    响应示例

    {
        "success": true,
        "t":1540799929837,
        "result": {
            "messages":[
            {
                "id": 1463072653,
                "date_time":"2020-8-6 21:00",
                "icon":"https://airtake.cos.ap-shanghai.test.com/misc/test.png",
                "message_content":"**我的测试家庭**中添加的红外空调可以使用了",
                "message_title":"添加设备",
                "message_source_id": "6c975b3013aa413cd1n9bo"
            },
              {
                "id": 1503785831,
                "date_time":"2020-8-4 22:17",
                "icon":"https://airtake.cos.ap-shanghai.test.com/misc/test.png",
                "message_content":"XXXXXX 邀请您加入家庭**我的测试家庭**,在** 我的 > 家庭管理 **中接受邀请后即可加入",
                "message_title":"邀请成为家庭成员",
                "message_source_id": "ay1578921339405Lr3au"
            }
        ],
        "pageNo":1,
        "totalCount":2
        }
    }
    

    错误码

    以下为该接口常见的业务异常。更多的异常错误,请参见 全局错误码

    错误码 说明
    500 系统错误
    1106 权限非法
    1109 参数非法

    查询通知消息列表

    接口说明

    查询指定用户的通知类消息。

    接口地址

    action: message.notificationList
    

    请求参数

    参数名 类型 参数类型 说明 是否必填
    uid String URI 用户唯一 ID
    time_zone_id String 时区 ID。仅只支持 “Asia/Shanghai” (中国区)
    page_no Integer URL 页数,从 1 开始,默认第 1 页
    page_size Integer URL 每页数量,默认 15 条,最大值 100 条

    响应参数

    参数名 类型 说明
    code Integer 响应码(详情见 错误码
    success Boolean 是否成功:
  • true:成功
  • false:失败
  • msg String 请求失败的信息,成功为空
    result Object 返回结果

    result 说明

    参数名 类型 说明
    messages List 家庭消息和通知消息的列表
    page_no Integer 页数
    total_count Integer 总条数

    messages 说明

    参数名 类型 说明
    id Long 消息 ID
    date_time String 消息时间
    icon String 推荐图标
    message_content String 消息内容
    message_title String 消息标题
    message_source_id String 消息资源 ID。用户反馈的进度消息时有返回值

    请求示例

    {
      "action": "message.notificationList",
      "params": {
        "uid": "ay1578xxxxxxxx",
        "time_zone_id": "Asia/Shanghai"
      }
    }
    

    响应示例

    {
        "success": true,
        "t":1540799929837,
        "result": {
            "messages":[
            {
                "id": 1491386944,
                "date_time":"2020-8-11 21:02",
                "icon":"https://airtake.cos.ap-shanghai.test.com/misc/test.png",
                "message_content":"您好,您提交的反馈小二已回复,请您及时查看。",
                "message_title":"反馈状态更新",
                "message_source_id": "FCN202008119to22br7z9xi"
            },
              {
                "id": 1452057379,
                "date_time":"2020-8-4 22:17",
                "icon":"https://airtake.cos.ap-shanghai.test.com/misc/test.png",
                "message_content":"此账号刚刚在一个新手机上登录,型号:XXXX。若非本人操作,建议马上修改登录密码以防账号被盗用",
                "message_title":"通知"
            }
        ],
        "pageNo":1,
        "totalCount":2
        }
    }
    

    错误码

    以下为该接口常见的业务异常。更多的异常错误,请参见 全局错误码

    错误码 说明
    500 系统错误
    1106 权限非法
    1109 参数非法

    删除告警汇总消息

    接口说明

    删除告警汇总消息。

    接口地址

    action: message.deleteAlarmGroup
    

    请求参数

    参数名 类型 参数类型 说明 是否必填
    uid String URI 用户唯一 ID
    message_group_ids String URL 告警汇总资源 ID,可以传多个,使用英文逗号(,)组合。上限 100 个

    响应参数

    参数名 类型 说明
    code Integer 响应码(详情见 错误码
    success Boolean 是否成功:
  • true:成功
  • false:失败
  • msg String 请求失败的信息,成功为空
    result Boolean 结果

    请求示例

    {
      "action": "message.deleteAlarmGroup",
      "params": {
        "uid": "ay15742xxxxx",
        "message_group_ids": "Vhh00osEGkmdF8RS,vdexxxxxx6223"
      }
    }
    

    响应示例

    {
        "success":true,
        "t":1540799929837,
        "result":true
    }
    

    错误码

    以下为该接口常见的业务异常。更多的异常错误,请参见 全局错误码

    错误码 说明
    500 系统错误
    1106 权限非法
    1109 参数非法

    删除消息

    接口说明

    删除告警详细、家庭和通知的消息。

    接口地址

    action: message.deleteById
    

    请求参数

    参数名 类型 参数类型 说明 是否必填
    uid String URI 用户唯一 ID
    ids String URL 消息 ID,可以传多个,使用英文逗号(,)组合。上限 100 个

    响应参数

    参数名 类型 说明
    code Integer 响应码(详情见 错误码
    success Boolean 是否成功:
  • true:成功
  • false:失败
  • msg String 请求失败的信息,成功为空
    result Boolean 返回结果

    请求示例

    {
      "action": "message.deleteAlarmGroup",
      "params": {
        "uid": "ay15742xxxxx",
        "ids": "1491386944,1452057379"
      }
    }
    

    响应示例

    {
        "success":true,
        "t":1540799929837,
        "result":true
    }
    

    错误码

    以下为该接口常见的业务异常。更多的异常错误,请参见 全局错误码

    错误码 说明
    500 系统错误
    1106 权限非法
    1109 参数非法

    告警汇总消息已读

    接口说明

    设置告警汇总消息的已读状态。

    接口地址

    action: message.readAlarmGroup
    

    请求参数

    参数名 类型 参数类型 说明 是否必填
    uid String URI 用户唯一 ID
    ids String URL 告警汇总 ID,可以传多个,使用英文逗号(,)组合。上限 100 个

    响应参数

    参数名 类型 说明
    code Integer 响应码(详情见 错误码
    success Boolean 是否成功:
  • true:成功
  • false:失败
  • msg String 请求失败的信息,成功为空
    result Object 分享结果

    请求示例

    {
      "action": "message.deleteAlarmGroup",
      "params": {
        "uid": "ay15742xxxxx",
        "ids": "556446,547450"
      }
    }
    

    响应示例

    {
        "success":true,
        "t":1540799929837,
        "result":true
    }
    

    错误码

    以下为该接口常见的业务异常。更多的异常错误,请参见 全局错误码

    错误码 说明
    500 系统错误
    1106 权限非法