Documentation Index
Fetch the complete documentation index at: https://developers.voxys.ai/llms.txt
Use this file to discover all available pages before exploring further.
Welcome to the Voxys Connect API documentation. Whether you’re building custom workflows for your support team, integrating Voxys Connect into your product, or automating WhatsApp messaging, our APIs provide the flexibility and power you need.
Application APIs
Core APIs for managing your Voxys Connect account — agents, contacts, conversations, inboxes, webhooks, automation, and more.
- Authentication: Requires a user
access_token from Profile Settings.
- Base URL:
https://connect.voxys.ai/api/v1/accounts/{account_id}/
Client APIs
Build custom messaging experiences. If you’re not using the native widget or want to embed chat in your mobile app, these are for you.
- Authentication: Uses
inbox_identifier (from Settings > Configuration in API inboxes) and contact_identifier (returned when creating a contact).
CRM APIs
Manage your sales pipeline with leads, companies, pipeline stages, funnel cards, follow-up tasks, and conversation CRM sidebar.
WhatsApp APIs
Create and manage WhatsApp message templates, interactive flows, and product catalogs. Submit templates to Meta, schedule messages, and track delivery.
Campaigns & Messaging
Create campaigns, manage audiences via CSV or contact lists, schedule sends, track real-time execution progress, and export outbound reports.
Appointments
Full appointment booking system — services, providers, availability checks, booking confirmations, cancellations, rescheduling, and reminders.
Projects & Collaboration
Project management with tasks, milestones, members, discussions, and internal team chat channels.
AI & Analytics
Customer Pulse sentiment analysis with Arabic dialect detection, agent performance metrics, and leads reporting.
FAQ
What should I do if the API documentation appears outdated?
If you encounter discrepancies between the API documentation and actual API behavior, inspect the actual requests made by the Voxys Connect UI through your browser’s developer console Network tab to see the exact request format and payload structure.
