Concepts

The Orchestration API has three resources, used together:

Resource What it represents
Experience Your integration as Alianza sees it. Created and identified by Alianza during onboarding. You receive an experienceId (UUID); the API does not expose an endpoint to retrieve Experience metadata.
Experience Connection The link between your Experience and a single Alianza account. Has a state (INACTIVE or ACTIVE) that controls whether SIP/SIPREC traffic flows.
Experience Assignment Binds your Experience to a specific target — an account, a user, or a phone number — within a connected account. Assignments are what determine which calls Alianza will send to you.

The integration lifecycle, in plain terms:

  1. Validate that a target (typically a phone number) is eligible for your Experience.
  2. Connect your Experience to the user's Alianza account by creating an Experience Connection.
  3. Assign the Experience to either the account (Post-Call) or a phone number (Virtual Agent).
  4. Activate the connection — flip it to ACTIVE so media can begin flowing.
  5. Receive media — SIPREC recording sessions (Post-Call) or inbound SIP calls (Virtual Agent).

The two journeys differ mainly at step 3 (target type) and step 5 (media protocol). Steps 1, 2, and 4 are identical.

An Alianza account represents a residential or business customer of a Service Provider using Alianza infrastructure to deliver service.

Spec gap. The relationship between Experience type (POST_CALL, AGENT, INSIGHTS) and valid targetType values is documented inline on the ExperienceAssignment.targetType reference, but the spec does not define an Experience resource or expose its type. Alianza provides this metadata out-of-band during onboarding; confirm allowed combinations with your Alianza contact before going live.

Gap ID 36b674cb8d09

See also