Skip to navigation
Voice Agents APIAgent Telephony

Attach a default caller ID to an agent

Deprecated
View as Markdown

Deprecated. Part of the compatibility bridge; sunsets with the migration window. New integrations should pass fromNumber on each call instead. Responses carry a Deprecation: true header.

Lets the agent dial from a rented number or an outbound SIP trunk’s number when a call does not pass fromNumber. Requires an admin-role key. Unlike answering sources, caller IDs are shared: many agents may present the same number, so attaching never conflicts.

A caller ID names the exact number it dials from. A trunk presents many numbers, so a sipTrunk attach must carry number (one of that trunk’s numbers); a phoneNumber source is its own number, so it must not.

Authentication

AuthorizationBearer

API key from the console ApiKey collection, sent as Bearer token. Also accepts session cookies for browser-based auth.

Path parameters

agentIdstringRequired

Request

This endpoint expects an object.
sourceKindenumRequired
Allowed values:
sourceIdstringRequired
The phone number product ID, or the outbound SIP trunk ID.
numberstringOptional

Required for sipTrunk sources: which of the trunk's numbers this agent dials from (E.164 with leading +). Must be omitted for phoneNumber sources.

Response headers

Deprecationboolean

Always true; this surface is the deprecated compatibility bridge.

Response

Caller ID attached
statusbooleanOptional
dataobjectOptional
The stored binding record, as returned by the attach endpoints.

Errors

400
Bad Request Error
404
Not Found Error