User overview
Your users must connect to the Nexconn service to use instant messaging (IM) features. In Nexconn, a "user" is an app user who holds a valid access token and has successfully connected to the Nexconn IM service.
Register a user
Use your app server to call the Nexconn Register user API with your user's userId to obtain a unique access token. This step must be done through the server-side API.
When connecting to the Nexconn IM service, the client app must include this access token as a credential. Nexconn validates the token to ensure a secure connection.
Registered user limits
- In the development environment?, the maximum number of registered users is 100.
- In the production environment?, after upgrading to Starter or Pro plan, there is no limit on registered users.
Delete a user
In the development environment, you can delete registered test users from the Console to manage test user quotas. This operation is not available in the production environment.
Soft delete a user
Soft deleting a user removes their data from the Nexconn service. Your app can use the server-side Soft delete user API to deactivate a user account, meeting app store or compliance requirements.
Soft delete is only available through the server-side API.
After a successful soft delete, all data associated with the userId is removed. You can query all soft-deleted userId values. If needed, you can restore a soft-deleted userId, but personal data associated with the user cannot be recovered.
User profiles
User profiles include data such as nicknames, avatars, group nicknames, and group avatars. User profile APIs are available by default. You can call the related APIs to store and manage this data on the Nexconn server. Nexconn does not automatically import your app-side user profile data, so your server must write and maintain that data through these APIs.
Friend relationships
Friend management APIs are available by default. You can call the related APIs to maintain friend relationships in Nexconn. The Nexconn IM service does not automatically import or sync your app-side friendship data, so your app server must create and maintain that data through these APIs.
When using friend management, non-friends can still exchange messages by default. To restrict direct messages to friends only, enable Restrict direct messaging to friends in the Console under Chat > Chat settings > Friend.
If you are not using the Nexconn friend management APIs, your app server must enforce any additional direct-message restrictions on its own.
User management APIs
| Feature | Description | Client API | Server API |
|---|---|---|---|
| Register user | Obtain an access token for your user. | Not available | Register user |
| Delete user | See Delete a user above. | Not available | Not available |
| Invalidate token | Invalidate access tokens obtained before a specified time. | Not available | Invalidate token |
| Soft delete user | Deactivate a user ID and delete personal data from the Nexconn service. | Not available | Soft delete user |
| Query soft-deleted users | Retrieve the list of soft-deleted user IDs. | Not available | Query soft-deleted users |
| Restore user | Restore a soft-deleted user ID. | Not available | Restore user ID |
| Set user info on Nexconn server | Set the user name and avatar for push notifications. | Not available | Update user info |
| Get user info from Nexconn server | Retrieve user registration info (creation time, name, avatar URL for push). | Not available | Get user info |
| Update user info on Nexconn server | Update the user name and avatar for push notifications. | Not available | Update info |
| Ban a user | Block a user from connecting to the Nexconn IM service (takes effect immediately). You can set a ban duration, manually unban, and query banned user IDs and ban end times. | Not available | Ban user, Unban user, Query banned users |
| Query connection status | Check the online status of a specified user. | Not available | Query connection status |
| Add to blocklist | Add a user to your blocklist. Users on A's blocklist cannot send messages to A. | Add to blocklist | Add to blocklist |
| Remove from blocklist | Remove a user from your blocklist. | Remove from blocklist | Remove from blocklist |
| Check blocklist status | Check whether a specified user is on the current user's blocklist. | Check blocklist status | Not available |
| Get blocklist | Retrieve the current user's blocklist. | Get blocklist | Query blocklist |