# 推送商户App通知
# 简要描述
- 业务系统用 askKey 调用(与其它开放 API 相同,可走验签 / 加解密)
- 付费:扣调用方商户额度(非会员每日 100 / 普通会员 1000 / Pro 5000 + 加量包),商户买单
- body 可选 pushKey:指定接收设备(须属于本商户);不传则推给 askKey 对应商户
- pushKey 只放在请求体,不要放 Header
- 商户需在 App「通知设置」绑定设备并开启接收
# 请求URL
/api/pushNotify
# 请求头
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| Content-Type | 是 | string | application/x-www-form-urlencoded 或 application/json |
| askKey | 是 | string | 应用令牌 |
| sign | 否 | string | 开启验签时必传 |
| time | 否 | string | 开启验签时必传 |
| nonce | 否 | string | V3 验签时必传 |
# 请求方式
- post
# 参数
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| title | 是 | string | 消息标题 |
| content | 是 | string | 消息正文(也可用 body) |
| pushKey | 否 | string | 指定接收方;不传则推给本商户;须属于当前 askKey 商户 |
| msgType | 否 | string | text(默认)或 image_text |
| imageUrl | 条件 | string | msgType=image_text 时必填,http/https |
| linkUrl | 否 | string | 点击跳转链接,http/https(也可用 url) |
# 请求示例
推给商户自己:
{
"title": "订单提醒",
"content": "您有新的订单待处理",
"msgType": "text"
}
1
2
3
4
5
2
3
4
5
指定 pushKey(须为本商户):
{
"title": "订单提醒",
"content": "您有新的订单待处理",
"pushKey": "pk_xxxxxxxx",
"msgType": "text"
}
1
2
3
4
5
6
2
3
4
5
6
# 返回示例
{
"code": "200",
"message": "",
"status": true,
"data": null,
"pc": null
}
1
2
3
4
5
6
7
2
3
4
5
6
7
# 备注
- 额度用尽、未绑设备、已关闭推送、pushKey 不属于本商户时会返回对应错误
- 成功后写入通知历史,并异步下发到目标设备
- 更多返回错误代码请查看 错误代码参考