公共参数

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

公共请求参数

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

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"
                },
                "options": {
                    "XM": {
                        "/extra.channel_id": "填写小米平台申请的渠道id" //新小米消息分类下，私信公信id都必须要传，否则请求小米接口会被拦截。
                    }
                }
            }
        },
        "ios":{
            "type":"notify",
            "payload":"自定义消息",
            "aps":{
                "alert":{
                    "title":"请填写ios标题",
                    "body":"请填写ios内容"
                },
                "content-available":0
            },
            "auto_badge":"+1"
        },
      "harmony":{
        "notification":{
          "title":"请填写harmony标题",
          "body":"请填写harmony内容",
          "category":"鸿蒙华为通知消息类别",
          "click_type":"startapp"
        }
      }
    }
}

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

"{\"deviceId\":\"\",\"bundleName\":\"com.getui.push\",\"abilityName\":\"TestAbility\",\"action\":\"com.test.action\",\"uri\":\"https://www.xxx.com:8080/push/test\",\"parameters\":{\"gttask\":\"\",\"name\":\"Getui\",\"age\":12}}"

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文档
灵动岛案例实现参考LiveActivity(灵动岛）文档说明

aps

alert

multimedia说明：

多媒体推送需要客户端集成接入扩展库，否则不展示，接入文档7.多媒体及展示统计
该字段为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"
            }
        }
  }
}

或者参考下面的示例创建灵动岛

{
  "ios": {
    "type": "liveactivity",
    "aps": {
      "timestamp": 1724833752,
      "attributes-type": "MyWidgetAttributes",
      "event": "start",
      "attributes": {
        "progressState": 0,
        "name": "My LA"
      },
      "alert": {
        "title": "start LA!!",
        "body": "body"
      }
    }
  }
}

apns组件推送 可参考苹果APNs文档

apns组件推送示例参考：

{
  "ios": {
    "type": "controls",
   "controls-id": "xxx",
    "aps": {
      "content-changed": true
    }
  }
}

android厂商通道消息

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

ups

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

notification

revoke

options
厂商扩展参数详细内容见多厂商参数

通知示例：

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

harmony厂商通道消息

notification

"{\"deviceId\":\"\",\"bundleName\":\"com.getui.push\",\"abilityName\":\"TestAbility\",\"action\":\"com.test.action\",\"uri\":\"https://www.xxx.com:8080/push/test\",\"parameters\":{\"gttask\":\"\",\"name\":\"Getui\",\"age\":12}}"

options

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

详细内容见多厂商参数

custom

{
  "${constraint}": {
    "type": "${type}",
    "payload": "${payload}"
  }
}

revoke

通知示例：

{
    "harmony":{
        "notification":{
            "title":"鸿蒙通知标题",
            "body":"鸿蒙通知内容",
            "category":"MARKETING",
            "click_type":"startapp"
        },
        "options":{
            "HW":{
                "/pushOptions/testMessage": true
            }
        }
    }
}

透传示例：（仅鸿蒙华为通道支持，但需要在鸿蒙华为后台申请开通）

{
    "harmony":{
        "transmission": "厂商透传消息"
    }
}

自定义消息示例：（仅鸿蒙华为通道支持，使用前请联系技术支持）

• 鸿蒙华为授权订阅消息（subscribe）

{
 "harmony": {
  "custom": {
   "HW": {
    "type": "subscribe",
    "payload": "{\"subscription\":{\"entityId\":\"TM*****FA9\",\"data\":{\"keyword1\":\"接单了\",\"keyword2\":\"苏A12345\",\"keyword3\":\"司机路径\"},\"clickAction\":{\"actionType\":0}}}"
   }
  }
 }
}

• 鸿蒙华为卡片刷新消息（form_update）

{
 "harmony": {
  "custom": {
   "HW": {
    "type": "form_update",
    "payload": "{\"formData\":{\"123\":96,\"class\":\"123\"},\"version\":922337203,\"images\":[{\"keyName\":\"hello\",\"url\":\"https://xxxxxxx.uri\",\"require\":1}],\"formId\":0,\"moduleName\":\"testName\",\"formName\":\"testFormName\",\"abilityName\":\"testAbilityName\"}"
   }
  }
 }
}

• 鸿蒙华为实况窗消息（live_view）

{
 "harmony": {
  "custom": {
   "HW": {
    "type": "live_view",
    "payload": "{\"activityId\":2,\"operation\":0,\"event\":\"TAXI\",\"status\":\"DRIVER_ON_THE_WAY\",\"activityData\":{\"notificationData\":{\"type\":3,\"contentTitle\":\"{{status}}\",\"contentText\":[{\"text\":\"距您\"},{\"text\":\"1.2公里\",\"foregroundColor\":\"#FF317AF7\"},{\"text\":\" | \"},{\"text\":\"5分钟\",\"foregroundColor\":\"#FF317AF7\"}],\"clickAction\":{\"actionType\":1,\"action\":\"xxxxxx\"},\"richProgress\":{\"type\":0,\"nodeIcons\":[\"icon1.png\",\"icon2.png\",\"icon3.png\"],\"indicatorIcon\":\"taxi.png\",\"progress\":40,\"indicatorType\":1,\"color\":\"#FF317AF7\",\"bgColor\":\"#19000000\"},\"extend\":{\"type\":3,\"pic\":\"phone.png\",\"clickAction\":{\"actionType\":5,\"data\":{\"tel\":\"138xxxxxxxx\"}}}},\"capsuleData\":{\"type\":1,\"status\":1,\"icon\":\"icon.svg\",\"bgColor\":\"#FF317AF7\",\"remind\":\"EXPAND\",\"title\":\"接驾中\",\"content\":\"预计5分钟\"}}}"
   }
  }
 }
}

• 鸿蒙华为应用内通话消息消息（voip_call）

{
 "harmony": {
  "custom": {
   "HW": {
    "type": "voip_call",
    "payload": "{\"extraData\":\"携带的透传数据\"}"
   }
  }
 }
}

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":"每日互动股份有限公司"
        }
      }
    }
  }
}