推送计划管理 API

概述

API 层面支持按计划推送，具体推送方式参考推送计划使用指南；
此模块 API 主要针对的是推送计划本身创建、修改、查询操作。

调用域名

https://api.jpush.cn/

调用验证

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

创建推送计划

接口路径：/v3/push_plan/create
请求方法：POST
请求参数：

{ "name":string, "description":string }

          {
    "name":string,
    "description":string
}

此代码块在浮窗中显示

返回参数

{ "code":int, "message":string } 成功返回0，success，失败返回对应错误码和描述

          {
    "code":int,
    "message":string
}
成功返回0，success，失败返回对应错误码和描述

此代码块在浮窗中显示

查询推送计划列表

接口路径：/v3/push_plan/list?page=1&page_size=10&info=xxx&send_source=1
请求方法：GET
请求参数：

url查询参数格式 info: string 可选参数，模糊查询，表示推送计划或者推送标识，只要其中之一匹配到即可 page: int 可选参数，查询页数 page_size：int 可选参数，每页个数 send_source:int 可选参数，创建来源，0表示api，1表示web（控制台创建），不传或者非0和1值表示不区分 page和page_size不传取默认值（默认为1和50）

          url查询参数格式

info: string 可选参数，模糊查询，表示推送计划或者推送标识，只要其中之一匹配到即可
page: int 可选参数，查询页数
page_size：int 可选参数，每页个数
send_source:int 可选参数，创建来源，0表示api，1表示web（控制台创建），不传或者非0和1值表示不区分

page和page_size不传取默认值（默认为1和50）

此代码块在浮窗中显示

返回参数

返回 { "code":int, "message":string "data":{ "total":int, "page":int, "page_size":int, "detail":[{ "name":string, "description":string, "push_count":int, "create_time":string, "last_used_time":string, "send_source":int }] } } send_source: 1表示web，0表示api push_count: 推送次数 name: 计划标识 description: 计划描述 create_time,last_used_time 格式"2025-01-01 00:00:00"，分别表示计划创建时间和最后使用时间

          返回


{
    "code":int,
    "message":string
    "data":{
        "total":int,
        "page":int,
        "page_size":int,
        "detail":[{
            "name":string,
            "description":string,
            "push_count":int,
            "create_time":string,
            "last_used_time":string,
            "send_source":int
        }]
    }
}
send_source: 1表示web，0表示api
push_count: 推送次数
name: 计划标识
description: 计划描述
create_time,last_used_time 格式"2025-01-01 00:00:00"，分别表示计划创建时间和最后使用时间

此代码块在浮窗中显示

修改推送计划描述

接口路径：/v3/push_plan/update
请求方法：PUT
请求参数：

{ "name":string, "description":string } 用于修改指定推送计划标识的描述

          {
    "name":string,
    "description":string
}
用于修改指定推送计划标识的描述

此代码块在浮窗中显示

返回参数

{ "code":int, "message":string } 成功返回0，success，失败返回对应错误码和描述

          {
    "code":int,
    "message":string
}
成功返回0，success，失败返回对应错误码和描述

此代码块在浮窗中显示

错误码

http状态码	错误码	错误描述
500	1000	内部服务错误
400	1003	参数错误，具体错误查看描述
401	1004	鉴权失败
400	1008	appkey不存在
429	2002	请求频率超限，请稍后重试
403	2006	无权限调用此接口

调用限制

仅针对 Push VIP 客户提供，非 Push VIP 客户需升级服务才能使用
最多允许创建 1000 个计划
以上所有API相关接口的频率总量固定为 100次/min
此文档对应的所有接口均是 VIP 应用专属接口，非 VIP 使用会返回 2006 错误码。