Skip to main content

Endpoints

platform v0.9.11verified 2026-05-14

An endpoint is the entry point for interactions with the platform. It defines how a session arrives — phone call, browser voice, or web chat — and which flow handles it.

Where endpoints live

There is no longer a top-level /endpoints page. Endpoints are managed inside the Flow Designer for the owning app — open Flow Settings → Endpoints, or click any Entry Point chip on the canvas. This page is a concept reference.

Endpoint types

TypeDescription
PhoneInbound phone calls via PSTN / SIP. Requires a base number.
Web VoiceBrowser voice calls via the TelPhi SDK (WebRTC). Identified by slug.
Web ChatText / chat sessions via the SDK (WebSocket or REST). Identified by slug.

Common fields

All endpoint types share:

  • Type — the choice above (phone, web voice, web chat).
  • Active — derived from whether the flow has at least one published version pointing here.

The rest of the fields are type-specific.

Phone (PSTN)

FieldRequiredDescription
Base NumberYesBase phone number assigned to the team by a platform admin. See Base Numbers.
Extension CodeConditional3-digit extension code. Required if the base number has extensions enabled. Must be unique within the base number.
Egress Base NumberNoBase number with an egress trunk used for outbound transfers from this endpoint.

Audio codecs are resolved automatically from the provider configuration on the voice-agent node — the Asterisk ↔ TelPhi link picks the best match for the AI model's native sample rate (e.g. slin24 for OpenAI Realtime, slin16 for Azure STT). Advanced users can pin audio.linkFormat via the source view.

Web Voice (WebRTC)

Featurewebrtc
FieldRequiredDescription
SlugAutoURL-friendly identifier for the WebRTC endpoint.
Allowed OriginsNoAllowed origins, e.g. ["https://example.com"].
Allowed IPsNoAllowed IP addresses or CIDR ranges, e.g. ["192.168.1.0/24"].
Egress Base NumberNoRequired for outbound transfers from Web Voice endpoints.

Web Voice endpoints are also what the Flow Designer uses to run draft test calls — when you press Test the platform creates a temporary Web Voice endpoint pointing at your draft.

Web Chat

FieldRequiredDescription
SlugAutoURL-friendly identifier for the chat endpoint.
Allowed OriginsNoAllowed origins for the chat session.
Allowed IPsNoAllowed IP addresses or CIDR ranges.

Activation

An endpoint becomes active when the flow that owns it has a published version (see Draft and publish). Until then the endpoint exists in the configuration but doesn't accept real traffic.

See also