公共参数

本文档主要介绍个推开放平台公共请求参数和公共返回参数

公共请求参数

以下参数是调用每个接口都需要使用的参数

header参数

公共返回结构

以下参数格式为每个接口返回的数据的通用格式。

推送接口公共消息说明

推送消息体示例(具体含义请见推送API)：

{
    "request_id":"请填写10到32位的id",
    "audience":"all",
    "settings":{
        "ttl":7200000,
        "strategy":{
            "default":1,
            "ios":4,
            "st":4
        }
    },
    "push_message":{
        "notification":{
            "title":"请填写标题",
            "body":"请填写内容",
            "click_type":"url",
            "url":"https://www.json.cn/"
        }
    },
    "push_channel":{
        "android":{
            "ups":{
                "notification":{
                    "title":"请填写android标题",
                    "body":"请填写android内容",
                    "click_type":"url",
                    "url":"https://xxx"
                }
            }
        },
        "ios":{
            "type":"notify",
            "payload":"自定义消息",
            "aps":{
                "alert":{
                    "title":"请填写ios标题",
                    "body":"请填写ios内容"
                },
                "content-available":0
            },
            "auto_badge":"+1"
        }
    }
}

audience 推送目标用户设置

推送目标用户，表示一条推送将要被推送到哪些用户列表。设置目标用户的方式：cid、别名(alias)，tag等等。

注意：audience的参数选择根据请求url决定，与请求url不匹配时会报错，比如：选择接口为/push/single/cid，但audience选择alias，此时推送失败；

示例(非all示例，以下参数只能选择一个)：

{
    "audience":{
        "cid":[""],
        "alias":[""],
        "fast_custom_tag":"",
        "tag":[{
           "key":"phone_type",
           "values":[
               "android"
           ],
           "opt_type":"and"
        }]
    }
}

示例(all，推送所有用户)：

{
    "audience": "all"
}

settings 推送条件设置

示例：

{
  "settings": {
    "ttl": 86400000,
    "strategy": {
      "default": 1,
      "ios": 2,
      "vv": 6
    },
    "speed": 100,
    "schedule_time": 1591794372930,
    "custom_callback": "msg-as-you-like-2022112801057743",
    "filter_notify_off": true,
    "active_days": 7,
    "need_backup": true
  }
}

strategy 厂商下发策略选择

功能描述

• 详细介绍

使用方式：

说明：厂商推送策略为 VIP 功能，需升级服务后方可使用。非VIP用户无法设置厂商策略，无需填写strategy 字段，默认所有通道策略都是1 。若须申请修改请点击右侧“技术咨询”了解详情。

说明：厂商智能配额策略为 SVIP 功能，需升级服务后方可使用。若须申请修改请点击右侧“技术咨询”了解详情。

使用示例：

{
    "settings": {
        "strategy":{
            "default":1,
            "ios":4,
            "hw":1
        }
    }
}

push_message 在线个推通道消息内容

通知消息(notification)，仅支持安卓系统，iOS系统不展示个推通道下发的通知消息

说明：厂商不支持定时展示效果，传递duration参数将无法下发厂商消息。

notification

revoke

示例：
通知消息：

{
    "push_message":{
        "notification":{
            "title":"请填写你的通知标题",
            "body":"请填写你的通知内容",
            "big_text":"请填写你的通知长文本",
            "logo":"logo.png",
            "logo_url":"http://xxxx/a.png",
            "channel_id":"请填写你的channel_id",
            "channel_name":"请填写你的channel_name",
            "channel_level":3,
            "click_type":"intent",
            "intent":"intent:#Intent;action=;end"
        }
    }
}

透传消息：

{
   "push_message":{
        "transmission":"请填写你的透传消息内容"
    }
}

撤回消息：

{
   "push_message":{
        "revoke": {
            "old_task_id": "xxx",
            "force": false
        }
    }
}

push_channel 离线厂商通道消息内容

ios厂商通道消息

具体参数含义详见苹果APNs文档

aps

alert

multimedia说明：

该字段为Array类型，最多可设置3个子项，每个参数定义如下所示：

示例：

voip语音推送：

{
    "ios":{
        "type":"voip",
        "payload":"自定义消息"
    }
}

apns通知消息

{
    "ios":{
        "type":"notify",
        "payload":"自定义消息",
        "aps":{
            "alert":{
                "title":"通知标题",
                "body":"通知内容"
            },
            "content-available":0,
            "sound":"com.gexin.ios.silence",
            "category":"ACTIONABLE"
        },
        "auto_badge":"+1",
        "multimedia": [{
            "url": "https://xxx",
            "type": 1,
            "only_wifi": false
        }]
    }
}

apns静默推送 可参考苹果APNs文档

{
    "ios":{
        "aps":{
            "content-available":1
        },
        "payload": "自定义消息"
    }
}

apns灵动岛推送 可参考苹果APNs文档

{
    "ios": {
        "type": "liveactivity",
        "aps": {
            "timestamp": 1168364460,
            "event": "update",
            "content-state": {
                "driverName": "Anne Johnson",
                "estimatedDeliveryTime": 1659416400
            },
            "alert": {
                "title": "通知标题",
                "body": "通知内容",
                "sound": "default"
            }
        }
  }
}

android厂商通道消息

更多Android厂商参数，可以参考多厂商参数文档

ups

说明：撤回小米厂商消息时，请提前在应用配置中配置正确的应用包名

notification

hw厂商限制整体消息体长度为4096字节，不限制单独字段长度

revoke

options

{
  "constraint":{"key": "value"}
}

详细内容见多厂商参数

通知示例：

{
    "android":{
        "ups":{
            "notification":{
                "title":"厂商通知标题",
                "body":"厂商通知内容",
                "click_type":"url",
                "url":"https://xxx",
                "notify_id":1234
            },
            "options":{
                "HW":{
                    "/message/android/notification/badge/class": "应用入口Activity路径名称",
                    "/message/android/notification/badge/add_num": 1
                },
                "VV":{
                    "/classification": 0
                }
            }
        }
    }
}

透传示例：（仅华为通道支持，其它安卓通道不支持透传消息）

{
    "android":{
        "ups":{
            "transmission":"厂商透传消息",
            "options":{
                "HW":{
                    "/message/android/urgency":"HIGH",
                    "/message/android/category":"PLAY_VOICE"
                }
            }
        }
    }
}

miniProgram厂商通道消息

wx

透传示例：

{
  "mp":{
    "wx":{
      "template_id":"TEMPLATE_ID",
      "page":"index",
      "miniprogram_state":"formal",
      "lang":"zh_CN",
      "data":{
        "number01":{
          "value":"300766"
        },
        "date01":{
          "value":"2019年03月25日"
        },
        "site01":{
          "value":"每日互动股份有限公司"
        }
      }
    }
  }
}