Android SDK FAQs

Discontinuing Push Notification Service TPNS

Announcements

Features

SDK for Android

SDK for iOS

SDK for macOS

Release Notes

Overview

Strengths

Use Cases

Global Deployment

Product Introduction

Billing Overview

Purchase Directions

Billing Modes

Free Trial

Payment Overdue

Purchase Guide

Creating Products and Applications

Quick Integration with Android

Quick Integration with iOS

Creating a Push Task

Querying Push Records

Guidelines for Push Testing Methods

Product Restrictions

Getting Started

Troubleshooting Tool

Conversion Funnel

Push Plan

Push Settings

Message Recall

Push Management

Multi-Package Name Push

Notification Tap-to-Redirect

Custom Push Speed

Channel Policies

Message Collapse

Rich Media Notification

Custom Notification

Push to Accounts

Advanced Push Features

Operation Guide 

iOS Badge Feature Practice

Practical Tutorial

API Overview

Signature Authentication (Recommended)

Basic Auth Authentication

Request Structure

Call Method

Push API

Creating a Push Plan

Account Package Upload API

Token Package Upload API

Push APIs

Tag Binding and Unbinding

Deleting All Devices Under Tag

Tag APIs

Account Binding and Unbinding

Account and Device Binding Query

Account APIs

Querying Daily Aggregated Push Statistics

Querying Device Statistics

Querying All Push Information in Specific Period

Querying Push Information for One Task

Querying Push Statistics for a Single Task

Querying Aggregated Statistics for Multiple Tasks

Querying All Push Tasks on the Day by Token

Statistics APIs

User Attribute APIs

Server-Side Error Codes

Server SDKs

API (Java)

API Documentation

SDK Integration

Vendor Channel Integration Guide

Vendor Channels

Compatibility with Android P

Error Codes

Android Integration Guide

Acquisition of Push Certificate

Push Environment Selection Description

Extension Feature

iOS SDK FAQs

iOS Integration Guide

Client Integration Plugin

Push Certificate Description

macOS Integration Guide

SDK Documentation

Quick Configuration

Advanced Custom Configuration

Resource Tag

Users and Permissions

Service Level Agreement

Service Agreement

Android

Flutter

Others

FAQs

Privacy Policy

Data Processing and Security Agreement

Developer Agreement

Tencent Push Notification Service Policy

Contact Us

Glossary

Tencent Push Notification Service

Registration succeeded but pushes cannot be received

Please check whether the current app package name is the same as that entered when TPNS is registered. If not, it is recommended to enable multi-package name push when pushing.

Check whether the network is exceptional on the phone and switch to 4G network for testing.

TPNS push is divided into "notification bar message" and "in-app message" (passthrough message). A notification bar message can be displayed in the notification bar, while an in-app message cannot.

Confirm that the phone is in normal mode. Some phones may have restrictions on network and activity of the backend TPNS process when in Low Power or Do Not Disturb mode.

Check whether the notification bar permission is granted on the phone. On some OPPO and Vivo phones, the notification bar permission has to be granted manually.

Registration failed and pushes cannot be received

A newly created app will have a data synchronization process of about one minute. During this period, the registration may return error code 20. You can simply retry later.

Check whether the access id and access key are correctly configured. Common errors are the secret key is misused or the access key contains spaces.

If the console returns an error code such as "10004", "10002", or "20", please see 

https://intl.cloud.tencent.com/document/product/1024/30722

 is good. It is recommended to use 4G network for testing. Wi-Fi may cause insufficient network bandwidth due to excessive users.

Models that were released in the second half of 2015 and 2016 cannot be registered, including "Nubia Z11 series", "Nubia Z11S series", and "Nubia Z9S series". Models that can be registered are all previous ones, including "Z7 series" and "My Prague series" (this issue is found in TPNS v2.47 and 3.X).

After the app is closed, pushes cannot be received

At present, third-party push services cannot guarantee that the pushes can be received after the app is closed. This is due to the limitation of the mobile phone's custom ROM on the TPNS service. All activities of TPNS are on the basis that the TPNS service can connect to the internet and run properly. After the service is terminated, whether it can be restarted depends on the system settings, security programs, and user operations.

QQ and WeChat are in the system-level app allowlist, and the relevant service will not exit after the app is closed, so the user can still receive messages after closing the app, and in fact, the relevant service survives in the backend.

On Android, after the app is closed and the TPNS service is disconnected from the TPNS server, the message delivered to the device will become an offline message, which can be retained for up to 72 hours. If there are multiple offline messages, up to two of them can be retained. If messages pushed after the app is closed cannot be received after the app is opened again, please check whether the unregistration API is called: XGPushManager.unregisterPush

Account, also known as alias, refers to the user account of an app with account login function. This is not only for QQ or WeChat, and all accounts of the user are supported. For example, the account of Mobile QQ is QQ account number, the account of Gmail is the email address, and the account of China Mobile is the mobile number.

For users to whom pushes are to be made based on the account, you need to bind the account to the token first; otherwise, pushes will fail. On Android, account binding is performed upon registration, namely through the registerPush

 API. On iOS, it is configured through setAccount.

When selecting account push, if the system prompts "Token not found, check registration", it means that the account is not associated with the token. There are two possible reasons for this:

(1) The account or alias is unregistered. It is not necessarily due to app call, in some cases, the unregistration may be triggered automatically.

(2) The device is registered with another account or alias, which will automatically unbind the original one. (One device can only correspond to one alias. If there is no device under the current alias, there will certainly be a "not found" error.)

After the account is bound, you can deliver a notification by specifying the alias (account). Normally, all devices that have recently logged in to this account can receive the notification. When the user account is logged out, call registerPush

Account (alias) cannot contain only one single character. One account can be bound to up to 100 devices. Only the last bound device can receive pushes.

Please check whether the tag is successfully bound. An app can have up to 10,000 tags, each token can have up to 100 tags in one app, and no spaces are allowed in the tag.

Use the server push SDK to query the tag and token binding

public function QueryTokenTags($deviceToken)

            $ret['err_msg'] = 'deviceToken is not valid';

        $params['access_id'] = $this->accessId;

        $params['device_token'] = $deviceToken;

        return $this->callRestful(self::RESTAPI_QUERYTOKENTAGS, $params);

You can create up to 30 pushes per hour for full push, and excessive ones will fail.

Full push of the same content can be performed only once per hour, and excessive ones will fail.

The same app can create up to 30 tag pushes per hour, and excessive ones will fail.

Push of the same content with the same tag can be performed only once per hour, and excessive ones will fail.

Next day: The push data can be viewed the next day after pushed

Real-time: The push data can be viewed immediately after pushed. Currently, up to 14 times of real-time statistics collection are supported per week.

During the offline retention period of the message, there will be successful connections to the TPNS server and normally delivered pushes. (For example, if the message is retained offline for 3 days, the actually delivered data will stabilize on the fourth day, and the data will increase as more devices are turned on and connected to the TPNS server.)

Historical details only show full pushes, tag pushes, and number package pushes at the official website. (Currently, push details cannot be displayed for batch accounts or batch devices.)

It shows the data of the day. The data of a specific day is the total amount of pushes by various push actions on that day. (There are four types of pushes: unicast, broadcast (i.e., batch push and full push), notification bar message, and in-app message.)

Message tap event and page redirection method

Since tapping a message generates a tap event by default in the current SDK, the default tap event is to open the main interface. Therefore, if a redirection action is set in the onNotifactionClickedResult method of the device message tap callback, the custom redirection will conflict with the default tap event. The result is that after tapping, the user will be redirected to the specified interface and then returned to the main interface. As a result, you cannot set redirection in onNotifactionClickedResult.

 Use Intent to redirect to the specified page (this method is for Android 3.2.3 and higher)

You need to configure the page to redirect to on the client app's manifest, for example, if you want to redirect to AboutActivity, specify the following page:

android:theme="@android:style/Theme.NoTitleBar.Fullscreen" >

If you use the TPNS console to set the intent for redirection, enter in the following way:

If you use the server SDK to set the intent for redirection, you can set the intent to the following (with the Java SDK as an example):

action.setIntent("xgscheme://com.xg.push/notify_detail");

If you want to bring parameters such as param1 and param2, you can set as below:

action.setIntent("xgscheme://com.xg.push/notify_detail?param1=aa&param2=bb");

In the onCreate method of the page you specify for redirection to:

String p1= uri.getQueryParameter("param1");

String p2= uri.getQueryParameter("param2");

If the passed parameters contain special characters such as # and &,
they can be parsed by using the following method:

 UrlQuerySanitizer sanitizer = new UrlQuerySanitizer();

 sanitizer.setUnregisteredParameterValueSanitizer(UrlQuerySanitizer.getAllButNulLegal());

String value1 = sanitizer.getValue("key1");

String value2 = sanitizer.getValue("key2");

Log.i("XG" , "value1 = " + value1 + " value2 = " + value2);

 Set the page to redirect to upon message tap when delivering the message

(a) You can set the deeplink (package name + class name) directly in the web-based advanced functions;

(b) Set the SetActivity method (package name + class name) of the Action field in the Message class in the backend, and get the relevant content of the message through XGPushClickedResult: title, content, and additional parameters.

The method of setting the page to redirect to in the backend is as follows (with the Java SDK as an example):

XingeApp android = new XingeApp(accessID,secretkey);

message_android.setContent("android test2");

action.setActivity("com.qq.xgdemo.activity.SettingActivity");

JSONObject ret1 = android.pushSingleDevice("token",message_android);

The method of getting the Message parameter on the device is as follows:

// this must be the context of the page to redirect to upon tap.

XGPushClickedResult clickedResult = XGPushManager.onActivityStarted(this);

String ster = clickedResult.getCustomContent();

 Send in-app message to the device; the user-defined notification bar uses local notification pop-up to set the page to redirect to

FAQs for TPNS Android SDK integration with vendor-specific channels

Functions supported by vendor-specific channels

Mi channel supports arrival callback and passthrough, but not tap callback.

Huawei channel supports tap callback (requiring custom parameters) and passthrough (ignoring custom parameters), but not arrival callback.

Meizu channel supports arrival callback and tap callback, but not passthrough.

Note: If you need to get parameters through tap callback or redirect to a custom page, you can use the Intent to do so. Click 

https://intl.cloud.tencent.com/document/product/1024/30720

The problem of otherpushToken = null that may be encountered during debugging

For 4.X otherpush version, check whether the vendor-specific channel initialization code is enabled, and add the following to your app's attachBaseContext function:

For 4.X otherpush version, after the cloud controller successfully downloads the vendor's dex package for the corresponding device, you need to kill the app process and restart the app to complete the registration. The downloaded log is as follows:

10-25 15:16:31.067 16551-16551/? D/XINGE: [DownloadService] onCreate()

10-25 15:16:31.073 16551-16757/? D/XINGE: [DownloadService] action:onHandleIntent

10-25 15:16:31.083 16551-16757/? V/XINGE: [CloudCtrDownload] Create downloadControl

10-25 15:16:31.089 16551-16757/? I/XINGE: [CloudCtrDownload] action:download - url:https://pingjs.qq.com/xg/Xg-Xm-plug-1.0.2.pack, saveFilePath:/data/user/0/com.qq.xgdemo1122/app_dex/XG/5/, fileName:Xg-Xm-plug-1.0.2.pack

10-25 15:16:31.097 16551-16757/? V/XINGE: [CloudCtrDownload] Download file: Xg-Xm-plug-1.0.2.pack

10-25 15:16:31.641 16551-16757/? D/XINGE: [DownloadService] download file Succeed

10-25 15:16:31.650 16551-16757/? D/XINGE: [CloudCtrDownload] Download succeed.

10-25 15:16:31.653 16551-16551/? D/XINGE: [CloudControlDownloadReceiver] onReceive

10-25 15:16:31.673 16551-16738/? I/test: Download file SuccessXg-Xm-plug-1.0.2.pack to /data/user/0/com.qq.xgdemo1122/app_dex/XG/5/

tencent cloud