4. 消息中心API
API列表
| 编号 | API名称 | 路径 | 版本 |
|---|---|---|---|
| 4.1 | 消息列表 | /biz/mob/message/list | 1.0 |
| 4.2 | 消息详情 | /biz/mob/message/detail | 1.0 |
| 4.3 | 阅读消息 | /biz/mob/message/read | 1.0 |
| 4.4 | 删除消息 | /biz/mob/message/delete | 1.0 |
| 4.5 | 清空消息 | /biz/mob/message/clear | 1.0 |
| 4.6 | 车场服务消息推送 | /biz/mob/message/smart-parking/send | 1.0 |
| 4.7 | 商城消息推送 | /biz/mob/message/mall/send | 1.0 |
4.1: 消息列表
描述
请求信息
HTTP协议：HTTP,HTTPS
uri：/biz/mob/message/list
方法：POST
请求参数
| 名称 | 位置 | 类型 | 必填 | 描述 |
|---|---|---|---|---|
| category | BODY | STRING | 否 | Property=物业， System=系统通知 |
| subCategory | BODY | STRING | 否 | //信息子类型 |
| status | BODY | STRING | 否 | 阅读状态 0=未读，1=已读 |
| level | BODY | STRING | 否 | 级别 0=紧急，1=重要，2=一般 |
| pageNo | BODY | INTEGER | 否 | 默认1 |
| pageSize | BODY | INTEGER | 否 | 默认10 |
请求Body描述(非Form表单数据)
{
"pageNo":1,
"pageSize":10
}
返回信息
返回参数类型
JSON
返回结果示例
{
"code": 200,
"message": "success",
"data": {
"list"[{
"id":11212, //消息Id
"category":"Property", //Property=物业， System=系统通知
"subCategory":"family-apply", //信息子类型
"level":"1", //级别 0=紧急，1=重要，2=一般
"status":"0", //阅读状态 0=未读，1=已读
"readTime":"2019-11-11 12:01:01", //阅读时间
"title":"xxxx", //标题
"summary":"xxx", //摘要
"content":"xxxxx", //内容
"extAttr":"xxxxx", //扩展信息
"pushTime":"2019-11-11 12:01:01", //发布时间
"crateTime":"2019-11-11 12:01:01", //消息时间
"relationId": "xxxx" //消息关联的Id
}]
}
}
4.2: 消息详情
描述
请求信息
HTTP协议：HTTP,HTTPS
uri：/biz/mob/message/detail
方法：POST
请求参数
| 名称 | 位置 | 类型 | 必填 | 描述 |
|---|---|---|---|---|
| id | BODY | LONG | 是 | 消息ID |
请求Body描述(非Form表单数据)
{
"id":11212
}
返回信息
返回参数类型
JSON
返回结果示例
{
"code": 200,
"message": "success",
"data":{
"id":11212, //消息Id
"category":"Property", //Property=物业， System=系统通知
"subCategory":"family-apply", //信息子类型
"level":"1", //级别 0=紧急，1=重要，2=一般
"status":"0", //阅读状态 0=未读，1=已读
"readTime":"2019-11-11 12:01:01", //阅读时间
"title":"xxxx", //标题
"summary":"xxx", //摘要
"content":"xxxxx", //内容
"extAttr":"xxxxx", //扩展信息
"pushTime":"2019-11-11 12:01:01", //发布时间
"crateTime":"2019-11-11 12:01:01", //消息时间
"relationId": "xxxx" //消息关联的Id
}
}
4.3: 阅读消息
描述
请求信息
HTTP协议：HTTP,HTTPS
uri：/biz/mob/message/read
方法：POST
请求参数
| 名称 | 位置 | 类型 | 必填 | 描述 |
|---|---|---|---|---|
| id | BODY | LONG | 是 | 消息ID |
请求Body描述(非Form表单数据)
{
"id":20190902 //消息ID
}
返回信息
返回参数类型
JSON
返回结果示例
{
"code": 200,
"message": "success",
"data":{}
}
4.4: 删除消息
描述
请求信息
HTTP协议：HTTP,HTTPS
uri：/biz/mob/message/delete
方法：POST
请求参数
| 名称 | 位置 | 类型 | 必填 | 描述 |
|---|---|---|---|---|
| id | BODY | LONG | 是 | 消息ID |
请求Body描述(非Form表单数据)
{
"id":20190902 //消息ID
}
返回信息
返回参数类型
JSON
返回结果示例
{
"code": 200,
"message": "success",
"data":{}
}
4.5: 清空消息
描述
请求信息
HTTP协议：HTTP,HTTPS
uri：/biz/mob/message/clear
方法：POST
请求参数
| 名称 | 位置 | 类型 | 必填 | 描述 |
|---|---|---|---|---|
| category | BODY | STRING | 否 | 消息分类（Property=物业， System=系统通知） |
请求Body描述(非Form表单数据)
{
}
返回信息
返回参数类型
JSON
返回结果示例
{
"code": 200,
"message": "success",
"data":{}
}
4.6: 车场服务消息推送
描述
请求信息
HTTP协议：HTTP,HTTPS
uri：/biz/mob/message/smart-parking/send
方法：POST
请求参数
消息类别（category）定义：
- month-card-approve 月卡申请审批
- a. 需extAttr增加cardType表示月卡类型 :
- tempo-month-card=临时
- fixation-month-card=固定
- b. 需extAttr增加cardId 属性 月卡Id
- month-card-queue 月卡排队
- 需extAttr增加cardId 属性 月卡Id
- month-card-renewal 月卡续期
- 需extAttr增加cardId 属性 月卡Id
- month-card-cancel 月卡注销
- 需extAttr增加cardId 属性 月卡Id
- month-card-wait-cancel 月卡待注销
- 需extAttr增加cardId 属性 月卡Id
- new_car-approve 新增车辆审核
- car-appeal 车辆申诉
- monthly-car-audit-pass 月卡车辆审核通过
- monthly-car-audit-reject月卡车辆审核拒绝
- monthly-parkinglot-audit-pass月卡车位审核通过的
- monthly-parkinglot-audit-reject月卡车位审核拒绝
- monthly-payment 月卡缴费
- valet-payment 代客缴费
| 名称 | 位置 | 类型 | 必填 | 描述 |
|---|---|---|---|---|
| mobile | BODY | STRING | 否 | 用户的手机号码（和userId 二选一） |
| userId | BODY | STRING | 否 | APP用户ID（和mobile 二选一） |
| category | BODY | STRING | 是 | 消息类别(month-card-approve=月卡审核成功) |
| level | BODY | STRING | 否 | 级别 (0=紧急，1=重要，2=一般) |
| title | BODY | STRING | 是 | 消息标题 |
| content | BODY | STRING | 是 | 消息内容 |
| extAttr | BODY | STRING | 否 | JSON字符串 |
| toAssistant | BODY | STRING | 否 | 是否推送给管家（0=否，1=是） |
| communityId | BODY | STRING | 否 | 项目Id（推送管家时，必填） |
请求Body描述(非Form表单数据)
// 临时月卡审批消息
{
"mobile":"13800138000",
"category": "month-card-approve",
"level":"2",
"title":"车场服务",
"content": "您申请的月卡已经完成审核，请及时处理",
"extAttr": "{\"cardId\":\"121212\",\"cardType\":\"tempo-month-card\"}"
}
返回信息
返回参数类型
JSON
返回结果示例
{
"code": 200,
"message": "success",
"data":{}
}
4.7: 商城消息推送
描述
请求信息
HTTP协议：HTTP,HTTPS
uri：/biz/mob/message/mall/send
方法：POST
请求参数
消息类别（category）定义：
- order 订单类消息
| 名称 | 位置 | 类型 | 必填 | 描述 |
|---|---|---|---|---|
| userId | BODY | STRING | 是 | APP用户ID |
| category | BODY | STRING | 是 | 消息类别(order=订单类消息) |
| level | BODY | STRING | 否 | 级别 (0=紧急，1=重要，2=一般) |
| title | BODY | STRING | 是 | 消息标题 |
| content | BODY | STRING | 是 | 消息内容 |
| extAttr | BODY | STRING | 否 | 扩展属性 JSON字符串 |
请求Body描述(非Form表单数据)
{
"userId": 123,
"category": "order",
"level":"2",
"title":"商城订单消息标题",
"content": "消息内容",
"extAttr": "{\"key1\":\"value1\",\"key2\":\"value2\"}"
}
返回信息
返回参数类型
JSON
返回结果示例
{
"code": 200,
"message": "success",
"data":{}
}
错误码列表(21001-21999)
| 错误码 | 错误信息 | 描述 |
|---|---|---|
| 21001 | id is not found | 找不到消息 |
| 公共错误码 | -- | 所有API公用的错误码，请参照《 公共错误码 》 |