How to use the offline push debugging tool

Introduction

When an app is switched to the backend or the process is "killed", the offline push function is required to send newly received messages to the user. Corresponding offline push information needs to be configured for different manufacturers. For example, for iOS, offline push can be implemented by configuring APNs.

The offline push link contains nodes such as user, ZEGOCLOUD Push Notification service (ZPNs), push server of device manufacturer, and client of device manufacturer. Therefore, it is prone to various issues. When the offline push fails and you need to quickly locate the issue, you can use this tool for troubleshooting and getting help.

This document describes how to use the offline push debugging tool.

Note

This debugging tool mainly applies to offline push scenarios and can detect the link after messages are sent to ZPNs and the push server of manufacturer. Link detection between the push server and client of manufacturer is not supported.
Successful offline push debugging requires that you have configured the correct offline push certificate of the corresponding manufacturer. For more information, see How to Configure Offline Push Certificates.

Procedure

Log in to the ZEGOCLOUD Admin Console and access the app to be debugged. Click Service Management and click the In-app Chat tab. (You can quickly access the debugging tool page by choosing Development tools > Push debug tool in the navigation pane on the console homepage.)

If you have successfully uploaded the certificate, click Push debug to access the debugging tool page.

Enter the information for debugging.
- AppID, Push title, Push ID, and Push content are required. AppID specifies the ID of the app to be debugged in the ZEGOCLOUD Admin Console, and Push title and Push content specify the message content to be tested.
- Push ID is the identifier that contains information about the test device, which is generated by the SDK. You can obtain the corresponding push ID by referring to How to Obtain Offline Push PushID.
- Resource ID and Payload are optional. You can fill in the corresponding content for debugging as needed.

Click Test for push link detection. The test interval for message debugging is 5s. Corresponding information is then returned and displayed as the link detection runs.

You can decide whether to show the status of push to ZEGOCLOUD Push Servers and Manufacturer Push Servers. If the push fails, the corresponding error code and error message are displayed.
The Manufacturer Push Servers node will return the JavaScript packets after the test message for the corresponding manufacturer is sent. You can click View Details to view the corresponding JavaScript information on a web page. You can also contact ZEGOCLOUD technical support for quick fault locating based on the error code and error message.