Bot user API
Easily manage your bot user interactions with Flexito's OmniAI API. Whether it's adjusting scheduled messages, managing user tags, or accessing chat histories, this guide simplifies complex API tasks into straightforward actions. No coding expertise is necessary, making it perfec
Listen to an audio overview
A short, AI-generated podcast-style summary of this article.
Easily manage your bot user interactions with Flexito's OmniAI API. Whether it's adjusting scheduled messages, managing user tags, or accessing chat histories, this guide simplifies complex API tasks into straightforward actions. No coding expertise is necessary, making it perfect for users looking to enhance their bot's responsiveness and efficiency.
Accessing bot user data or using the Flexito OmniAI API can be challenging without coding skills. Our straightforward method allows you to use API endpoints easily, with no coding needed.
Accessing API Endpoints
To access API endpoints, go to the Flow Builder. Select an action block, choose "Advanced actions," and then explore the "Bot User API" options available.
Description (#BotuserAPI-Description.1)
How to Remove All Scheduled Messages (#BotuserAPI-HowtoRemoveAllScheduledMessages)
Use Cases (#BotuserAPI-UseCases.1)
Response (#BotuserAPI-Response.1)
Available Actions
List all tags
Check if the user has a certain tag
Add or remove tags
List subscribed sequences
Retrieve shopping cart details
List shop orders
List chat text messages
List Tags
You can retrieve a list of all tags for testing by using the User_NS. For permanent storage, use the system fields Username, First Name, and Last Name.
Check for Tag
To verify if a user has a specific tag, input the User NS and Tag Ns.
Locating Tag Ns:
Go to Contents -> Tag. Hover over the Tag to see the Tag Ns.
Add Tag
To assign a tag to a user, simply select the appropriate Tag NS.
Remove Tags
Removing tags is similar to adding them. Just enter the Tag NS to remove the tags.
Remove All Tags
This action is automatic. No input is needed; it will remove all tags from the user.
List Subscribed Sequences
Enter the user's username or first name to get a list of subscribed sequences for testing.
List Cart Items
You can obtain a list of all items currently in the user's shopping cart.
List Shop Orders
Receive a list of all orders placed by the user.
List Chat Messages
Access the last 50 chat messages. You can include agent and bot messages and choose the format (default, text, or text with time) as needed.
Remove All Smart Delays
Description
The "Remove All Smart Delays" action clears all smart delay actions for a specific bot user. This is useful for removing queued delays instantly, allowing the bot to respond immediately.
How to Remove All Smart Delays
Navigate to the Flow, select an Action Node, and choose "Advance Action." Then, select the "Bot User API" option.
Next, choose the "Remove All Smart Delays" action.
Add the User NS for the user whose smart delays you want to remove, or use a System Field containing the User NS.
In the sample data, you will see status: "ok" and delete: "0," indicating that all smart delays have been successfully removed.
Use Cases
Instant Reset: Quickly remove all pending delays for a user to enhance response times.
Response
Success: Returns a 200 OK status with a message confirming the removal of all smart delays.
Error: Provides an error code if the User NS is not found or if the request fails.
Remove All Scheduled Messages
Description
The "Remove All Scheduled Messages" action deletes all scheduled messages for a specific bot user. This ensures no further scheduled messages are sent, allowing for swift changes in user interaction plans.
How to Remove All Scheduled Messages
Go to the Flow, select an Action Node, and choose "Advance Action." Then, select the "Bot User API" option.
Next, choose the "Remove All Scheduled Messages" action.
Add the User NS for the user whose scheduled messages you want to remove.
In the sample data, you will see status: "ok" and delete: "0," indicating that all scheduled messages have been successfully removed.
Use Cases
Bulk Message Removal: Quickly clear all pending messages to prevent sending outdated information.
Precise Flow Adjustment: Remove all queued messages to update user interaction plans immediately.
Response
Success: Returns a 200 OK status with a message confirming the removal of all scheduled messages.
Error: Provides an error code if the User NS is not found or if the request fails.
Find Bot Users by Phone
Search for users via bot or workspace by entering their phone number to find their profile.
Find Bot Users by Email
Look up users in the bot or workspace using their email address.
Find Bot Users by User ID
Locate a user within the bot or workspace using their unique user ID.
Merge Bot User
Combine a secondary bot user with a primary (current) bot user.
All relevant data from the secondary user will transfer to the primary user.
You can delete the secondary user after merging or keep their profile.
List Labels
Retrieve all labels assigned to a specific user.
Check for Label
Verify if a specific label is assigned to a user by entering the label name.
Add Label
Provide the label name and assign it to the desired user.
Remove Label
Remove a specific label from a user by entering the label name.
Remove All Labels
Remove all labels assigned to a user.
Get Chat Message
Retrieve a specific chat message using its message ID (MID).
List Closing Notes
Get all closing notes associated with a user.
Append Assistant Message to AI Agent Messages
AI responses generated outside the AI agent are not automatically saved in the AI agent’s message history. To resolve this, a new action in the Bot User API section allows developers to manually add these responses to the AI message history. Use the "Append Assistant Message to AI Agent Messages" action to include it in the relevant chat history.
Note: This action stores messages in live mode, not in testing.
Video Tutorials
Here you can see how it looks as an example: