Get Phone Number Configuration
Retrieve the call flow and message flow configuration for a phone number.
GET
Headers
x-api-keystringrequiredAPI key used for authenticating requests to the API.
x-workspace-idstringrequiredWorkspace identifier for the API.
Path Parameters
phoneNumberIdstringrequiredThe unique identifier of the phone number.
Response Fields
phoneNumberIdstringThe phone number ID.
agentIdstringThe call agent assigned to this phone number.
flowTypestringType of flow assigned ("call" or "message").
directionstringCall direction configuration ("inbound", "outbound", "bidirectional").
statusstringConfiguration status.
recordingbooleanWhether call recording is enabled.
officeHoursobjectOffice hours configuration for the phone number.
transferCallerIdModestringCaller ID mode for call transfers.
metadataTagsarrayArray of metadata tags assigned to this phone number.
{
"phoneNumberId": "665a1b2c3d4e5f6a7b8c9d0e",
"agentId": "665a1b2c3d4e5f6a7b8c9d0f",
"flowType": "call",
"direction": "bidirectional",
"status": "active",
"recording": true,
"officeHours": {
"enabled": false
},
"transferCallerIdMode": "agent",
"metadataTags": ["sales", "priority"]
}