Agent Telephony

Set an agent's transfer caller ID

View as Markdown

Sets the number the agent’s call transfers dial out from. Must be a number your organization owns (rented, or a caller ID on an outbound trunk); null clears it. When unset, transfers on outbound calls fall back to the call’s own caller ID, and transfers on inbound calls are refused. Not part of versioned agent config: changing it never requires an agent release.

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.
transferFromNumberstring or nullRequired

E.164 with leading +, or null to clear.

Response

Transfer caller ID set
statusbooleanOptional
dataobjectOptional

Errors

400
Bad Request Error
404
Not Found Error