5. 推送中台

API列表

编号 API名称 路径 版本
5.1 访客预约短信发送 /inner/push/sms/appointment 1.0
5.2 智慧门禁消息推送 /inner/message/smart-access/send 1.0
5.3 员工端通用消息推送 /inner/message/assistant/common/send 1.0
5.4 待办中心操作状态推送 /inner/cmty/workbench/todo/syncDoStatus 1.0
5.5 巡更任务提醒推送 /inner/message/smart-patrol-task/send 1.0
5.6 代客缴费短信发送 /mid/push/sms/smart-parking/payment 1.0
5.7 APP邀请下载短信发送 /mid/push/sms/download/app 1.0
5.8 推送注册 /mid/push/register 1.0
5.9 推送注销 /mid/push/logout 1.0
5.10 消息推送 /mid/push/send 1.0
5.11 批量消息推送 /inner/push/message/common/send/batch 1.0

API调用

5.1: 访客预约短信发送 /inner/push/sms/appointment

描述

使用springCloud调用服务 服务名:mideazy-push-mid

请求信息

HTTP协议:HTTP,HTTPS

方法:POST

请求参数

名称 位置 类型 必填 描述
mobile params STRING 手机号码
communityId params STRING 项目Id
visitorId params STRING 访客Id

请求地址样例

/inner/push/sms/appointment?mobile=13533402682&communityId=610&visitorId=1001

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 响应码标识
message 顶层 STRING 响应消息文本
data 顶层 JSONObject 响应数据对象
返回结果示例
{
  "code": "200",
  "message": "success",
  "data": {
  }
}

5.2: 智慧门禁消息推送

/inner/message/smart-access/send

描述

使用springCloud调用服务 服务名:mideazy-message-biz

请求信息

HTTP协议:HTTPS 方法:POST

请求参数

名称 位置 类型 必填 描述
mobile BODY STRING 业主的手机号码(和访问员工的员工账号 二选一)
jobNumber BODY STRING 被访问员工的员工账号(和业主的手机号码(二选一)例:zhangs1
projectId BODY STRING 业主的小区
visitorId BODY STRING 访问人Id
flag BODY STRING 是否超时标识(0=未超时,1=超时)

请求Body描述(非Form表单数据)

{
    "mobile":"13800138000",
    "projectId": "121212",
    "visitorId":"12121",
    "flag":"0"
}

返回信息

返回参数类型

JSON

返回结果示例
{
    "code": 200,
    "message": "success",
    "data":{}
}

5.3: 员工端通用消息推送

/inner/message/assistant/common/send

描述

使用springCloud调用服务 服务名:mideazy-message-biz

请求信息

HTTP协议:HTTPS 方法:POST

请求参数

名称 位置 类型 必填 描述
userAccount BODY STRING 员工账号
category BODY STRING 消息类型
title BODY STRING 消息标题
content BODY STRING 消息内容
extAttr BODY JSONObject 消息扩展属性

请求Body描述(非Form表单数据)

{
    "userAccount":"wujy25",
    "category": "121212",
    "title":"xxxxx标题",
    "content":"xxx内容"
}

返回信息

返回参数类型

JSON

返回结果示例
{
    "code": 200,
    "message": "success",
    "data":{}
}

5.4: 待办中心操作状态推送

描述

使用springCloud调用服务 服务名:mideazy-workbench-biz

请求信息

HTTP协议:HTTP,HTTPS

uri:inner/cmty/workbench/todo/syncDoStatus

方法:POST

请求参数

名称 位置 类型 必填 描述
category BODY String 类型 访客预约:visitor-appt-apply
soId BODY String 同步项ID 如果是访客预约为访客ID
doStatus BODY Integer 同步状态 如果是访客预约为访客状态(state)
{
   "category":"visitor-appt-apply",
    "soId":"5b5dc680d1be5aeb160ca226d2",
    "doStatus":6
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 INTEGER 响应码
message 顶层 STRING 响应信息

返回结果示例

{
  "code": 200,
  "message": "成功"
}

5.5: 巡更任务提醒推送

描述

使用springCloud调用服务 服务名:mideazy-message-biz

描述

HTTP协议:HTTP,HTTPS

uri:/inner/message/smart-patrol-task/send

方法:POST

请求参数

名称 位置 类型 必填 描述
taskId BODY String 巡更任务Id
taskName BODY String 巡更任务名称
taskType BODY String 巡更任务类型(视频巡更=video, 图片巡更=photo)
repeatType BODY String 重复类型(1固定日 2频次)
userIds BODY JSONArray 提醒用户ID列表
{
    "taskId":"visitor-appt-apply",
    "taskName":"5b5dc680d1be5aeb160ca226d2",
    "taskType": "video",
    "repeatType":"1",
    "userIds": ["120004bb235c3600", "120004bb2d57c000"]
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 INTEGER 响应码
message 顶层 STRING 响应信息

返回结果示例

{
  "code": 200,
  "message": "成功"
}

5.6: 代客缴费短信发送

描述

代客缴费短信发送

描述

HTTP协议:HTTP,HTTPS

uri:/mid/push/sms/smart-parking/payment

方法:POST

请求参数

名称 位置 类型 必填 描述
mobile BODY String 访客手机号码(接收短信的手机号码)
visitorName BODY String 访客名称
communityName BODY String 项目小区名称
payer BODY String 缴费客户姓名
{
    "mobile":"130xxxxx",
    "visitorName":"张三",
    "communityName": "美的广场",
    "payer":"李四"
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 INTEGER 响应码
message 顶层 STRING 响应信息

返回结果示例

{
  "code": 200,
  "message": "成功"
}

5.7: APP邀请下载短信发送

描述

HTTP协议:HTTP,HTTPS

uri:/mid/push/sms/download/app

方法:POST

请求参数

名称 位置 类型 必填 描述
mobile BODY String 手机号码(接收短信的手机号码)
userName BODY String 用户名称
familyName BODY String 家庭名称
{
    "mobile":"130xxxxx",
    "userName":"张三",
    "familyName": "美的广场"
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 INTEGER 响应码
message 顶层 STRING 响应信息

返回结果示例

{
  "code": 200,
  "message": "成功"
}

5.8: 推送注册

描述

HTTP协议:HTTP,HTTPS

uri:/mid/push/register

方法:POST

请求参数

名称 位置 类型 必填 描述
userId HEZDER String 用户ID
userName BODY String 用户名称
providerNo BODY String 服务提供商
appDeviceOs BODY String 操作系统:iOS/Android
appDeviceId BODY String 设备ID
appDeviceToken BODY String 设备Token
{
    "providerNo":"AliyunPush",
    "userName":"xxxx",
    "appDeviceOs": "iOS",
    "appDeviceId": "xxx",
    "appDeviceToken": "xxx",
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 INTEGER 响应码
message 顶层 STRING 响应信息

返回结果示例

{
  "code": 200,
  "message": "成功"
}

5.9: 推送注销

描述

HTTP协议:HTTP,HTTPS

uri:/mid/push/logout

方法:POST

请求参数

名称 位置 类型 必填 描述
userId HEZDER String 用户ID
userName BODY String 用户名称
{
    "providerNo":"AliyunPush",
    "userName":"xxxx"
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 INTEGER 响应码
message 顶层 STRING 响应信息

返回结果示例

{
  "code": 200,
  "message": "成功"
}

5.10: 推送消息

描述

描述

HTTP协议:HTTP,HTTPS

uri:/mid/push/send

方法:POST

请求参数

名称 位置 类型 必填 描述
userId HEZDER String 用户ID
title BODY String 推送标题
content BODY String 推送内容
extAttr BODY String 附加信息
pushType BODY String 推送类型:{MESSAGE:表示消息,NOTICE:表示通知}
{
    "title":"您有一个消息",
    "content":"xxxx",
    "extAttr": "{}",
    "pushType": "NOTICE"
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 INTEGER 响应码
message 顶层 STRING 响应信息

返回结果示例

{
  "code": 200,
  "message": "成功"
}

5.11: 批量推送消息

描述

HTTP协议:HTTP,HTTPS

uri:/inner/push/message/common/send/batch

方法:POST

请求参数

名称 位置 类型 必填 描述
userIds PARAM Array 用户ID列表
title PARAM String 推送标题
content PARAM String 推送内容
extAttr PARAM String 附加信息
pushType PARAM String 推送类型:{MESSAGE:表示消息,NOTICE:表示通知}
    "title":"您有一个消息"
    "content":"xxxx"
    "extAttr": "{}"
    "pushType": "NOTICE"

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 INTEGER 响应码
message 顶层 STRING 响应信息

返回结果示例

{
  "code": 200,
  "message": "成功"
}

错误码列表(2001-2099)

错误码 错误信息 描述
2001 the sms send fail 短信发送失败
公共错误码 -- 所有API公用的错误码,请参照《 公共错误码
Copyright © www.remacsmart.com/ 2021 all right reserved,powered by Gitbook该文件修订时间: 2022-02-12 13:44:25

results matching ""

    No results matching ""