推送 API

          curl --insecure -X POST -v https://api.jpush.cn/v3/push -H "Content-Type: application/json" -u "7d431e42dfa6a6d693ac2d04:5e987ac6d2e04d95a9d8f0d1" -d '{"platform":"all","audience":"all","notification":{"alert":"Hi,JPush !","android":{"extras":{"android-key1":"android-value1"}},"ios":{"sound":"sound.caf","badge":"+1","extras":{"ios-key1":"ios-value1"}}}}'

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

        

          < HTTP/1.1 200 OK
< Content-Type: application/json
{"sendno":"18","msg_id":"1828256757"}

        

          Authorization: Basic base64_auth_string

        

          {
    "cid": "8103a4c628a0b98974ec1949-711261d4-5f17-4d2f-a855-5e5a8909b26e",
    "platform": "all",
    "audience": {
        "tag": [
            "深圳",
            "北京"
        ]
    },
    "notification": {
        "android": {
            "alert": "Hi, JPush!",
            "title": "Send to Android",
            "builder_id": 1,
            "large_icon": "http://www.jiguang.cn/largeIcon.jpg",
            "intent": {"url": "intent:#Intent;component=com.jiguang.push/com.example.jpushdemo.SettingActivity;end",},
            "extras": {"newsid": 321}
        },
        "ios": {
            "alert": "Hi, JPush!",
            "sound": "default",
            "badge": "+1",
            "thread-id": "default",
            "extras": {"newsid": 321}
        },
        "voip": {    // 此功能需要 JPush iOS SDK v3.3.2 及以上版本支持
            "key": "value" // 任意自定义 key/value 对，api 透传下去
        },
        "quickapp": {
            "alert": "Hi, JPush!",
            "title": "Send to QuickApp",
            "page": "/page1"
        }
    },
    "message": {
        "msg_content": "Hi,JPush",
        "content_type": "text",
        "title": "msg",
        "extras": {"key": "value"}
    },
    "sms_message":{
       "temp_id":1250,
       "temp_para":{"code":"123456"},
        "delay_time":3600,
        "active_filter":false
    },
    "options": {
        "time_to_live": 60,
        "apns_production": false,
        "apns_collapse_id":"jiguang_test_201706011100"
    },
    "callback": {
        "url":"http://www.bilibili.com",
        "params":{
            "name":"joe",
            "age":26
         },
         "type":3
    }
}

        

          {"platform" : "all"}

        

          {"platform" : ["android", "ios","quickapp"] }

        

          {
   "platform": "all",
   "audience" : "all",
   "notification" : {
      "alert" : "Hi, JPush!",
      "android" : {},
      "ios" : {"extras" : { "newsid" : 321}
      }
   }
}

        

          {
    "audience" : {"tag" : [ "深圳", "广州", "北京"]
    }
}

        

          {
    "audience" : {"tag_and" : [ "深圳", "女"]
    }
}

        

          {
    "audience" : {"alias" : [ "4314", "892", "4531"]
    }
}

        

          {
    "audience" : {"registration_id" : [ "4312kjklfds2", "8914afd2", "45fdsa31"]
    }
}

        

          {
    "audience" : {"tag" : [ "深圳", "广州"],
        "tag_and" : ["女", "会员"]
    }
}

        

          {
    "notification" : {"alert" : "Hello, JPush!"}
}

        

          {
    "notification" : {
        "android" : {
             "alert" : "hello, JPush!",
             "title" : "JPush test",
             "builder_id" : 3,
             "style":1  // 1,2,3
             "alert_type":1 // -1 ~ 7
             "big_text":"big text content",
             "inbox":JSONObject,
             "big_pic_path":"picture url",
             "priority":0, // -2~2
             "category":"category str",
             "large_icon": "http://www.jiguang.cn/largeIcon.jpg",
           "intent": {"url": "intent:#Intent;component=com.jiguang.push/com.example.jpushdemo.SettingActivity;end",},
             "extras" : {
                  "news_id" : 134,
                  "my_key" : "a value"
             }
        }
    }
}

        

          {
    "notification" : {
         "ios" : {
                 "alert" : "hello, JPush!",
                 "sound" : "sound.caf",
                 "badge" : 1,
                 "extras" : {
                      "news_id" : 134,
                      "my_key" : "a value"
                 }
               }
       }
}

        

          {
    "_j_msgid" = 813843507;
    aps =     {
        alert = "hello,JPush!";
        badge = 1;
        sound = "sound.caf";
    };
    "my_key" = "a value";
    "news_id" = 134;
}

        

          {
    "notification" : {
        "quickapp": {
            "alert": "Hi, JPush!",
            "title": "Send to QuickApp",
            "page": "/page1",
            "extras" : {
                "news_id" : 134,
                "my_key" : "a value"
            }
        }
}

        

              {
        "notification" : {
            "winphone" : {
                 "alert" : "hello, JPush!",
                 "title" : "Push Test",
                 "_open_page" : "/friends.xaml",
                 "extras" : {
                      "news_id" : 134,
                      "my_key" : "a value"
                 }
            }
        }
    }

        

              {
        "notification": {
            "ios" : {
                "alert" : "hello, JPush!",
                "sound" : "sound.caf"
            },
            "voip": {"key": "value" // 任意自定义 key/value 对，会透传给 APP}
        }
    }

        

          Android 1.6.2 及以下版本 接收 notification 与 message 并存（即本次 api 调用同时推送通知和消息）的离线推送， 只能收到通知部分，message 部分没有透传给 App。

Android 1.6.3 及以上 SDK 版本已做相应调整，能正常接收同时推送通知和消息的离线记录。

iOS 1.7.3 及以上的版本才能正确解析 v3 的 message，但是无法解析 v2 推送通知同时下发的应用内消息。

        

          {
    "cid": "8103a4c628a0b98974ec1949-711261d4-5f17-4d2f-a855-5e5a8909335e",
    "platform": "all",
    "audience": {
        "tag": [
            "深圳",
            "北京"
        ]
    },
    "notification": {
        "android": {
            "alert": "Hi, JPush!",
            "title": "Send to Android"
        },
        "ios": {
            "alert": "Hi, JPush!",
            "sound": "default",
            "badge": "+1",
            "thread-id": "default",
            "extras": {"newsid": 321}
        }
    },
    "inapp_message": {"inapp_message": true}
}

        

          "third_party_channel":{
    "xiaomi":{
              "distribution":"jpush", 
              "channel_id":"*******", 
              "large_icon":"jgmedia-2-14b23451-0001-41ce-89d9-987b465122da", 
              "small_icon_uri":"jgmedia-3-14b23451-0001-41ce-89d9-987b465122da",
              "small_icon_color":"#ABCDEF", 
              "big_text":"testbigtext", // 可选，最多支持 128 个字符，配合小米 style 使用
              "style":1, 
              "distribution_fcm":"fcm",
              "distribution_customize":"first_ospush", 
              "skip_quota": true 
    },
    "huawei":{
              "distribution":"secondary_push", 
              "distribution_fcm":"jpush", 
              "distribution_customize":"first_ospush", 
              "importance":"HIGH",
              "large_icon":"jgmedia-2-14b23451-0001-41ce-89d9-987b465122da",
              "small_icon_uri":"jgmedia-3-14b23451-0001-41ce-89d9-987b465122da",
              "inbox": JSONObject, //可选，配合华为 style 使用
              "style":2, 
              "only_use_vendor_style":true 
    },
    "honor":{
              "distribution":"secondary_push", 
              "distribution_fcm":"jpush", 
              "distribution_customize":"first_ospush", 
              "large_icon":"jgmedia-2-14b23451-0001-41ce-89d9-987b465122da",
              "small_icon_uri":"jgmedia-3-14b23451-0001-41ce-89d9-987b465122da",
              "style":1
    },
    "meizu":{
              "distribution":"jpush",
              "distribution_fcm":"pns" 
    },
    "fcm":{   // 这个参数不支持 distribution_fcm 字段
              "distribution":"jpush"  
    },
    "oppo":{
              "distribution":"ospush", 
              "channel_id":"*******",
              "distribution_fcm":"secondary_fcm_push", 
              "large_icon":"jgmedia-2-14b23451-0001-41ce-89d9-987b465122da", 
              "big_pic_path":"jgmedia-1-14b23451-0001-41ce-89d9-987b465122da", 
              "style":1, 
              "skip_quota": true 
    },
    "vivo":{
            "distribution":"jpush",
            "classification": 0,
            "distribution_fcm":"secondary_pns_push", 
            "push_mode":0
    }
}

        

          {
    "platform":"all",
    "audience":"all",
    "notification":{"alert":"Hi, JPush",},
    ....
    "callback": {
        "url":"https://***",  // 可选字段；
        "params":{          // 可选
            "name":"joe",
            "age":26
         },
         "type":3   // 可选，1: 送达回执, 2: 点击回执, 3: 送达和点击回执, 8: 推送成功回执, 9: 成功和送达回执, 10: 成功和点击回执, 11: 成功和送达以及点击回执
    }
}

        

          {
    "platform":"all",
    "audience":"all",
    "message":{"msg_content": "Hi,JPush",},
    "notification_3rd": {
        "content": "Hi,JPush",
        "title": "msg",
        "channel_id": "channel001",
        "uri_activity": "cn.jpush.android.ui.OpenClickActivity",
        "uri_action": "cn.jpush.android.intent.CONNECTION",
        "badge_add_num": 1,
        "badge_class": "com.test.badge.MainActivity",
        "sound": "sound",
        "extras":{
            "news_id" : 134,
            "my_key" : "a value"
        }
    }
}

        

          curl --insecure -X GET -v https://api.jpush.cn/v3/push/cid?count=3 -H "Content-Type: application/json" -u "2743204aad6fe2572aa2d8de:e674a3d0fd42a53b9a58121c"

        

          GET /v3/push/cid?count=3
Authorization: Basic (base64 auth string)
Content-Type: text/plain
Accept: application/json

        

          count
    可选参数。数值类型，不传则默认为 1。范围为 [1, 1000]
type
    可选参数。CID 类型。取值：push（默认），schedule

        

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

 Response Data

{
 "cidlist":[
 "8103a4c628a0b98994ec1949-128eeb45-471c-49f3-b442-a05c20c9ed56",
 "8103a4c628a0b98994ec1949-6e44d7f1-89f5-48a8-bec4-e359c15b13e5",
 "8103a4c628a0b98994ec1949-47e0a960-ce67-4e71-94ce-b4b9e8813af0"
 ]
}

        

          cidlist
    cid 列表

        

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

        

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

        

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

        

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

        

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

        

          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
    }
}

        

          DELETE /v3/push/{msgid}
    Authorization: Basic (base64 auth string)
    Content-Type: text/plain
    Accept: application/json

        

          HTTP/1.0 200
  Content-Type: application/json
  Content-Length: 0

        

          HTTP/1.0 400
  Content-Type: application/json
  Content-Length: 0

        

          {
  "error":{
    "code":1003,
    "message":"msgid doesn't exist"
  }
}

        

          {
    "platform":"all",
    "audience":{
        "file":{"file_id":"004f2b2c3d8fc649fa60ad2c-15563487-577d-4bb0-806b-56f1a19e06c1"}
    },
    "notification":{"alert":"Hello, JPush!"},
    "message":{"msg_content":"Hello, JPush!"},
    "options":{
        "time_to_live":600,
        "apns_production":false
    }
}

        

          {
    "cid": "7103a4c428a0b98974ec1849-711161d4-5f17-4d2f-b855-5e5a8909b26e",
    "name":"Schedule_Name",
    "enabled":true,
    "trigger":{
        "periodical":{
            "start":"2021-02-19 12:00:00",
            "end":"2021-03-19 18:30:00",
            "time":"18:05:00",
            "time_unit":"day",
            "frequency":1
        }
    },
    "push":{
        "platform":"all",
        "audience":{
            "file":{"file_id":"004f2b2c3d8fc649fa60ad2c-15563487-577d-4bb0-806b-56f1a19e06c1"}
        },
        "notification":{"alert":"Hello, JPush!"},
        "message":{"msg_content":"Hello, JPush!"},
        "options":{
            "time_to_live":600,
            "apns_production":false
        }
    }
}

        

          curl --insecure -X POST -v https://api.jpush.cn/v3/grouppush -H "Content-Type: application/json" -u "group-e4c938578ee598be517a2243:71d1dc4dae126674ed386b7b" -d '{"platform":["android"],"audience":"all","notification":{"android":{"alert":"notification content","title":"notification title"}},"message":{"msg_content":"message content"}}'

        

          {"004f2b2c3d8fc649fa60ad2c":{"msg_id":"38280675634520813","sendno":"0"},"4bb78a2d6404fa239906db70":{"error":{"code":1011,"message":"cannot find user by this audience"},"dad9619c708ae3663647d01e":{"msg_id":"9007276705113721","sendno":"0"},"group_msgid":"bspkjbi81sipokgfvmu0"}

        

          curl --insecure -X POST -v https://api.jpush.cn/v3/grouppush/file -H "Content-Type: application/json" -u "group-e4c938578ee598be517a2243:71d1dc4dae126674ed386b7b" -d '{"platform":["android"],"audience":{"file": {"file_id":"9516d30d2c128dd2000e35b6-e4b030ed-6f89-468c-8f3a-41302f88fe44"}},"notification":{"android":{"alert":"notification content","title":"notification title"}},"message":{"msg_content":"message content"}}'