ConvortAI Documentation

ConvortAI Documentation

Set up your WhatsApp instance, configure AI behaviour, organize customer operations, and understand supported integrations.

Quick Setup Journey

Get Started in 8 Step-by-Step Actions

Follow this clear rollout path to connect your WhatsApp instance safely, configure AI guidance, and prepare your team for live customer conversations.

1

Account Access

Create your ConvortAI workspace account or sign in to your existing team workspace.

2

Create WhatsApp Instance

In your workspace dashboard, create a new WhatsApp instance for your business phone number.

3

Open WhatsApp Linked Devices

On your physical business phone, open WhatsApp > Settings or Menu > Linked Devices > Link a Device.

4

Scan Displayed QR Code

On your phone, open WhatsApp, go to Linked Devices, choose Link a Device, and use the WhatsApp scanner to scan the QR code displayed in ConvortAI.

5

Configure Business & AI Rules

Set your business type, AI persona, language preference, tone, and specific business instructions.

6

Add Products & Knowledge

Add product catalog items, custom confirmation fields, saved media groups, or automated response sequences.

7

Test Bot in Trial Chat

Send test messages from another WhatsApp number to review reply quality, business information, media responses, and staff takeover behaviour where configured.

8

Review Wallet & Controls

Confirm your wallet balance, check metered usage rates, and train staff on human takeover and AI pause controls.

Documentation Categories

Browse Structured Categories

Explore seven distinct operational sections to find exact setup guides, technical specs, and practical troubleshooting.

Instance & Connection Guide

WhatsApp Instance & QR Linking Flow

Understand how your WhatsApp instance connects to ConvortAI, how sessions are maintained, and how to reconnect cleanly when needed.

1. Create Instance
Generate instance ID in dashboard
2. Display QR
Wait for ready status in UI
3. Link a Device
Open WhatsApp > Linked Devices
4. Connected State
Session verified and ready
Operational ActionProcedure & ExpectationsStatus / Outcome
Instance CreationCreate a dedicated WhatsApp instance entry in your ConvortAI workspace dashboard. Align instance ownership with the team member responsible for the phone.Ready for QR
QR Scan via Linked DevicesOn your phone, open WhatsApp, go to Linked Devices, choose Link a Device, and use the WhatsApp scanner to scan the QR code displayed in ConvortAI.Connected
ReconnectionIf network disruption occurs, ConvortAI attempts automatic background socket reconnection. Keep the phone connected to active internet.Reconnecting
Reset LoginUse Reset Login when changing the linked phone or clearing a stuck session. This removes active auth credentials and presents a fresh QR code.Session Cleared
Linked Device Session Ownership Notice
Logging out of the linked device on the physical phone disconnects the session immediately. ConvortAI relies on standard WhatsApp Linked Devices pairing; keeping the phone powered and connected to internet prevents avoidable disconnections.
AI & Business Knowledge Guide

AI Configuration & Reply Behavior

Learn how to define your AI assistant persona, supply structured business context, select reply modes, and manage human handoff.

Configuration FieldDescription & Operational PurposeBest Practice / Recommendation
Bot Name & Business TypeIdentifies your AI assistant persona and primary business domain (e.g. Retail, E-commerce, Clinic, Real Estate).Use your official brand name and specific industry for grounded context.
Language PreferenceSets primary response language (e.g., English, Urdu, Roman Urdu, or multilingual auto-detection).Define Roman Urdu or English clearly if your audience mixes both in chat.
System InstructionsCore rules, greeting guidelines, fallback instructions, and boundaries the AI must observe during chats.Keep instructions concise, bulleted, and factual. Avoid vague or conflicting prompt text.
Catalog & Product ContextProduct catalog details, item pricing, stock status, variants, and service terms used for customer inquiries.Keep item titles and prices updated so AI replies match current inventory.
Admin WhatsApp NumberDesignated staff WhatsApp number to receive immediate alert notifications when orders or handoffs occur.Ensure the admin number is actively monitored during business operating hours.

Supported AI Reply Modes

Text Preferred (Recommended)

Understands incoming voice notes and text messages, but responds in clean text by default. Provides optimum cost control and fast reviewability.

Customer Preference

Mirrors the customer's format—replying in voice notes when audio is received, and in text when text is received.

Always Text

Forces all outgoing AI replies to remain strictly formatted as text messages, regardless of incoming customer media.

Always Voice

Generates audio voice responses for every customer interaction where voice output is supported in your workspace plan.

Human Takeover & AI Pause Controls
Staff can pause AI replies, take over a conversation, and resume automation where supported. When a team member sends a message in a customer thread or triggers a pause control, ConvortAI pauses automated replies for that thread so humans maintain full authority.
Media & Automation Guide

Media Library, Groups & Sequence Workflows

Organize reusable photos, media collections, and automated conversation sequences to handle repeated customer inquiries efficiently.

Automation ElementDefinition & Operational FunctionUsage & Behavior
Media LibraryIndividual stored image, video, audio, or document files uploaded to your workspace.Used for single asset attachments in product or support replies.
Media GroupA named collection of related media items (e.g., catalog photos, size charts, portfolio items).Delivered together in response to relevant customer requests.
Sequence GroupAn ordered chain of messages, media sends, and delay intervals configured for automated execution.Executes multi-step outreach or customer follow-up flows.
Welcome SequenceAutomated sequence triggered when a new customer initiates their first conversation.Introduces your business and prompts for initial inquiry details.
Keyword SequenceSequence triggered automatically when an incoming message matches configured keyword triggers.Delivers specific info when terms like "pricing", "catalog", or "location" match.
Shortcut SequencePre-configured sequence triggered manually by staff from the dashboard thread view.Allows staff to send multi-message templates with a single action.

WhatsApp Groups as Content Libraries

Where configured in your workspace, dedicated WhatsApp groups can serve as live content libraries. Uploading media or templates to a designated content group allows ConvortAI to index those assets for customer automation.

Content Group
Upload media to designated WhatsApp group
Asset Indexing
ConvortAI registers media & captions
Customer Delivery
AI delivers matching media in customer chats
Customer Operations Guide

Customer 360, CRM & Order Operations

Manage customer records, track conversation history, capture structured orders, and supervise CRM pipeline progression.

Customer 360 Profiles

Consolidates phone numbers, display names, custom confirmation fields, total conversation history, and order count into a unified operational profile.

Workspace Orders

Captures structured order details during chat conversations, including item selections, custom confirmation field values, shipping details, and status.

CRM Pipeline Stages

Organizes customer threads by operational stages (e.g., New Lead, Info Sent, Order Pending, Confirmed, Completed) for team oversight.

Follow-ups & Updates

Schedules automated follow-up prompts and sends delivery or status updates to customers based on workspace activity.

Operational Handoff Lifecycle

1. Inbound Inquiry
Customer messages on WhatsApp
2. AI Processing
Grounded AI replies & captures details
3. Order / Lead Created
Structured entry recorded in workspace
4. Human Handoff
Staff steps in or resumes as needed
Integrations & Logistics Guide

Logistics & Catalog Integration Scope

Understand how courier tracking and product catalog context operate within your ConvortAI workspace settings.

WooCommerce Product Catalog

Configured or imported WooCommerce product catalog data can be formatted into AI context where available.

Scope Notice: Product context grounding is manual or static; ConvortAI does not automatically connect to WooCommerce APIs, perform real-time store inventory sync, or retrieve WooCommerce orders.

PostEx Logistics

Connect PostEx courier merchant credentials to perform parcel tracking lookups and generate booking payloads where configured.

Scope Notice: Operational availability requires valid merchant API tokens configured in dashboard settings.

Leopards Courier

Connect Leopards Courier merchant credentials for consignment tracking lookups and booking dispatch within supported setups.

Scope Notice: Dispatch operations depend on active merchant account credentials and courier server availability.
API & Platform Architecture Scope
ConvortAI is managed through the secure workspace dashboard UI. ConvortAI does not publish an external public REST API or Bearer token interface. Never share or disclose workspace login credentials or API keys publicly.
Plans & Wallet Guide

Subscriptions, Wallet & Usage Rates

Understand how monthly subscription plans, optional services, and metered usage rates operate separately in ConvortAI.

Starter
$9 /mo
  • Core WhatsApp workspace plan
  • 7-day trial with $1 AI credit
  • Standard AI response features
Growth Popular
$29 /mo
  • Growth WhatsApp workspace plan
  • 7-day trial with $1 AI credit
  • Expanded workspace operations
Pro
$89 /mo
  • Pro WhatsApp workspace plan
  • 7-day trial with $1 AI credit
  • High-volume workspace capacity

Metered Usage Rates (Deducted from Wallet)

Minimum wallet top-up: $5. Optional Full Setup Service: $49.

Usage ItemExact Approved RateBilling Rule
AI text$0.003 per replyDeducted when AI generates a text answer for an incoming customer message.
Image$0.007 per imageDeducted when AI processes an incoming customer image.
Voice note$0.010 per voice noteDeducted when processing incoming customer voice audio transcription.
Generated voicefrom $0.020 per replyDeducted for generating outgoing audio voice note responses.
Sequence or template$0.0005 per itemDeducted per item when an automated sequence or template step is dispatched.
Media file$0.001 per fileDeducted per file when media assets are sent in conversation.
Subscription Plan vs. Metered Usage Notice
Subscription fees and metered usage charges apply separately. Monthly plan fees cover your workspace dashboard access. Metered usage charges are deducted from your wallet balance per item. Minimum wallet top-up is $5. All plans include a 7-day trial with $1 AI credit. Optional Full Setup Service is available for $49.
Safety & Client Responsibility

Launch Safety & Compliance Guidance

Best practices for operating WhatsApp automation responsibly, maintaining account safety, and understanding client obligations.

1. Dedicated Business Line

Use a dedicated business phone number for automated WhatsApp customer conversations rather than personal personal lines.

2. Avoid Bulk Unsolicited Spam

Only message customers who have opted in or contacted your business. Sending unsolicited bulk messages violates platform terms and risks number restrictions.

3. Relevant & Grounded Content

Keep AI instructions grounded in real product details, accurate pricing, and clear terms. Vague or deceptive replies damage customer trust.

4. Credential & Key Security

Keep workspace passwords, API keys, and session links confidential. ConvortAI support will never ask you to share passwords or API secrets.

Platform Risk & Client Legal Responsibility
Clients remain solely responsible for product pricing, refund policies, delivery commitments, customer consent, privacy compliance, and lawful messaging. WhatsApp Linked Devices automation carries platform risk. ConvortAI does not make legal guarantees or claim zero risk of number limitation by Meta/WhatsApp.
Troubleshooting Guide

Practical Troubleshooting & Diagnostics

Step-by-step diagnostic guidance for connection issues, media delivery, sequence triggers, and login resets.

QR code is not appearing in the connection panel

Likely Causes
Network latency between dashboard and server, or previous instance socket closing.
Safe Checks
Refresh your browser page, verify internet connection, and wait 10-15 seconds for status refresh.
When to Reset Login
Use Reset Login if the panel stays in 'Initializing' for more than 2 minutes.
When to Contact Support
Contact support@convortai.com if QR fails to generate after Reset Login.

QR code expired before scanning

Likely Causes
WhatsApp QR codes refresh every 20-30 seconds for security.
Safe Checks
Keep your phone's WhatsApp Linked Devices screen open and ready before refreshing the QR code.
When to Reset Login
Click Refresh QR in the connection panel.
When to Contact Support
Contact support if new QR codes do not appear upon refresh.

Connection state stuck in 'Reconnecting'

Likely Causes
Business phone lost internet access or phone battery saver killed background WhatsApp service.
Safe Checks
Check that your physical phone is powered on, connected to Wi-Fi/data, and WhatsApp is open.
When to Reset Login
Use Reset Login if the phone shows Linked Devices active but ConvortAI shows disconnected.
When to Contact Support
Contact support if reconnect fails while phone internet is confirmed active.

WhatsApp logged out notification on phone

Likely Causes
Session was manually logged out from Linked Devices on the physical phone.
Safe Checks
Open ConvortAI dashboard and click Reset Login to generate a fresh QR code for pairing.
When to Reset Login
Reset Login is required to re-establish the session pairing.
When to Contact Support
Not needed unless QR scanning fails repeatedly.

Media file or group fails to send in chat

Likely Causes
Uploaded file exceeds WhatsApp file size limits or storage URL is broken.
Safe Checks
Check Media Library in workspace settings to ensure the asset file URL is valid and under 16MB.
When to Reset Login
Re-upload the media file or recreate the media group.
When to Contact Support
Contact support if verified media files consistently fail to deliver.

Keyword or Welcome Sequence does not fire

Likely Causes
Sequence is toggled inactive, customer is currently in human takeover state, or keyword exact match failed.
Safe Checks
Check if the conversation is paused by staff. Verify keyword spelling and active sequence toggle.
When to Reset Login
Toggle the sequence off and back on in workspace settings.
When to Contact Support
Contact support if active sequences fail for non-paused threads.

AI reply is vague or unaligned with business rules

Likely Causes
System instructions are missing specific product context or conflicting prompt rules exist.
Safe Checks
Review AI System Instructions and Product Catalog entries for clarity and specific wording.
When to Reset Login
Update instructions and test in a trial thread.
When to Contact Support
Contact support if prompt updates do not refine AI output.

Courier tracking lookup returns no result

Likely Causes
Invalid tracking number format, incorrect merchant API token, or courier API downtime.
Safe Checks
Verify PostEx / Leopards API key in workspace settings and test tracking number directly on courier site.
When to Reset Login
Re-enter merchant credentials in courier settings.
When to Contact Support
Contact support if valid API keys return repeated authentication errors.
Documentation FAQ

Frequently Asked Questions

Factual answers to common questions about setup, connection, reply modes, billing, and support.

No. ConvortAI uses QR-based WhatsApp Linked Devices session pairing. It does not claim Meta Cloud API connection or Meta partnership on the public website.
Get Started Today

Ready to Configure Your ConvortAI Workspace?

Start your 7-day trial with $1 AI credit or reach out to official support for custom onboarding guidance.