富媒体通知

最后更新时间:2021-06-22 10:48:17

    操作场景

    富媒体推送允许开发者推送图片、声音、视频等除普通文本之外更丰富的内容,能够有效提升通知点击率。应用开发者可以利用该功能推送如新闻、优惠券、活动信息等更加丰富的内容 ,满足不同开发者的个性化推送需求。

    适用范围

    目前 TPNS 富媒体推送功能支持的富媒体程度如下:

    • Android:支持图片、音频。
    • iOS:支持图片、音频、视频。
      说明:

      iOS 平台 TPNS 通道默认支持富媒体推送功能,APNs 通道需要 App 集成 通知服务扩展插件

    各推送通道富媒体支持类型和使用要求如下表所示:

    推送通道 支持类型 使用要求
    华为 缩略图
    • URL 仅支持 HTTPS
    • 格式要求:
      • PNG/JPG/JPEG 格式
      • 尺寸120px × 120px,若图片长或宽超过120px,华为系统会自动缩放
      • 小于200KB
    小米 大图
    • URL 仅支持 HTTPS
    • 格式要求:
      • PNG/JPG/JPEG 格式
      • 固定876px x 324px
      • 小于1MB
    注意:如需使用小米通道大图通知功能,需先调用小米图片上传接口上传图片文件,获取小米指定的图片地址 pic_url ,再填入 TPNS 推送对应的参数 xg_media_resources 中。详情请参见 小米推送富文本消息 文档中的上传大图 API 部分
    TPNS 大图+缩略图 +音频
    • Android 平台:
      • URL 仅支持 HTTPS
      • 大图、缩略图格式要求:
        • JPEG/JPG/PNG 格式
        • 大图高度不能超过324px,宽度自适应
        • 缩略图尺寸120px × 120px,若图片长或宽超过120px,TPNS 会居中截取方形
      • 音视频文件格式要求:音频文件大小不超过5M
    • iOS 平台:使用要求同 APNs 通道
    APNs 缩略图+音视频
    • URL 仅支持 HTTPS
    • 图片格式要求:
      • JPEG/PNG/GIF 格式
      • 小于10MB
    • 音视频文件格式要求:
      • 视频文件编码格式 MPEG/MPEG2video/MPEG4/AVI 格式
      • 音频文件后缀名需要为 aiff,wav、caf 的一种
      • 音频编码格式需要为 Linear PCM、MA4(IMA/ADPCM)、alaw、μLaw 的一种
      • 音视频文件小于5MB
      • 音频时长要求30s以下
    说明:图片不能与通知音视频同时开启,只能开启其中一个

    操作步骤

    控制台使用

    1. 登录 移动推送控制台,在左侧导航中选择【推送管理】>【推送任务】,进入推送任务页面。
    2. 单击【新建推送】>【高级设置】。
    3. 开启【通知图片】或【通知音视频】,填入富媒体消息 URL,详细配置说明如下:
      • 当您开启【通知图片】时
        Android 端:
        说明:

        • 缩略图:
          URL 格式必须为 HTTPS
          通过 TPNS 通道和华为通道下发的推送可展示缩略图。
          格式要求:PNG/JPG/JPEG格式图片,尺寸120 × 120px,小于200KB。
        • 大图:
          URL 格式必须为 HTTPS
          通过 TPNS 通道和小米通道下发的推送可展示大图。
          格式要求:PNG/JPG/JPEG格式图片,尺寸固定876 x 324px,小于1M。

        iOS 端:
        说明:

        填写图片 URL 后,通知将展示图片,格式要求:

        • 大小不超过10M
        • 格式为PNG/JPG/JPEG/GIF
        • URL 格式必须为 HTTPS
      • 当您开启【通知音频】或【通知音视频】时
        Android 端:
        说明:

        填写音频 URL 后,TPNS 通道下发的通知可携带音频。

        • 音频文件大小不超过5M
        • URL 格式必须为 HTTPS

        iOS 端:
        说明:

        填写音视频 URL 后,通知可携带音频或视频,并通过 Apple 原生组件播放。

        • 音视频文件大小不超过5M
        • 格式为MPEG/MPEG2video/MPEG4/AVI
        • URL 格式必须为 HTTPS

    REST API 使用

    若需要在调用 API 推送时下发富媒体消息,可通过 Push API 中 Android 或 iOS 消息体中以下参数设置:

    平台 参数 备注
    Android
  • 缩略图:icon_resicon_type
  • 大图:xg_media_resources
  • 音频:xg_media_audio_resources
  • 缩略图仅 TPNS 通道和华为通道支持
  • 大图仅 TPNS 通道和小米通道支持
  • 音频仅 TPNS 通道支持
  • iOS
  • 图片、音视频:xg_media_resources
  • 通知图片不能与通知音视频同时设置,只能设置其中一个

    详情可参见 Push API 必要参数 说明。

    Android 端推送示例如下:

    {
      "audience_type": "token",
      "token_list": [
          "05da87c0ae******2dfa9e08d884aada5bb2"
      ],
      "message_type": "notify",
      "multi_pkg":true,
      "message": {
          "title": "推送标题",
          "content": "推送内容",
          "xg_media_resources": "xxx1" , //此处填富媒体元素地址,例如 https://www.xx.com/img/bd_logo1.png?qua=high
          "xg_media_audio_resources":"xxx", //此处填音频富媒体元素地址,例如 https://sc1.111ttt.cn/2018/1/03/13/396131227447.mp3 
          "android": {
         "icon_type": 1,
          "icon_res": "xxx", //此处填图片缩略图元素地址
               "custom_content":"{\"key\":\"value\"}"
          }                        
      }
    }
    

    常见问题

    魅族、OPPO、vivo 厂商通道不支持富媒体,推送全部设备时,通知如何下发?

    TPNS、华为、小米、FCM 通道下发的通知带图片,魅族、OPPO、vivo 通道下发的通知默认纯文本样式,不带图片。

    推送消息需要携带图片怎么使用?

    无论是调用 API 还是通过控制台下发,都需要将图片生成 URL 后使用。

    Android 音频富媒体下发策略是怎么样的?

    TPNS 通道下发的音频富媒体推送,正常展示音频,其他通道下发的音频富媒体推送,默认纯文本样式,不带音频。

    iOS 富媒体通知图片和通知音视频可以同时开启吗?

    不能同时开启,只能开启其中一个。