Getting started
Introduction
What Vinix is and how the API is organized.
Vinix is a unified communications platform. A single account gives you programmable voice (PSTN calling, SIP trunks, callflows), video (Vinix Work meetings), SMS / MMS, and embeddable browser surfaces (Web Pulse click-to-call, SecureCall E2EE).
Surface map
| Product | Use it for | API path |
|---|---|---|
| Core | Voice, SMS, accounts, devices, CDRs | /v2/accounts/{id}/... |
| Vinix Work | Video meetings, recordings | Coming soon |
| Web Pulse | Embed click-to-call on any page | Coming soon |
| SecureCall | E2EE voice for regulated workloads | Coming soon |
| Reservations | Calendared booking flows | Coming soon |
All endpoints share one auth-token surface, one webhook signing secret, and one billing relationship.
Base URL
All requests target an environment-specific base URL:
- Production —
https://api.vinixglobal.com/v2 - Sandbox —
https://api-sandbox.vinixglobal.com/v2
Sandbox is free, isolated, and pre-seeded with users, numbers, and a default callflow. PSTN calls don't dial out — they're simulated end-to-end so you can develop without burning trunk minutes.
What's next
- Get an API key.
- Run the quickstart.
- Wire up webhooks so your service knows when calls complete, SMS arrives, or meetings end.

