多厂商参数

简述

由于第三方厂商和个推对特定推送参数支持不统一，个推为了给客户提供一致的推送服务，对推送参数做了特殊规定，解决接入第三方推送遇到的兼容问题，降低接入成本。

消息下发逻辑

目前第三方厂商的通知到达率显著高于第三方透传的到达率。所以厂商渠道建议使用通知。消息默认下发策略：SDK在线状态，走个推渠道下发消息，SDK离线状态，走厂商渠道下发消息。该文档不再介绍个推渠道的参数设置，着重介绍下第三方厂商渠道的通知消息功能使用。

以下是默认的第三方厂商渠道和个推渠道的下发策略，可以使用策略参数改变下发策略，使用说明详见(RestAPI V2)：公共参数-strategy 厂商下发策略选择

使用方式

push_channel 厂商通道消息内容，设置push_channel/android/ups/notification对象的title，content，intent等参数。其中可以通过options参数传入厂商通知扩展内容。

公共参数【必选】

参考RestV2 push_channel部分

更多options可填参数可以参考下文。

【华为】角标

角标设置

Options参数说明:

• 参数示例

{
  "android": {
    "ups": {
      "notification": {
        // ...其他push_channel参数略
      },
      "options": {
        "HW": {
          "/message/android/notification/badge/class": "应用入口Activity路径名称",
          "/message/android/notification/badge/add_num": 1,
          "/message/android/notification/badge/set_num": 2
        }
      }
    }
  }
}

• key 说明

注意事项
1. 点击启动图标或通知栏系统并不会清理角标数，需应用在端侧通过角标API去清理角标；
2. add_num：EMUI版本8.0.0(及以上)，推送服务App版本8.0.0（及以上）支持；
3. set_num：EMUI版本10.0.0（及以上），推送服务App版本10.1.0（及以上）支持。

【华为】富文本消息

Options参数说明:

• 参数示例

{
  "android": {
    "ups": {
      "notification": {
        // ...其他push_channel参数略
      },
      "options": {
        "HW": {
          "/message/android/notification/image": "公网可以访问的https图标链接",
          "/message/android/notification/style": 1,
          "/message/android/notification/big_title": "big_title",
          "/message/android/notification/big_body": "big_body"
        }
      }
    }
  }
}

• key 说明

注意事项
1. 通知长文本：EMUI版本9.1.0（及以上），推送服务App版本9.1.1（及以上）支持。

【华为】消息分类

消息分类使用之前，需要先向华为侧发邮件申请权限参见华为消息分类申请

Options参数说明:

• 参数示例

{
  "android": {
    "ups": {
      "notification": {
        // ...其他push_channel参数略
      },
      "options": {
        "HW": {
            "/message/android/category": "填写华为侧的category取值"
        }
      }
    }
  }
}

• key 说明

【华为】离线自定义铃声

离线自定义铃声设置需要Android客户端配合使用

服务端

key 说明

注意：自定义铃声受华为自己通知消息权重影响

自定义通知渠道仅对发送给用户设备的服务与通讯级别消息有效，一般级别消息仍然通过华为营销通知渠道展示（一般级别消息是不会播放自定义铃声）。这个时候就不会播放自定义铃声了。消息类别受华为侧AI智能判断控制，或开发者自己向华为侧申请自分类权益申请

Rest-v2 示例：

Options参数【ups 参数中】下进行设置示例:

"HW": {
    "/message/android/notification/default_sound": false,
    "/message/android/notification/channel_id": "RingRing4",
    "/message/android/notification/sound": "/raw/ring001"
}

【华为】消息缓存时间

在用户设备没有网络时，消息在华为Push服务器进行缓存，在消息缓存时间内用户设备重新连接网络，消息会下发，超过缓存时间后消息会丢弃。

服务端

key 说明

Rest-v2 示例：

Options参数【ups 参数中】下进行设置示例:

{
    "android":{
        "ups":{
            "notification":{
                // ...其他push_channel参数略
            },
            "options":{
                "HW":{
                    "/message/android/ttl":"86400s"
                }
            }
        }
    }
}

【荣耀】角标

注意事项 荣耀版本要求 Magic UI 4.0及以上

角标设置

Options参数说明:

• 参数示例

{
  "android": {
    "ups": {
      "notification": {
        // ...其他push_channel参数略
      },
      "options": {
        "HO": {
            "/android/notification/badge/addNum": 1,
            "/android/notification/badge/setNum": 5,
            "/android/notification/badge/badgeClass": "应用入口Activity类全路径名称"
        }
      }
    }
  }
}

• key 说明

注意事项 发送消息同时设置应用角标数字，“class“必填，“addNum”和”setNum”参数选填。若“addNum”和“setNum”都设置为空，则应用角标数字默认加1

【荣耀】富文本消息

通知栏样式设置

Options参数说明:

• 参数示例

{
  "android": {
    "ups": {
      "notification": {
        // ...其他push_channel参数略
      },
      "options": {
        "HO": {
          "/android/notification/icon":"左侧小图标",
          "/android/notification/image": "公网可以访问的https图标链接",
          "/android/notification/style": 1,
          "/android/notification/bigTitle": "bigTitle",
          "/android/notification/bigBody": "bigBody"
        }
      }
    }
  }
}

• key 说明

【荣耀】消息分类

Android通知消息分类，决定用户设备消息通知行为，详细分类标准见荣耀文档荣耀消息分类

Options参数说明:

• 参数示例

{
    "android":{
        "ups":{
            "notification":{
                // ...其他push_channel参数略
            },
            "options":{
                "HO":{
                    "/android/notification/importance":"LOW"
                }
            }
        }
    }
}

• key 说明

【荣耀】通知栏消息动作按钮

通知栏消息动作按钮，最多设置3个

Options参数说明:

• 参数示例

{
    "android":{
        "ups":{
            "notification":{
                // ...其他push_channel参数略
            },
            "options":{
                "HO":{
                    "/android/notification/buttons":[
                        {
                            "name":"点击透传",
                            "actionType":0,
                            "data":"{\"key1\":\"value1\",\"key2\":\"value2\"}"
                        },
                        {
                            "name":"打开网页",
                            "actionType":2,
                            "intent":"https://www.json.cn/"
                        }
                    ]
                }
            }
        }
    }
}

• key 说明

• buttons 说明

【荣耀】通知栏消息到达时间

设置通知栏消息的到达时间

Options参数说明:

• 参数示例

{
    "android":{
        "ups":{
            "notification":{
                // ...其他push_channel参数略
            },
            "options":{
                "HO":{
                    "/android/notification/when":"UTC时间戳"
                }
            }
        }
    }
}

• key 说明

【荣耀】消息缓存时间

在用户设备离线时，消息在荣耀Push服务器进行缓存，在消息缓存时间内用户设备上线，消息会下发，超过缓存时间后消息会丢弃。

Options参数说明:

• 参数示例

{
    "android":{
        "ups":{
            "notification":{
                // ...其他push_channel参数略
            },
            "options":{
                "HO":{
                    "/android/ttl":"86400s"
                }
            }
        }
    }
}

• key 说明

【小米/小米海外】消息分类

小米推送的消息通道分为“普通消息”（默认）和“重要消息”两类，默认下发普通消息。普通消息单日可推送数量有限制，重要消息不限。重要消息申请具体请参考： 小米推送消息分类新规

Options参数说明:

• 参数示例

{
  "android": {
    "ups": {
      "notification": {
        // ...其他push_channel参数略
      },
      "options": {
        "XM": {
          "/extra.channel_id": "Default"
        },
        "XMG": {
          "/extra.channel_id": "Default"
        }
      }
    }
  }
}

• key 说明

注意事项：
1. 如果使用重要消息，需要在客户端创建对应的渠道，具体请参考: MIUI 10 通知类别 (Channel) 适配说明

【小米/小米海外】富文本消息

先调用小米接口，上传图片，获取图片url。

Java方式 参考（小米官方文档） 4.4.1 大图/大文本/Large icon，或者集成个推多厂商推送工具集。

RestAPI 方式 参考（小米官方文档）11.1 大图、大文本/上传大图API。

Options参数说明:

• 参数示例

{
  "android": {
    "ups": {
      "notification": {
        // ...其他push_channel参数略
      },
      "options": {
        "XM": {
          "/extra.notification_style_type": 2,
          "/extra.notification_bigPic_uri":"http://url.big.pic/xxx.png"
        },
        "XMG": {
          "/extra.notification_style_type": 2,
          "/extra.notification_bigPic_uri":"http://url.big.pic/xxx.png"
        }
      }
    }
  }
}

• key 说明

注意事项：
1. 富文本消息仅在MIUI10及以上版本支持，在低版本和非MIUI系统上，消息将按照普通消息的样式展示;
2. 国内版MIUI系统中，仅在MIUI12及以上版本支持large icon，MIUI12以下版本不会展示;
3. 发送大图消息时，如果因为网络原因图片下载失败后将不会展示图片， 而是按照普通消息样式 展示。

【小米/小米海外】离线自定义铃声

离线自定义铃声设置需要Android客户端配合使用

服务端：

key 说明

注意：若服务端/extra.sound_uri和/extra.channel_id同时设置，Android 8.0及以上版本的通知效果以channel中的效果为准

1、客户端-小米厂商版本需要用com.getui:xmp:1.0.8版本或小米-3.0.1版本及以上

2、客户端铃声文件放在Android app的raw目录下；

3、针对android8以上的小米机型，离线自定义铃声只在channel通道中起作用，若需要多个不同铃声则需要多个不同channel通道

因此需要在小米平台上新建channel通道，设置自定义铃声前端路径如：android.resource://your packagename/raw/test（路径不需要带音频后缀名）如图

Rest-v2 示例：

Options参数【ups 参数中】下进行设置示例:

"XM": {
"/extra.sound_uri": "小米后台申请的自定义 sound_url 地址",
"/extra.channel_id": "小米后台申请的通知类别id"
}

【小米/小米海外】语言范围

Options参数说明:

• 参数示例

{
  "android": {
    "ups": {
      "notification": {
        // ...其他push_channel参数略
      },
      "options": {
        "XM": {
          "/extra.locale": "zh_CN"
        },
        "XMG": {
          "/extra.locale": "zh_CN"
        }
      }
    }
  }
}

服务端

key 说明

【小米】model筛选

xmg不支持，若使用手机无法收到消息

Options参数说明:

• 参数示例

{
  "android": {
    "ups": {
      "notification": {
        // ...其他push_channel参数略
      },
      "options": {
        "XM": {
          "/extra.model": "MI 4LTE"
        }
      }
    }
  }
}

服务端

key 说明

【小米/小米海外】app版本号筛选

Options参数说明:

• 参数示例

{
  "android": {
    "ups": {
      "notification": {
        // ...其他push_channel参数略
      },
      "options": {
        "XM": {
          "/extra.app_version": "v3.3.0"
        },
        "XMG": {
          "/extra.app_version": "v3.3.0"
        }
      }
    }
  }
}

服务端

key 说明

【小米/小米海外】按钮设置

Options参数说明:

• 参数示例

{
  "android": {
    "ups": {
      "notification": {
        // ...其他push_channel参数略
      },
      "options": {
        "XM": {
          "/extra.notification_style_button_left_name": "左侧按钮",
          "/extra.notification_style_button_left_notify_effect": "3",
          "/extra.notification_style_button_left_web_uri": "https://c.runoob.com/front-end/854/"
        },
        "XMG": {
          "/extra.notification_style_button_left_name": "左侧按钮",
          "/extra.notification_style_button_left_notify_effect": "3",
          "/extra.notification_style_button_left_web_uri": "https://c.runoob.com/front-end/854/"
        }
      }
    }
  }
}

服务端

key 说明

【小米/小米海外】消息保留时长

如果用户离线，设置消息在服务器保存的时间，单位：ms。服务器默认最长保留两周。

Options参数说明:

• 参数示例

{
     "android":{
         "ups":{
             "notification":{
                      // ...其他push_channel参数略
             },
             "options":{
                 "XM":{
                     "/time_to_live":86400000
                 },
                 "XMG":{
                     "/time_to_live":86400000
                 }
             }
         }
     }
 }

• key 说明

【小米/小米海外】定时发送消息

注：仅支持七天内的定时消息。

Options参数说明:

• 参数示例

{
     "android":{
         "ups":{
             "notification":{
                      // ...其他push_channel参数略
             },
             "options":{
                 "XM":{
                     "/time_to_send":1669690975393
                 },
                 "XMG":{
                     "/time_to_send":1669690975393
                 }
             }
         }
     }
 }

• key 说明

【OPPO/OPPO海外】公、私信

OPush平台上所有通道分为“公信”(默认)、“私信”两类，默认下发公信消息。公信消息单日可推送数量有限制，私信消息不限(仅限单个用户)。oppo 平台私信消息申请参考：推送私信通道申请。

Options参数说明:

• 参数示例

{
  "android": {
    "ups": {
      "notification": {
        // ...其他push_channel参数略
      },
      "options": {
        "OP": {
          "/channel_id": "Default"
        },
        "OPG": {
          "/channel_id": "Default"
        }
      }
    }
  }
}

• key 说明

注意事项
1.OPPO私信消息仅支持单推。
2.如果使用私信，需要在客户端创建对应的私信渠道，具体请参考: 通知通道（Channel）适配

【OPPO】富文本消息

先调用OPPO接口，上传图片，获取图标url。

Java方式集成个推多厂商推送工具集。

RestAPI 参考 “图片上传” 。

Options参数说明:

• 参数示例

{
  "android": {
    "ups": {
      "notification": {
        // ...其他push_channel参数略
      },
      "options": {
        "OP": {
          "/small_picture_id": "xxxxxxxxxxxxxxx",
          // "style": 2,
          "/style": 3,
          "/big_picture_id": "big_body"
        }
      }
    }
  }
}

• key 说明

注意事项：
通知小图标、大图不支持单推，单推请求会返回无权限错误

【OPPO/OPPO海外】消息去重

App开发者自定义消息Id，OPPO推送平台根据此ID做去重处理

Options参数说明:

• 参数示例

{
  "android": {
    "ups": {
      "notification": {
        // ...其他push_channel参数略
      },
      "options": {
        "OP": {
          "/app_message_id": "xxxx"
        },
        "OPG": {
          "/app_message_id": "xxxx"
        }
      }
    }
  }
}

• key 说明

【OPPO/OPPO海外】定时展示

开发者可以根据自己的业务需求设置定时展示，定时展示功能设置成功后消息即时下发，到达用户手机后并不直接展示出来，消息在设置的定时展示时间内展示出来。

Options参数说明:

• 参数示例

{
     "android":{
         "ups":{
             "notification":{
                      // ...其他push_channel参数略
             },
             "options":{
                 "OP":{
                     "/show_time_type":1,
                     "/show_start_time":1640570400000,
                     "/show_end_time":1640571000000
                 },
               "OPG":{
                 "/show_time_type":1,
                 "/show_start_time":1640570400000,
                 "/show_end_time":1640571000000
               }
             }
         }
     }
 }

• key 说明

注意事项：消息并不是到达开始时间就会展示，是在开始时间和结束之间之内进行展示

【OPPO/OPPO海外】自定义消息有效期

开发者可设置每条消息的有效期，在设置的有效期内，只要设备联网，便会收到消息。消息有效期最长10天，最短1小时。

Options参数说明:

• 参数示例

{
     "android":{
         "ups":{
             "notification":{
                      // ...其他push_channel参数略
             },
             "options":{
                 "OP":{
                     "/off_line":true,
                     "/off_line_ttl":86400
                 },
                 "OPG":{
                     "/off_line":true,
                     "/off_line_ttl":86400
               }
             }
         }
     }
 }

• key 说明

【OPPO/OPPO海外】限时展示

消息在通知栏展示后开始计时，到达填写的相对应时间后自动从通知栏消失

Options参数说明:

• 参数示例

{
     "android":{
         "ups":{
             "notification":{
                      // ...其他push_channel参数略
             },
             "options":{
                 "OP":{
                     "/show_ttl":86400
                 },
                 "OPG":{
                      "/show_ttl":86400
                 }
             }
         }
     }
 }

• key 说明

【OPPO/OPPO海外】动作参数

打开应用内页或网页时传递给应用或网页

Options参数说明:

• 参数示例

{
     "android":{
         "ups":{
             "notification":{
                      // ...其他push_channel参数略
             },
             "options":{
                   "OP":{
                     "/action_parameters/key":"value",
                     "/action_parameters/key1":"value1"
                   },
                   "OPG":{
                     "/action_parameters/key":"value",
                     "/action_parameters/key1":"value1"
                   }
             }
         }
     }
 }

• key 说明

【vivo】消息分类

vivo消息分类功能将推送消息类型分为运营消息和系统消息，默认下发运营消息。运营消息单用户单应用单日接收条数上限为5条，系统消息不限。系统消息功能不用申请，可以直接使用，如特殊情况需额外提升系统消息量级，请参见[（vivo官方文档）推送消息分类功能说明]。

Options参数说明:

• 参数示例

{
  "android": {
    "ups": {
      "notification": {
        // ...其他push_channel参数略
      },
      "options": {
        "VV": {
          "/category":"填写对应的ID" //二级分类。
        }
      }
    }
  }
}

• key 说明

【vivo】通知类型

通知消息类型，响铃和振动设置，只对Android 8.0及以下系统有效

Options参数说明:

• 参数示例

{
  "android": {
    "ups": {
      "notification": {
        // ...其他push_channel参数略
      },
      "options": {
        "VV": {
          "/notifyType": 0
        }
      }
    }
  }
}

• key 说明

【vivo】网络方式

开发者可设置手机接收消息的网络方式,若设置wifi下发送，只有手机联网方式为wifi才能收到消息；设置不限，手机只要联网即可收到消息

Options参数说明:

• 参数示例

{
  "android": {
    "ups": {
      "notification": {
        // ...其他push_channel参数略
      },
      "options": {
        "VV": {
          "/networkType": -1
        }
      }
    }
  }
}

• key 说明

【vivo】消息保留时长

开发者可设置每条消息的保留时长，在设置的保留时长内，只要设备联网，便会收到消息。

Options参数说明:

• 参数示例

{
     "android":{
         "ups":{
             "notification":{
                      // ...其他push_channel参数略
             },
             "options":{
                 "VV":{
                     "/timeToLive":86400
                 }
             }
         }
     }
 }

• key 说明

【vivo】客户端自定义键值对

客户端自定义键值对,app可以按照客户端SDK接入文档获取该键值对

Options参数说明:

• 参数示例

{
     "android":{
         "ups":{
             "notification":{
                      // ...其他push_channel参数略
             },
             "options":{
                 "VV":{
                     "/clientCustomMap/key":"value",
                     "/clientCustomMap/key1":"value1"
                 }
             }
         }
     }
 }

• key 说明

【UPS】展开式通知

通知展示样式，文本+长文本样式和文本+大图样式，二者选其一；该参数作用于UPS下面的所有机型，比如ST,SN等等。

Options参数说明:

• 参数示例

{
     "android":{
         "ups":{
             "notification":{
                  // ...其他push_channel参数略
             },
             "options":{
                 "UPS":{
                     "bigText":"请填写长文本内容"
//                   "bigImageUrl":"请填写大图的url地址"
                 }
             }
         }
     }
 }

• key 说明