Attach an inbound source to an agent

View as Markdown

Makes the agent answer calls arriving on a rented number or inbound SIP trunk you own. Requires an admin-role key. A source is answered by exactly one agent: if another agent already answers it, 409 identifies that agent by id (“Already answered by another agent (…). Detach it there first.”). This replaces the legacy telephonyProductId field on agent writes.

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 inbound SIP trunk ID.

Response

Binding created. Returns the stored binding record (not the read shape GET .../answers uses).

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

Errors

404
Not Found Error
409
Conflict Error