Technical FAQ

Explore our Technical FAQ for quick answers to common questions about Social Plus products. Get troubleshooting tips, best practices, and insights to optimize your technical experience.

API

chevron-rightHow do I create a large number of users in bulk on social.plus?hashtag

To create a large number of users, it's advised to use the following endpoint: Register a sessionarrow-up-right.

chevron-rightWhat should I use as the 'Authorization' token when I need to perform admin actions?hashtag

To obtain your admin token, please follow these steps on the social.plus consolearrow-up-right:

  1. Navigate to "Settings" > "Admin Users"

  2. Click on the cogwheel icon.

This will provide you with the necessary 'Bearer' token to use for authorization when performing admin actions.

chevron-rightHow can I retrieve the next page of data from an API?hashtag

To retrieve the next page of data from an API, you should use the "next" page token provided at the end of the initial page's results. This token should be appended to the endpoint to fetch the values for the next page.

Here's an example:

{
  "paging": {
    "next": "eyJza2lwIjoyMCwibGltaXQiOjEwfQ=="
  },
}

To get the next page of data, append the "next" token to the endpoint like this:

Next Page API Request:

curl --location --globoff 'https://api.sg.amity.co/api/v3/communities?filter=all&sortBy=lastCreated&options[token]=eyJza2lwIjoxMCwibGltaXQiOjEwfQ%3D%3D' \
--header 'accept: application/json' \
--header 'Authorization: Bearer xxx'
chevron-rightHow can I upload a bulk list of blocklisted words?hashtag

You can upload a bulk list of blocklisted words using an example like this:

curl --location 'https://api.sg.amity.co/api/v3/blacklist/records' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer xxx' \
--data '{
  "regexs": [
    "word1",
    "word2",
    "word3"
  ],
  "isMatchExactWord": true
}'

In this example, replace "word1," "word2," and "word3" with the blocklisted words you want to upload in bulk. The request includes the necessary headers and data to add the specified words to the blocklist.

Setting isMatchExactWord to true makes the blocklisting more strict and will only block exact matches, while setting it to false makes the blocklisting more permissive and will block any occurrence of the blocklisted word or expression within a larger text.

API: https://api-docs.amity.co/#/Moderation/post_api_v3_blocklistsarrow-up-right

chevron-rightHow can I modify my follow/unfollow settings?hashtag

You can adjust your follow/unfollow settings by making an API call to the following endpoint: https://api-docs.amity.co/#/Network%20Setting/put_api_v3_network_settings_socialarrow-up-right. Please refer to the example below to understand the structure:

curl --location --request PUT 'https://api.sg.amity.co/api/v3/network-settings/social' \
--header 'accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer xxx' \
--data '{
  "isFollowWithRequestEnabled": false
}'
chevron-rightHow can I obtain higher-quality images?hashtag

For higher-quality images, you can enhance the resolution by simply adding ?size=full to the end of the URL.

Example: https://api.amity.co/api/v3/files/{fileId}/download?size=fullarrow-up-right.

Additionally, you have the flexibility to specify the size as "small," "medium," "large," or "full" based on your preferences.

chevron-rightWhat is a refreshToken?hashtag

A refreshToken is primarily employed by SDKs to validate the accessToken's validity. When using the API, obtaining a new token can be achieved by making a "register session" API call, eliminating the need to directly manage or use a refreshToken.

chevron-rightHow long does the authentication token last?hashtag

The authentication token has a duration of 10 minutes, and it must be used within that specific time frame. For further information on secure mode and authentication tokens, please refer to this section: https://docs.amity.co/analytics-and-moderation/console/settings/security#secure-modearrow-up-right

chevron-rightHow can I retrieve a list of communities I have joined using API?hashtag

To list the communities you've joined, use this API: https://api-docs.amity.co/#/Community/get_api_v3_communities.

Set the filter to 'member' to retrieve the communities you are a part of.

chevron-rightHow can I obtain a new access token once the authentication token has expired?hashtag

You will have to get a new authentication token after the expiration of the current one, you can call the following API endpoint: https://api-docs.amity.co/#/Authentication/get_api_v3_authentication_tokenarrow-up-right.

After receiving the new authentication token, you can use it to call the register session API to obtain a new access token.

API: https://api-docs.amity.co/#/Session/post_api_v4_sessionsarrow-up-right

chevron-rightHow can I obtain my authentication token?hashtag

You can utilise the following API to obtain an authentication token: https://api-docs.amity.co/#/Authentication/get_api_v3_authentication_tokenarrow-up-right.

For more information about obtaining an authentication token, please visit - Security.

chevron-rightHow can I identify the posts I have reacted to?hashtag

While there isn't a specialized API exclusively for tracking your reactions to posts, you can utilize the "get list of reactions" API. This API, accessible at https://api-docs.amity.co/#/Reaction/get_api_v3_reactionsarrow-up-right, enables users to see a list of reactions along with the users who reacted. To determine if you've reacted to a specific post, you'll need to query this API and check if you are listed among the reactors.

chevron-rightCan I update just the metadata for a user without altering any other data?hashtag

Absolutely. To update a user's metadata, simply include 'metadata' in the body of your request, and it will be updated as specified. Below are sample cURL commands for reference:

chevron-rightHow can I remove all posts from my system?hashtag

To delete all posts in your system, first retrieve the posts from community or user feeds using the API found at https://api-docs.amity.co/#/Post/get_api_v3_postsarrow-up-right.

After obtaining the posts, utilize the delete post API to remove them, which is available at https://api-docs.amity.co/#/Post%20v4/delete_api_v4_posts__postIdarrow-up-right_.

Please note, you may need to implement a script to automate the deletion of all posts.

chevron-rightWhat is the process for uploading audio files through social.plus API?hashtag

To upload audio files, it is advisable to use the upload API available at https://api-docs.amity.co/#/File/post_api_v4_filesarrow-up-right.

chevron-rightIs there an API that can retrieve users by role?hashtag

Yes, you can use this API to filter and find users within a community based on their role, such as 'moderator': https://api-docs.amity.co/#/Community/get_api_v3_communities__communityId__usersarrow-up-right.

chevron-rightCan the upload API accept a file via URL instead of requiring a local file upload?hashtag

Unfortunately, our API is designed to support uploads of files from local storage only, not from URLs.

chevron-rightWhy does my access token expire before the 30-day mark?hashtag

If you're using the same device ID when register session, it will cause the previously issued access token to become invalid.


Social and Chat

chevron-rightWhat is the purpose of targetType and targetId?hashtag

The targetType and targetId parameters are essential in query options for fetching posts from a specific feed.

  • targetType specifies the type of feed, which can be either ‘user’ or ‘community’.

  • targetId is the identifier for the specific feed, such as a userId for a user feed or a communityId for a community feed.

For a comprehensive explanation of these parameters and their usage, you can refer to the social.plus SDK documentation on querying posts: https://docs.amity.co/amity-sdk/social/posts/query-post

chevron-rightIs it possible to sort posts within a community by engagement, similar to the global feed?hashtag

Currently, posts within a community can’t be sorted by engagement like the global feed. The available sorting options for community posts are ‘lastCreated’ and ‘firstCreated’.

For more information on how to implement these sorting options, you can refer to the social.plus SDK documentation on querying posts: https://docs.amity.co/amity-sdk/social/posts/query-post

chevron-rightHow can I query communities while excluding the ones that have been deleted?hashtag

To exclude deleted communities from your query results, you can use different methods depending on whether you’re using the API or SDK:

  1. Using the API: When querying communities through the API at: Query communities APIarrow-up-right, include the parameter isDeleted: false in your request. This will filter out any deleted communities from the results.

  1. Using the SDK: If you’re utilizing the SDK, you can set the includeDelete: false parameter. This option allows you to control whether deleted communities are included in the query results. For more information on how to use this, visit social.plus SDK - Query Communities https://docs.amity.co/amity-sdk/social/communities/query-communities and adjust the includeDelete parameter as needed.

chevron-rightIs there a way to check which communities a user is part of?hashtag

Due to privacy and design considerations, it’s not possible to query communities joined by other users, even if you are an admin. However, the current user can query the communities they have joined themselves. This can be done through the API, as detailed at: Query communities APIarrow-up-right, by filtering for membership.

Alternatively, you can use the SDK, as explained in social.plus SDK - Query Communities https://docs.amity.co/amity-sdk/social/communities/query-communities.

chevron-rightWhy does querying a list of objects only return 20 items in the response?hashtag

This behavior is due to pagination implemented in our API endpoints and functions, which default to returning 20 items per page. To access more items, you need to use the next page token (Please refer to the API section above) or the nextPage() function, depending on the SDK you’re utilizing.

For detailed information on how pagination works for different SDKs, please refer to the Live Objects/Collections section in our documentation here: https://docs.amity.co/amity-sdk/core-concepts/live-objects-collections

chevron-rightHow can I update a community user’s role?hashtag

To update a user’s role in a community, you have two options:

  1. Using API: Add roles to community users APIarrow-up-right with the following cURL command:

  1. For Admin Users Using the Consolearrow-up-right: You can modify a user's role directly within the console. Follow these steps:

    1. Go to the specific community you wish to manage.

    2. Navigate to the 'Members' tab.

    3. Locate the user whose role you want to change.

    4. Click on the three dots button on the right-hand side.

    5. Select 'Change user role' from the options.

chevron-rightHow can I remove members from a community?hashtag

Members can be removed either through the SDK, as detailed here: https://docs.amity.co/amity-sdk/social/communities/community-moderation#remove-members, or by using the API, found at: Delete community users APIarrow-up-right.

chevron-rightHow can I delete a community?hashtag

You can delete a community using the API provided here: Delete Communityarrow-up-right APIarrow-up-right Alternatively, for admin users, you can also close a community directly from the social.plus consolearrow-up-right.

Here's how:

  • Navigate to the Community tab in the console.

  • Select "Communities."

  • Click on the name of the community you want to close.

  • Go to "Settings" page.

  • Scroll to the bottom where you will find the "Close Community" option.

chevron-rightI don't want the global feed to be empty for new users. How can I add some posts there?hashtag

You can implement an auto-join function, which can be called after a new user is created. To achieve this, use the join community API, which you can find here: Join community APIarrow-up-right. By doing this, existing posts in those particular communities will be displayed as the initial content in the global feed for new users.

chevron-rightWhat is metadata and its intended use?hashtag

Metadata consists of additional properties designed for custom fields. It serves to store supplementary data related to specific objects, like a user object, but isn't suitable for large amounts of data or information.

chevron-rightWhy is my global feed empty?hashtag

The global feed aggregates posts from communities you have joined and from users you are following. If you haven’t joined any communities or followed any users, there will be no posts for the global feed to display.

chevron-rightWhat are the image requirements for uploading?hashtag

The supported image formats for upload are JPG and PNG. Each image must not exceed 1GB in size. A post can contain up to ten images.

Additionally, on iOS & Android UIKit v4, any uploaded images or videos in unsupported formats, like HEIC, will be automatically converted to a suitable format before uploading.

chevron-rightWhat are the videos requirements for uploading?hashtag

The supported video formats include 3gp, avi, f4v, flv, m4v, mov, mp4, ogv, 3g2, wmv, vob, webm, and mkv. Videos must not exceed 1 GB in size and should have a maximum duration of 2 hours. Each post can contain up to ten videos.

Additionally, on iOS & Android UIKit v4, any uploaded videos (with HEVC encoding or HDR capabilities) will be automatically converted to a suitable video format before uploading.

chevron-rightAfter enabling secure mode and obtaining the auth token, do I need to generate an access token? What should I do with the auth token if I’m using the SDK?hashtag

When using the SDK, you only need the auth token, which should be provided when a user logs in or creates an account. The SDK will manage the process thereafter. For more information, you can refer to the social.plus SDK documentation on user creation: https://docs.amity.co/amity-sdk/core-concepts/user/create-user

chevron-rightWhy are the posts on my global feed not sorted by the most recently created?hashtag

Our global feed offers multiple sorting options, including sorting by factors such as Engagement Rate, Time of Posting, and Updates. Your feed may be currently sorted by other factors, if you wish to update or adjust the feed configuration, please reach out to our support team at [email protected]envelope

For more detailed information on custom post ranking, you can also refer to our documentation at Custom post rankingarrow-up-right.

chevron-rightHow can I retrieve a list of communities I have joined using the SDK?hashtag

To list the communities you've joined, you can use the queryCommunities function with the filter set to membership. For more information, refer to the documentation at https://docs.amity.co/amity-sdk/social/communities/query-communitiesarrow-up-right.

chevron-rightHow can I implement a file download feature?hashtag

To enable file downloading, incorporate the file ID into the download button's path. Use the following URL pattern, replacing "fileID" with the actual file ID:

Path: https://api.region.amity.co/api/v3/files/fileIDarrow-up-right

Additionally, leverage the SDK to retrieve the file ID. This approach allows for a seamless integration of the download functionality into your application.

Please ensure that your message or post is of the file type.

chevron-rightIs it possible for the social.plus UiKitChat Web UI Kit to automatically display the first chat upon user login, avoiding an empty space on the right?hashtag

To customize the UIKIT and make the first channel automatically open when a user logs in, you’ll need to make some changes to the code in the Amity-Social-Cloud-UIKit-Web-OpenSource/src/chat/components/RecentChat/index.js file.

Here are the steps to do that:

First, you’ll need to add an import statement for useState at the beginning of the file. Add this line to the top of the file along with other import statements:

Next, you’ll need to add some code inside the RecentChat component. Here’s the code you need to add:

By adding this code, you’re ensuring that when the component loads and there are channels available, it will automatically select the first channel in the list and set the hasInitialized state to true to prevent it from happening again.

chevron-rightHow can I check if there exists a chat channel between two users?hashtag

We recommend using our conversation channel, which offers the capability to check for an existing channel between users. For details, see Create Conversation Channelarrow-up-right.

chevron-rightHow can I query posts using tags[]?hashtag

To query posts by tags, format your query like this: tags[]=tag1&tags[]=tag2.

chevron-rightIs it possible to query comments by user ID?hashtag

Due to the design of our current product architecture, querying comments can only be performed using a post ID, not a user ID.


SDKs

chevron-rightWhat should I do if push notifications on iOS are not working?hashtag

If you already followed our docs here:

and it still doesn't work. Ensure you’ve covered all bases in this checklist:

• Verify that you’re using a production certificate.

• Check if the app_id matches the issued push certificate.

• Confirm the certificate hasn’t expired or been revoked.

• Make sure the app enables the “push notification” capability.

• Ensure the app is running in a production build (TestFlight/App Store).

• Run the app on a real device.

• Verify that the user hasn’t disabled push notifications for the app.

• Check if the user’s “Do Not Disturb” mode is activated.

• Ensure that your APNs authentication key is uploaded to Firebase: Linkarrow-up-right

chevron-rightCan I use my own realm in an iOS project?hashtag

No, we would recommend you use our realm which is included in the iOS SDK and UIkit. You can check the compatible version between the iOS SDK and Realm on our changelog page in the compatibility section and adjust the version accordingly.

For more information on the iOS SDK and UIKit, you can visit:

chevron-rightWhat type of certificate do I need to register push notification on iOS?hashtag

To register push notifications on iOS, you'll require a .p12 certificate. During the process, make sure to select "Apple Push Notification Service SSL (Sandbox & Production)"

For detailed instructions on setting up an iOS push certificate, please consult this documentation: iOS Push Notification Certificate Setuparrow-up-right.

chevron-rightCan I use a TypeScript CDN without a package manager?hashtag

It's not feasible to use a TypeScript CDN without a package manager. We recommend using package managers like npm or Yarn for support.

chevron-rightHow can I find out if I have blocked a user?hashtag

To check if you have blocked a user, refer to the "Blocked Users List" in the social.plus documentation. This section provides instructions on how to view and manage your list of blocked users. For more information, you can visit: https://docs.amity.co/amity-sdk/social/block-and-unblock-user#blocked-users-listarrow-up-right

chevron-rightHow can I mark a message as read, signaling to the backend that the message has been acknowledged?hashtag

You can mark messages as read using the Mark Message Readarrow-up-right function. After marking a message as read, you may proceed with actions such as notifications or updates to the backend. For detailed guidance, refer to the documentation on Start/Stop Reading a Subchannelarrow-up-right.

chevron-rightHow do I retrieve poll posts using Flutter?hashtag

The current Flutter SDK only supports video, image, and file post types. Support for Poll posts is anticipated in future updates.


Poll

chevron-rightWhat is the method for obtaining the list of voters for a specific answer in a poll?hashtag

To get the voters for a specific answer in a poll, you can utilize the API endpoint provided: Get a poll answerarrow-up-right. This API will return the user IDs of the voters along with their answers in the response.

chevron-rightCan I add a poll post with other attachments?hashtag

No, you can either create a poll or add a different type of attachment, but not both together.

chevron-rightHow can I view polls I've created in the Amity console?hashtag

Currently, polls are not viewable directly through the console. However, if you have access to the social.plus portal at https://portal.amity.co/arrow-up-right, you can find your polls by navigating to My Dashboard > Posts and selecting "Poll" from the dropdown menu in the top right-hand side. This will display your poll posts.


Console

chevron-rightWhere can I get my admin token?hashtag

To obtain your admin token, please follow these steps on the social.plus consolearrow-up-right:

  1. Navigate to "Settings" > "Admin Users"

  2. Click on the cogwheel icon

chevron-rightHow do I grant console access to my team members?hashtag

First, your portal owner/head of admins needs to create the initial admin user on the console. Subsequent admin users can then create or grant access to additional team members. To do this, navigate to ‘Settings’ > ‘Admin Users’ and click on the ‘Create New Admin’ button located at the top right of the page. Fill in the username and password; team members can use these credentials to access the console.

chevron-rightWho can upload a PNS Certificate file to the Push Notification section and how is it done?hashtag

Initially, only the portal owner can upload the PNS Certificate. They will find the option to do so by clicking on the “+ Add new certificate” button, which is exclusively available to them for the first upload.

chevron-rightWhy can't I retrieve posts from communities that a user has posted in when I use the 'User' option in the Post Management on social.plus console?hashtag

The 'User' option, found under the 'Posts' section with 'User' selected in the dropdown menu, is specifically meant for fetching posts from a user's feed. Please note that it is not intended to retrieve posts from communities where a user has posted, based solely on the user's ID.

chevron-rightHow can I obtain my API key and application region (endpoint)?hashtag

Please log in to your console, and you will find your API key and app region (endpoint) in the "Settings" > "Security" tab.

chevron-rightHow do I change my password on the console?hashtag

Changing the console password should be done through your super admin. Follow the provided steps for assistance.

chevron-rightWhy aren't conversation channels visible on the console?hashtag

Conversation channels are intentionally not accessible on the console by design. For further information on channel characteristics and this design choice, please visit Channel Characteristicsarrow-up-right.

chevron-rightWhy am I unable to activate my third push notification certificate?hashtag

On our console, you can only activate one push notification certificate per platform. It’s not possible to activate two iOS or two Android push notification certificates simultaneously.


Portal

chevron-rightHow do I create new app environments for different purposes, such as testing and production?hashtag

To create new app environments for various purposes, like testing or production, follow these steps:

  1. In the upper right corner, you'll find a "Create Application" button.

We recommend creating a separate application for each environment based on its specific purpose. This helps keep your testing and production environments organized and distinct.

chevron-rightHow do I upgrade my application pricing plan?hashtag

Unfortunately, upgrading your application plan is not available at the moment. We recommend creating a new application with your desired plan instead. If you no longer need your previous applications, we can assist you in deleting them.

chevron-rightHow can I change my organization name so that it reflects on my billing/invoice?hashtag

You can log in to your portal, navigate to the "Manage Payment" tab, and update the "Organization Name".


Alternative solutions for unsupported features

chevron-rightHow can I implement a feature that allows users to save their favourite posts?hashtag

For this use case, you can use our user's object metadata field to store the postId of the posts the user wants to save so that they can be extracted and fetched later. The saved content can be accessed from the user's profile or a dedicated section within the user interface. The exact implementation and design of this feature can vary depending on the specific requirements and design of your application.

chevron-rightHow can I add a Verified badge (blue tick) for users?hashtag

To add a Verified badge to a user’s profile, you need to update their user object’s metadata by including a ‘verified’ label. Once this label is in place, the frontend system can retrieve this information and display the Verified badge, styled as a blue tick or as per your custom design preferences. The verification process, governed by your frontend logic, ensures that the account meets your criteria for verification. After the account is verified according to these standards, you can then insert the ‘verified’ label into the metadata of the user’s profile.

chevron-rightHow to implement post sharing feature?hashtag
  1. To share a post, create a new post and specify the destination target for the shared content.

  2. In the metadata of the newly created post, include the original post's ID, for instance: "originalPostID": "abc".

  3. When retrieving the shared post, implement frontend logic to check for the presence of the "originalPostID" field in the metadata. If found, fetch the original post using the provided ID (e.g., by calling "get post") and display it on the frontend.

This approach enables you to maintain a reference to the original post, ensuring consistency in content, reactions, and comments.

chevron-rightHow can I set up email notifications for specific actions in my community, such as when a post is flagged?hashtag

For email notifications, you can leverage our webhook events triggered when a post is flagged. You can find more details in the documentation here:

To receive email notifications based on this webhook event, you may need to implement this functionality using a third-party tool that can send email notifications when the webhook event is triggered, such as when a post is flagged.

chevron-rightHow to pin a post?hashtag

While direct support for pinning posts is not available in Android UIKit versions below 4.0.0-beta14 and iOS UIKit versions below 4.0.0-beta15., you can implement a workaround by following these steps:

To Pin a Post:

  1. Add a new option to the three-dot menu of the post.

  2. Upon selection, implement logic to verify the user's role. If they possess a role that permits pinning posts, display the "Pin Post" option.

  3. When selected, use the social.plus SDK to update the community object’s metadata to include the pinned post.

To display the Pinned Post:

  1. When querying the community feed, you'll also retrieve the community object.

  2. Extract the “pinPostID” from the community object’s metadata.

  3. Use the social.plus SDK’s function to fetch the post using the “pinPostID”.

  4. Place this post object at the top of the community feed list array, ensuring it appears first.

chevron-rightHow can I limit channel creation permissions exclusively to admins?hashtag

There are two approaches:

1: Hiding the Channel Creation Button on the Front End

This is a simpler method where you can modify the user interface to hide or disable the channel creation button. This approach is straightforward and can be effective for casual users. However, it has a significant limitation:

  • Security Concern: Even if the button is hidden on the frontend, tech-savvy users might still be able to create channels using the API directly. This means that while the option may not be visible in the user interface, it’s not truly restricted at the system level.

2: Using the Pre-Hook Event Feature in the social.plus Max Package

If you are using the social.plus Max package, a more robust solution is available through the Pre-Hook Event feature 1arrow-up-right. This feature allows you to set up custom rules and control various aspects of your application, including channel creation.\

chevron-rightCan I filter to display only video posts from the global feed?hashtag

Although social.plus doesn't offer a built-in feature to filter posts by type directly in the global feed, you have the flexibility to create a custom filter on your frontend. Utilize the API to query posts by type at https://api-docs.amity.co/#/Post/get_api_v3_postsarrow-up-right, then display the filtered results on your frontend.

chevron-rightWhy does the audio message length display as 00:00?hashtag

Currently, SDK does not supply the duration of audio files. Nonetheless, there is a solution to show the audio duration:

  1. Upon finishing the audio recording, record the audio's duration within the message's metadata.

  2. To reveal the audio duration, retrieve this detail from the message metadata.

chevron-rightHow can I retrieve community posts by user ID?hashtag

You can utilize our search post APIarrow-up-right to filter posts by using the postedUserId parameter


Beta features

chevron-rightHow do you implement push notifications in Web React?hashtag

To implement push notifications in Web React JS, you can utilize our webhook eventsarrow-up-right. These events provide real-time updates on new posts and comments, including sender and receiver information. You can use this data to customize your push notifications with specific labels, details, and payload.

For a complete list of available webhook events, please visit: https://api-docs.amity.co/#/WebhookEvent

chevron-rightWhy does content search return fewer posts than the user has?hashtag

Content search will only return posts that were created after the content search feature was enabled. Posts created before the enablement will not be included in the content search response.

Please be aware that only posts created after the feature was enabled will be part of the search results.

chevron-rightHow do I find posts using hashtags?hashtag

When creating posts, you can include hashtags as you normally would. To search for these hashtags, we suggest using our content search feature, and including "hashtagList" in your query.

You can find comprehensive guidance on how to utilize this feature in our documentation here: https://docs.amity.co/developers/beta-features/content-searcharrow-up-right

chevron-rightHow can a user be informed when I begin following them?hashtag

To inform a user that they have gained a new follower through the API server, you can make use of social.plus's Webhooks. Webhooks enable the sending of real-time notifications for specific events, such as a user beginning to follow someone else. For comprehensive guidance on configuring and implementing Webhooks within social.plus, please consult the resources below:

For notifications related to follow events, you can utilize either of the following webhooks:


Frequent error types: Definition

chevron-rightWhy am I encountering this error “Error: Connect client first”?hashtag

This error typically arises when an SDK function is called before successfully establishing a connection to the social.plus session. To resolve this, ensure that you call UserRepository related functions only after the session state is set to ‘established’. You can monitor the session state using the following code snippet:

This code tracks the session state, and you should proceed with calling SDK functions once the state confirms the session is established.

chevron-rightI received the error “Query Token is invalid” What should I pass as the query token in Swagger?hashtag

The error indicates a problem with the pagination token. In the result response, a pagination token is provided at the end of the first page. You should use this token to fetch subsequent pages. The response typically includes a "paging" section with "next" and "previous" strings, like this:

Use the value from the ‘next’ or ‘previous’ string as your query token to access additional pages.

chevron-rightWhat does the error "Unable to use SDK while the SDK is logging in" mean?hashtag

This error occurs when the SDK login process is in progress while other actions are attempted. To resolve this, you should ensure that other actions are initiated only after the login process has successfully completed.

chevron-rightWhat does the error "RateLimit Exceed" mean?hashtag

Our API/function has a rate limit of 100 calls per user within a 5-second window. To avoid encountering this error, it is important to carefully monitor and control the number of calls made to ensure they do not exceed this defined limit.

chevron-rightWhat should I do when I encounter error code 400314 while attempting to post content with an image?hashtag

If you've encountered error code 400314 while trying to post content containing an image, it is likely related to our image moderation settings. To address this issue, follow these steps:

  1. Confirm whether you have enabled image moderation in your console settings. You can do this by accessing the consolearrow-up-right and checking the image moderation settings under Settings > Image Moderation tab.

  2. Adjust the confidence level in the console to an appropriate setting. For detailed instructions, please refer to this link: Image Moderation Settingsarrow-up-right.

  3. If you are curious about how the confidence level functions and have questions, you can find answers in our FAQ section: Image Moderation FAQarrow-up-right.

Please be cautious not to set the confidence level too low, as it may result in the blocking of all images.

chevron-rightWhy am I unable to post a link and receiving error 400309?hashtag

This error occurs because we have link moderation in place. You can manage this feature in the consolearrow-up-right by going to the "Moderation" > "Allow list" tab. If the feature is enabled, links that have not been added to the allow list will not be permitted to be posted in the community or chat.

chevron-rightWhat causes error 400311, also known as RPCRateLimitError, and how can it be fixed?hashtag

Error 400311, known as RPCRateLimitError, indicates that the API/function call rate limit has been exceeded, with a cap of 100 calls per user within a 5-second window. To resolve this, it's advisable to check for any processes that might be making repeated API or function calls in a loop, which could be causing the limit to be reached.


General

chevron-rightCan a user be restored after deletion?hashtag

Once a user is deleted using the API : Delete user APIarrow-up-right, it is not possible to undo this action. The user is permanently removed.

chevron-rightHow can I delete inactive users?hashtag

To delete inactive users, you can make use of the following API call:

Here's an example:

After the user is deleted, their display name will be automatically changed to 'Deleted user'. Please be aware that once users are deleted, there is no way to restore them.

chevron-rightWhat are the consequences for a user who is globally banned?hashtag

When a user is globally banned by an admin, they lose the ability to authenticate with ASC and are automatically removed from all their existing channels. Additionally, all of the banned user’s messages are deleted, although if these messages are already cached in the SDK, they will only disappear upon refreshing.

However, the user’s social content, including posts, comments, and community memberships, remains intact.

The globally banned user will be unable to authenticate with social.plus’s network again until the global ban is lifted.

chevron-rightHow are concurrent connections counted when a user opens multiple tabs?hashtag

Concurrent connections (CCU) are counted on a per-tab basis within the same web browser on the same device. If a user opens multiple tabs and all are active simultaneously, each active tab is counted as one concurrent connection.

However, browsers may close WebSocket connections for inactive tabs, so the CCU count typically reflects the number of active connections at any given time. For instance, if only one tab is active at a time, only one CCU is recorded.

chevron-rightIs there a dark theme option available in social.plus?hashtag

social.plus does not fully support a dark theme at the moment. However, you can customize the UI to create a dark theme using our open-source UIKit, which offers flexible UI customization options.

chevron-rightHow do I delete an unused application?hashtag

To delete an unused application, please contact our support team at [email protected]envelope, and they will assist you in fulfilling your request.

chevron-rightWhat defines an inactive user?hashtag

Inactive users are defined as the total unique users, identified by their user IDs, who have registered within the social.plus system but have not established any connection to any social.plus network during the specific month for which the Monthly Active User (MAU) count is being calculated. This includes users who may have registered at any time in the past, such as someone who signed up in January but has been inactive since then, and are still considered inactive in the subsequent months like May.

chevron-rightWhere can I download Figma files?hashtag

You can download Figma files from the following links:

chevron-rightCan social.plus accommodate multi-tenant systems?hashtag

social.plus can support multi-tenant systems by allowing the creation of multiple applications. Each application functions independently, maintaining its own separate data and content. This setup ensures that users cannot access content from other applications, effectively facilitating a multi-tenant environment.

chevron-rightCan social.plus be integrated with an external backend for file uploads instead of using social.plus's servers?hashtag

Currently, social.plus requires that all files be uploaded to its servers through the SDK/API. Using an external backend for file uploads is not supported.

chevron-rightIs there a way to obtain account-wide data, not limited to individual apps?hashtag

Regrettably, metrics such as Monthly Active Users (MAUs) and engagement figures are only available on an individual application basis. These statistics can be accessed through our dashboard and console.

For an in-depth guide to the dashboard, you can refer to the social.plus Portal Dashboard Guidearrow-up-right. For console access, visit https://asc.amity.co/arrow-up-right and navigate to the usage page.

chevron-rightHow can I include HTML tags, such as <b> or <i>, when sending a message or creating a post on social.plus via API?hashtag

social.plus places a high priority on backend security to protect against injection attacks, including XSS, with all security measures undergoing periodic penetration testing. It's important to note that the frontend application is also susceptible to XSS attacks, which are beyond our control.

The social.plus API processes post messages as plain text and does not natively support rich text formatting, like bold, italic, or hyperlinks. This design choice is made to safeguard data security and integrity and to mitigate the risk of cross-site scripting (XSS) attacks.

Nonetheless, the capability to support text formatting rests with the client-side editor and message renderer. You have the option to implement a system on your frontend that accommodates text formatting. For instance, employing a markdown language to encase text with specific symbols allows your frontend to identify and render the text according to the intended formatting.

chevron-rightAre .gif files supported by social.plus?hashtag

Currently, .gif files are not supported for posts or messages on social.plus.


Dashboard

chevron-rightWhat is lurking users?hashtag

Lurking users refer to individuals who solely view content without actively participating by posting, commenting, or engaging with the group or other users.

chevron-rightHow can I access metrics regarding conversations, like the number of messages sent per day?hashtag

This data can be found on our dashboard. Please go to the Channels section, where you'll find the "New Messages by Day" widget.

Last updated

Was this helpful?