批量单推 API（VIP）

功能说明

如果您在给每个用户的推送内容都不同的情况下，可以使用此接口。

如需要开通此接口，请联系：商务客服

调用地址

RegID 方式

POST https://api.jpush.cn/v3/push/batch/regid/single

Alias 方式

POST https://api.jpush.cn/v3/push/batch/alias/single

调用验证

详情参见 REST API 概述的鉴权方式说明。

调用说明

使用此接口前，您需要配合使用获取推送唯一标识符接口提前获取到 cid 池，获取时 type=push 或者不传递 type 值；获取到 cid 值后，传递参数格式如下：

{"pushlist":{ "cid 值 1":{...}, "cid 值 2":{...}, ... }}

          {"pushlist":{
    "cid 值 1":{...},
    "cid 值 2":{...},
    ...
}}

此代码块在浮窗中显示

请求示例

请求报头

> POST /v3/push/batch/regid/single HTTP/1.1 > Authorization: Basic N2Q0MzFlNDJkZmE2YTZkNjkzYWMyZDA0OjVlOTg3YWM2ZDJlMDRkOTVhOWQ4ZjBkMQ==

          > POST /v3/push/batch/regid/single HTTP/1.1
> Authorization: Basic N2Q0MzFlNDJkZmE2YTZkNjkzYWMyZDA0OjVlOTg3YWM2ZDJlMDRkOTVhOWQ4ZjBkMQ==

此代码块在浮窗中显示

或者

> POST /v3/push/batch/alias/single HTTP/1.1 > Authorization: Basic N2Q0MzFlNDJkZmE2YTZkNjkzYWMyZDA0OjVlOTg3YWM2ZDJlMDRkOTVhOWQ4ZjBkMQ==

          > POST /v3/push/batch/alias/single HTTP/1.1
> Authorization: Basic N2Q0MzFlNDJkZmE2YTZkNjkzYWMyZDA0OjVlOTg3YWM2ZDJlMDRkOTVhOWQ4ZjBkMQ==

此代码块在浮窗中显示

请求参数

pushlist 必填参数。JSON 类型，最多支持填写 1000 个 cid 值。 cid 值必填参数。JSON 类型，取值：push（默认），JSON Value 部分具体字段参考下面表格说明。

          pushlist
    必填参数。JSON 类型，最多支持填写 1000 个 cid 值。
cid 值
    必填参数。JSON 类型，取值：push（默认），JSON Value 部分具体字段参考下面表格说明。

此代码块在浮窗中显示

关键字	选项	含义
platform	必填	推送平台设置，详情参考推送 API 。
target	必填	推送设备指定。如果是调用 RegID 方式批量单推接口（/v3/push/batch/regid/single），那此处就是指定 regid 值。如果是调用 Alias 方式批量单推接口（/v3/push/batch/alias/single），那此处就是指定 alias 值。
notification	可选	通知内容体，是被推送到客户端的内容，详情参考推送 API 。与 message 一起二者必须有其一，可以二者并存。
message	可选	消息内容体，是被推送到客户端的内容，详情参考推送 API。与 notification 一起二者必须有其一，可以二者并存。
sms_message	可选	短信渠道补充送达内容体，详情参考推送 API。
options	可选	推送可选参数，详情参考推送 API。
callback	可选	推送可选参数，详情参考推送 API。

完整参数示例：

{"pushlist":{ "cid1":{ "platform": "all", "target": "aliasvalue1", // 此处填写的是 regid 值或者 alias 值 "notification": {... // 省略参数同 push api 部分}, "message": {... // 省略参数同 push api 部分}, "sms_message":{... // 省略参数同 push api 部分}, "options": {... // 省略参数同 push api 部分}， "callback":{... // 省略参数同 push api 部分} }, "cid2":{ "platform": "all", "target": "aliasvalue2", // 此处填写的是 regid 值或者 alias 值 "notification": {...}, "message": {...}, "sms_message":{...}, "options": {...}， "callback":{...} }, ... }}

          {"pushlist":{
    "cid1":{
        "platform": "all",
        "target": "aliasvalue1",       // 此处填写的是 regid 值或者 alias 值
        "notification": {...    // 省略参数同 push api 部分},
        "message": {...   // 省略参数同 push api 部分},
        "sms_message":{...  // 省略参数同 push api 部分},
        "options": {...  // 省略参数同 push api 部分}，
        "callback":{... // 省略参数同 push api 部分}
    },
    "cid2":{
        "platform": "all",
        "target": "aliasvalue2",       // 此处填写的是 regid 值或者 alias 值
        "notification": {...},
        "message": {...},
        "sms_message":{...},
        "options": {...}，
        "callback":{...}
    },
    ...
}}

此代码块在浮窗中显示

返回示例

成功返回

HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 Success Response Data { "cid1"：{"msg_id":134123478}, "cid1"：{ "msg_id":134123478, "error":{ "code":1011, "message":"****" } }, "cid3"：{ "error":{ "code":1009, "message":"****" } }, ... }

          HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

Success Response Data
{
    "cid1"：{"msg_id":134123478},
    "cid1"：{
        "msg_id":134123478,
        "error":{
            "code":1011,
            "message":"****"
        }
    },
    "cid3"：{
        "error":{
            "code":1009,
            "message":"****"
        }
    },
    ...
}

此代码块在浮窗中显示

失败返回

HTTP/1.1 400 OK Content-Type: application/json; charset=utf-8 Failed Response Data { "error":{ "message":"Authen failed", "code":1004 } }

          HTTP/1.1 400 OK
Content-Type: application/json; charset=utf-8

 Failed Response Data
{
    "error":{
        "message":"Authen failed",
        "code":1004
    }
}

此代码块在浮窗中显示

调用返回

详情参考推送 API。

调用限制

以上所有 API 接口的频率和 Push API v3 接口频率共用，会互相影响和消耗。
- 举例：使用批量单推接口推送 1 个regid 或者 1 个alias，消耗 Push API 的频率是1。