API Architecture

API Reference

The framework organizes APIs into four primary families, each serving specific extensibility needs:

Interaction API Family

Controls and monitors customer interactions throughout their lifecycle. Initiate new voice and chat interactions, execute controls (transfer, consult, conference), and subscribe to interaction events.

See Interaction API Family Reference

Media API Family

Manages channel-specific capabilities including DTMF tones on voice channels and rich text messages with formatting and attachments.

See Media API Family Reference

Agent API Family

Manages agent presence and availability. Modify agent state and subscribe to state change notifications.

See Agent API Family Reference

Admin API Family

Provides environmental and configuration data including logged-in agent context, users, queues, and reason codes.

See Admin API Family Reference

ElementAPI

The main class for interacting with the Infinity Extensibility Framework. It handles:

API requests to core-agent-ui via window.postMessage
Event subscriptions for interaction lifecycle
Inter-element communication via BroadcastChannel

See Element API Class

Resources

API Reference | Code Samples