Vinix· docs
API referenceCore API

Core API overview

The full Vinix voice and platform surface — organized into eight topical areas.

Sandbox is coming soon

Today, requests on this page run against your live account. A hosted sandbox with simulated PSTN is on the roadmap — until then, use a non-production user or callflow when experimenting.

Details

The Vinix Core API is organized into eight topical areas that match the shape of a real telecom integration.

By topic

Identity

Multi-tenant accounts and the entities that live inside them.

FamilyCommon operations
Accountsget, update, list children, create child, move, reseller
Userslist, get, create, update, delete
Groupslist, get, create, update, delete
Directorieslist, get, create, update
Hotdeskshotdesk login / logout
Deviceslist, create (returns SIP creds once), get, update, delete

Call Control

How calls are routed and shaped.

FamilyCommon operations
Callflowslist, get, create, update, delete
Metaflowsruntime call-control via DTMF
Menus (IVR)list, get, create, update, delete
DialplansE.164 normalization rules
Temporal Rulestime-based routing
Temporal Rule Setsgroups of temporal rules

Voice Capabilities

Live calls, recordings, conferencing, fax, and reporting.

FamilyCommon operations
Channelsenumerate active calls
Click-to-calltrigger outbound from web
Quickcalloriginate from a user or device
Parked Callscall park / retrieve
Recordingslist, get, delete recordings
Mediaupload / manage audio assets
Conferenceslist, get, create, participants, mute, kick
Faxessend, list, attachments
Faxboxesfax line config
Call Reports (CDRs)list (with created_after), get
Call Inspectorlow-level SIP / media inspection

Numbers & Trunks

Telephony resources: DIDs, port-in, SIP termination.

FamilyCommon operations
Phone Numberslist, search, claim, release, port-in
Port Requestssubmit, advance state, attachments
Trunks (resources)list, get, create, update, delete
Resource Selectorsroute selection rules
Resource Templatesreusable trunk configs

Messaging

Text messaging and voicemail mailboxes.

FamilyCommon operations
SMSsend, list, get — coming soon
MMSsend media messages — coming soon
Voicemail Boxesboxes, messages, audio download

Events & Notifications

Real-time push and configurable notification templates.

FamilyCommon operations
Webhooksevent subscriptions
Websocketsactive sockets + binding catalog
Notificationstemplate management

Contact Center

See the Contact Center section for Queues, Recipients, Reports, Features, and the dedicated websocket event bindings.

System Administration

Security, billing, and operational resources.

FamilyCommon operations
Access Listsper-account IP allowlist
ACLsnetwork ACLs
Blacklistscaller-ID blacklist
IPsIP-auth allowlist
Allotmentsusage allowances
Limitsper-account caps
Connectivitytrunk / connectivity config
Listsmatch lists for callflow modules
Rate Limits (SIP)SIP packet rate limits at the SBC
RegistrationsSIP device registrations
PresenceBLF / status
Alertsaccount-level alerts
Servicesservice plans, billing reconciliation

Mental model

Three concepts repeat throughout:

  1. Account scope. Every resource path starts with /accounts/{account_id}. Sub-accounts are first-class — your top-level account can own many, each with their own users, devices, and callflows.
  2. Callflows are the control plane. A PhoneNumber is bound to a Callflow. The callflow is a tree of modules (ring_group, voicemail, menu, etc.). When a call lands on the number, Vinix executes the tree.
  3. Devices register, calls flow. A Device is a SIP endpoint (Yealink, Poly, softphone, WebRTC). A Channel is a live in-progress call. A Cdr is written when the call completes — immutable and billed.

Picking up where you left off

API reference

One auth token. Five product surfaces. Everything you need to build on Vinix.

Create account PUT

Next Page

On this page

By topicIdentityCall ControlVoice CapabilitiesNumbers & TrunksMessagingEvents & NotificationsContact CenterSystem AdministrationMental modelPicking up where you left off