Overview

Rich media push allows you to push rich media contents such as image, audio, and video in addition to text, which can effectively increase the notification click rate. You can use this feature to push a wider variety of contents such as news, coupons, and event information, satisfying your personalized push needs.

Application Scope

Currently, TPNS rich media push supports the following types of rich media contents:

• Android: image and audio
• iOS: image, audio, and video

  Note：

  The TPNS channel for iOS supports rich media push by default. For the APNs channel, applications need to integrate with the notification service extension plugin.

The supported types of rich media and use requirements for each push channel are as follows:

Operation Directions

Console

1. Log in to the TPNS console. Go to Message Management > Task List.
2. Click Create Push > Advanced Settings.
   
3. Enable Notification Image or Notification Audio/Video, and enter the rich media message URL. The detailed configuration instructions are as follows:
   • When you enable Notification Image:
     Android:

     Note：

     • Thumbnail:
       The URL must be in HTTPS format.
       The thumbnail can be displayed in pushes delivered through the TPNS and Huawei channels.
       Format requirements: PNG, JPG, or JPEG; 120 × 120 px; less than 200 KB
     • Large image:
       The URL must be in HTTPS format.
       The large image can be displayed in pushes delivered through the TPNS and Mi channels.
       Format requirements: PNG, JPG, or JPEG; 876 x 324 px; less than 1 MB

     
     iOS:

     Note：

     After the image URL is entered, the image will be displayed in the notification. Format requirements:

     • The file size cannot exceed 10 MB.
     • The file must be in PNG, JPG, JPEG, or GIF format.
     • The URL must be in HTTPS format.

     
   • When you enable Notification Audio or Notification Audio/Video:
     Android:

     Note：

     After the audio URL is entered, notifications delivered through the TPNS channel can contain audio.

     • The audio file size cannot exceed 5 MB.
     • The URL must be in HTTPS format.

     
     iOS:

     Note：

     After the audio/video URL is entered, notifications can contain audio or video and be played back through Apple's native component.

     • The audio/video file size cannot exceed 5 MB.
     • The file must be in MPEG, MPEG-2 Video, MPEG-4, or AVI format.
     • The URL must be in HTTPS format.

     

RESTful API

To send a rich media message via an API call, you can set the following parameters in the Android or iOS message body in the Push API:

For more information, see the Required Parameters section in Push API.

Below is a sample push on Android:

{
  "audience_type": "token",
  "token_list": [
      "05da87c0ae******2dfa9e08d884aada5bb2"
  ],
  "message_type": "notify",
  "multi_pkg":true,
  "message": {
      "Title": "Push title",
      "content": "Push content",
      "xg_media_resources": "xxx1" , // Enter the URL of the rich media element, such as `https://www.xx.com/img/bd_logo1.png?qua=high`.
      "xg_media_audio_resources":"xxx", // Enter the URL of the audio, such as `https://sc1.111ttt.cn/2018/1/03/13/396131227447.mp3`. 
      "android": {
     "icon_type": 1,
      "icon_res": "xxx", // Enter the URL of the thumbnail.
           "custom_content":"{\"key\":\"value\"}"
      }                        
  }
}

FAQs

The Meizu, OPPO, and vivo channels do not support rich media. How do I deliver notifications to all devices?

Notifications delivered through the TPNS, Huawei, Mi, and FCM channels contain images, while those delivered through the Meizu, OPPO, and vivo channels are in plain text format without images by default.

How can I include an image in a push message?

Whether you call an API or use the console to deliver a message, you need to generate a URL for the image to include it in the message.

What is the policy for delivering audios on Android?

Audio pushes delivered through the TPNS channel can display the audios normally, while those delivered through other channels will be in plain text format without audios by default.

Can I enable both Notification Image and Notification Audio/Video for iOS?

No. You can only enable either of them.