...
consumes ["application/json"]
produces ["*/*"]
入参说明
| 参数名称 | 参数说明 | 请求类型 | 参数类型 | 描述 |
|---|---|---|---|---|
| signature | 接口签名 | header | string | 可用于第三方鉴权，加密方式参考签名鉴权 |
nonce | 6位随机字符串 | body | string | |
| timestamp | 时间戳 | body | string | 当前时间戳（毫秒） |
| userInfo | 用户身份 | body |
| List<userInfo> | "userInfo":[{ },{ "identityType":"phone", //身份类型 }] | |||
| pushTitle | 通知标题 | body | string | |
| content | 通知的消息内容 | body | string | |
| pic | 图片地址 | body | string | 可为空 |
| toUrl | 点通知后的跳转地址 | body | string | 可为空，url携带参数pageType=app时表示跳转App原生页面；pageType=h5时表示跳转App内嵌H5页面 |
| msgId | 消息Id | body | long |
| 当响应是异步时会传递，同步则不会传 | ||||
| extras | 额外参数 | body | map | 可自定义 key/value 信息，以供业务使用 |
paramInfo | 自定义参数 | body | List<ParamInfo> | "paramInfo":[{ "paramKey":"en", //对应系统集成的英文key "paramValue":"值" // 如果是多项就是逗号分隔 },{ "paramKey":"en", //对应系统集成的英文key "paramValue":"值" // 如果是多项就是逗号分隔 }] |
请求示例
| 无格式 |
|---|
{
"nonce":"XZTEKT",
"timestamp":"1638011171354",
"userInfo":[{
"identityType":"openid",
"identityValue":"obeXk1E7Vlt4YH5Sy1ILz_WR8lbN"
}],
"paramInfo":[{
"paramKey":"en", //对应系统集成的英文key
"paramValue":"value" // 如果是多项就是逗号分隔
}],
"pushTitle":"我是标题",
"content":"我是内容",
"toUrl":null,
"msgId":914230644929216512,
"pic":null
} |
4、返回触达结果
1） 同步返回
| 参数名称 | 参数类型 | 是否必须 | 描述 |
|---|---|---|---|
| code | string | true | 请求码，200-请求成功，其他为请求失败 |
| result | int | true | 触达结果，1为触达成功，0为触达失败 |
| timestamp | long | false | 时间戳格式，触达用户的时间 |
| msg | string | true | 触达失败原因，客户回调兔展接口返回，当触达用户失败时（即code不等于200时）需要填写 |
2) 异步返回 调用工作台接口
接口地址 /api/integrate/callback/getMessage
...
接口描述 企业级接口，hearer必须携带X-Token
入参说明
| 参数名称 | 参数说明 | 请求类型 | 参数类型 | 是否必须 |
|---|---|---|---|---|
| X-Token | 自建应用访问token | header | true | true |
msgId | 消息Id | body | long | true |
| result | 触达结果 | body | int | true |
| timestamp | 时间戳，触达用户的时间 | body | long | false |
| msg | 触达失败原因 | body | string | false |