User overview
App users must connect to the Nexconn messaging service to use IM features. In Nexconn, a "user" is an app user who holds a valid access token issued by Nexconn and has connected to the messaging service.
Register a user
Your app server provides a user ID (userId) to the Nexconn server in exchange for a unique access token. This step is called registering a user and must be done via the Server API.
The app client must hold a valid access token to connect to Nexconn. When a client sends a connection request, the server verifies the token.
User registration limits
- The development environment supports up to 100 registered users.
- In production environments, upgrading to Starter or Pro removes the registration limit. You can switch plans from the console.
Delete a user
Deleting a user refers to removing registered test users from the development environment via the console to control the total number of test users. This operation is not supported in production environments.
Soft delete a user
Soft deleting a user removes user data from the Nexconn messaging service. Apps can use this to implement account deletion features for app store or compliance requirements.
After a successful soft delete, all data associated with the user ID is removed. You can query all soft-deleted user IDs. If needed, you can restore a soft-deleted user ID (note that personal data cannot be recovered).
These operations are only available via the Server API.
User information
User information refers to names, avatars, group nicknames, group avatars, and similar data. User profile APIs are available by default. You can call the related profile APIs to store and manage user information in Nexconn. Nexconn does not automatically import or sync your app-side user data — your server must write and maintain that data through these APIs.
Friendships
Friendship management APIs are available by default. You can call the related friendship APIs to maintain friend relationships in Nexconn. Nexconn does not automatically import or sync app-side friendship data — your server must create and maintain that data through these APIs.
Without Nexconn friendship management, your app server must enforce any additional direct-message restrictions on its own.
With Nexconn friendship management enabled, non-friends can send messages to each other by default. To restrict messaging to friends only, enable Restrict direct messaging to friends in the console under Chat > Chat settings > Friend.
User management APIs
| Category | Description | Server API |
|---|---|---|
| Register a user | Exchange a user ID for an access token. | Register a user |
| Delete a user | See Delete a user above. | Not available via API |
| Expire access tokens | Invalidate tokens obtained before a specific time. | Expire access tokens |
| Soft delete a user | Deactivate a user ID and delete personal data. | Soft delete a user |
| Query soft-deleted users | Get the list of soft-deleted user IDs. | Query soft-deleted users |
| Restore a user | Re-enable a soft-deleted user ID. | Restore a user |
| Set user info | Set the user name and avatar used in push notifications. | Provided during registration. |
| Get user info | Get the user's registered info: name, avatar URL, creation time. | Get user info |
| Update user info | Update the user name and avatar used in push notifications. | Update user info |
| Ban a user | Block a user from connecting to the messaging service and immediately disconnect them. Supports timed or manual unbanning. | Ban a user, Unban a user, Query banned users |
| Check online status | Check a user's online status. | Check online status |
| Add to blocklist | Add users to a user's blocklist. Blocked users cannot send messages to the blocking user. | Add to blocklist |
| Remove from blocklist | Remove users from a user's blocklist. | Remove from blocklist |
| Query blocklist | Get a user's blocklist. | Query blocklist |
Only the blocklist feature provides client APIs. All other APIs above are server-side only.