Auxiliary Development Tools

Offline Push Check

Offline push issue locator

This tool allows you to query issues related to the failure to receive offline messages.
1. Log in to the Chat console, navigate to the target application to access the application management page.
2. In the left sidebar, choose Chat > Push > Access test.
3. In the Offline Push Issue Locator area, enter the UserID.
4. Click Obtain Device Status to view the uploaded information for the UserID, such as the certificate ID and device token.
Note
If no UserID information, such as the certificate ID and device token, has been uploaded, the query ends.
5. Select any certificate ID of the UserID, click Start Checking, and then view the sending result.
If a success prompt is displayed, the certificate information you entered in the console is correct and the token was uploaded by calling the SDK API. You can use the user status checker for further troubleshooting.
If a failure prompt is displayed, you can view the cause of the failure and the solution.


User status checker

This tool automatically obtains the user’s client status and checks whether the user is ready to receive offline push messages.
1. Log in to the Chat console, navigate to the target application to access the application management page.
2. In the left sidebar, choose Chat > Push > Access test.
3. In the User Status Checker area, enter the UserID.
4. Click Get Status to view information such as the current status and client type of the UserID. If you are prompted that the UserID is ready to receive offline push messages, you can log in with a different UserID on another device to send one-to-one text messages to the current UserID to check whether it can receive the messages.




UserSig Generation and Verification

Signature (UserSig) generator

The system automatically obtains the key of the current app. After entering the UserID, you can use this tool to quickly generate a signature (UserSig) to run through demos and debug features locally. If you need to generate a UserSig for online services, see Generating UserSig on the Server.
2. In the Signature (UserSig) Generator area, enter the UserID.
3. Click Generate UserSig to generate a signature, which expires after 180 days.
4. Click Copy UserSig to copy the signature and then paste and save the signature.



Signature (UserSig) verification tool

The system automatically obtains the key of the current app. After entering the UserID and UserSig, you can use the tool to quickly check the validity of the UserSig.
1. Log in to the Chat console, navigate to the target application to access the application management page.
2. In the left sidebar, choose Chat > Auxiliary Tools > UserSig Tools.
3. In the Signature (UserSig) Verifier area, enter the UserID and UserSig.


4. Click Verify to see the verification result.
If verification succeeds, you can view the SDKAppID, UserID, generation time, service time, and expiration time of the UserSig in the verification results.


If verification fails, you can view the cause of failure and solution in the verification results.



Self-Troubleshooting Logs

Tencent Cloud Chat console provides self-troubleshooting feature to allow developers to query the backend log information of Chat in the last three days to quickly locate and solve issues.
1. Log in to the Chat console, click the target Chat app section.
2. In the left sidebar, choose Auxiliary Tools > Self-Troubleshooting Logs.
3. Configure following filters to query logs:
Event name (Optional): Select events for querying.
UserID (Optional): Enter username (UserID), which is the UserID of the message sender.
Receiver/Group ID (Optional): Enter target conversation ID. For a one-to-one chat, it is the userID of the message receiver. For a group chat, it is the GroupID of the group.
Error codes (Optional): Enter error codes. For error code descriptions, see Error Codes.
Time range (Required): Select the time range of logs to be queried. Logs in the last three days can be queried.
4. Click Query to view the filtered logs.