消息推送
1. 前言:
2. 交互时序图:
3. 请求场景:
消息推送
4. 接口要求:
使用来伊份openapi加密协议进行加密请求
5. 接口标准
5.1 基本信息
| 描述 | 值 |
|---|---|
| 服务名称 | supplier-app-api |
| URL | 测试环境:https://openapi.test.laiyifen.com/supplier-app-api/v1/supplier/notify 生产环境:https://openapi.laiyifen.com/supplier-app-api/v1/supplier/notify |
| 认证方式 | 令牌 |
| 请求方式 | HTTP(POST) |
| 功能描述(适用场景) | 消息推送 |
5.2 请求头公共参数 (Header)
| 参数名字 | 参数类型 | 是否必须 | 说明 |
|---|---|---|---|
| X-Co-Client | String | 是 | 客户端Id(来伊份提供) |
| X-Co-Sign | String | 是 | 签名 |
| X-Co-TimeStamp | String | 是 | 签名时间戳 |
5.3 入参 Body
| 参数名字 | 参数类型 | 是否必须 | 说明 |
|---|---|---|---|
| lyfuid | String | 是 | 第三方应用用户授权id |
| messageDetaiUrl | String | 是 | 消息点击跳转url |
| messageImageUrl | String | 是 | 消息图片url |
| messageInfo | String | 是 | 消息内容 |
| messageOrigin | String | 是 | 消息的来源,如来养鸭 |
| messageTitle | String | 是 | 消息标题 |
| messageType | String | 是 | 消息类型,固定值:100 |
| imAccount | String | 是 | 推送账号 |
5.4 入参示例
?lyfuid=302179DCC2F12D929080F6CBD9610F5C&page=1&pageSize=10
5.5 返回统一参数
| 参数名字 | 参数类型 | 是否必须 | 说明 |
|---|---|---|---|
| code | String | 是 | 返回请求业务代码 |
| msg | String | 是 | 返回信息描述 |
| data | Boolean | 是 | 返回参数(true/false) |
5.6 返回参数Data
5.7 返回示例
{
"code": "0",
"msg": "success",
"data": true
}