Experience Provider Documentation

The Crux API lets your software receive or answer phone calls on Alianza-powered carrier networks — one integration reaches every carrier, and carriers can be added or removed without changes to your code.

Choose your path

  • New to the platform? Start with Concepts → Overview — the Experience / Connection / Assignment model that everything else builds on.
  • Want to see the API respond first? Each quickstart runs the full loop — token → eligibility → connection → assignment → activate — in a few minutes: Post-Call or Virtual Agent.
  • Ready to integrate? Pick a journey below. Both share the same auth, eligibility check, and connection model.

Which Experience type?

Post-Call Virtual Agent
What your software does Observes calls passively — receives a copy of the audio and metadata without affecting the conversation Answers calls actively — holds a real-time conversation with the caller and decides what happens next
Assignment target An account (all current and future users) A phone number
You receive SIPREC (RFC 7866) sessions on your Session Recording Server (SRS): dual-channel SRTP audio plus an XML metadata document per call SIP (RFC 3261) inbound INVITEs on your endpoint; call media flows over WebSocket
Common uses Compliance recording, transcription and conversation analytics, voice-of-customer research, fraud detection, ML training pipelines AI receptionist, IVR replacement, voice self-service, conversational commerce, triage and routing
Journey Enabling a Post-Call Experience Enabling a Virtual Agent Experience
Quickstart Post-Call quickstart Virtual Agent quickstart

How it's designed

A few properties of the API that shape what you do — and don't — have to build:

  • One integration surface. You integrate once against the Alianza platform, not per carrier. Carriers are added or removed on the Alianza side without changes to your code.
  • Standard protocols only. SIPREC for Post-Call, SIP for Virtual Agent. Your existing media tooling works; there is no Alianza-specific media protocol to implement.
  • Explicit per-target scoping. Calls flow only for the users or phone numbers provisioned to your Experience — you never receive traffic you didn't ask for.
  • No carrier tenancy to model. A telephoneNumber query parameter on connection creation resolves the right Alianza account automatically; you don't need to know which carrier serves which customer.
  • Standard OAuth2. Client Credentials for server-to-server calls, Authorization Code + PKCE when acting in a user's context — no custom auth scheme.
  • Recording never blocks calls. For Post-Call, SIPREC delivery is best-effort: if your SRS is unavailable, the customer's call completes normally.

Also in this portal