Telephony
Configure phone numbers and telephony providers
Endpoints
| Method | Path | Description |
|---|---|---|
| GET | /organizations/telephony-configs | List all configurations with phone number counts |
| POST | /organizations/telephony-configs | Create a new configuration |
| GET | /organizations/telephony-configs/{id} | Get a configuration by ID |
| PUT | /organizations/telephony-configs/{id} | Update a configuration |
| DELETE | /organizations/telephony-configs/{id} | Delete a configuration |
| POST | /organizations/telephony-configs/{id}/set-default-outbound | Set as the default outbound configuration |
| GET | /organizations/telephony-configs/{id}/phone-numbers | List phone numbers on a config |
| POST | /organizations/telephony-configs/{id}/phone-numbers | Add a phone number |
| DELETE | /organizations/telephony-configs/{id}/phone-numbers/{pid} | Remove a phone number |
| GET | /organizations/telephony-providers/metadata | List available providers with their form schemas |
| GET | /organizations/telephony-config-warnings | Aggregated warning counts for all telephony configs |
List Configurations
/organizations/telephony-configsReturns configurations with their associated phone number counts — useful for understanding concurrency capacity.
Create a Configuration
/organizations/telephony-configsRequest body — TelephonyConfigurationCreateRequest:
{
"name": "Primary Outbound",
"provider": "telnyx",
"config": {
"api_key": "KEY017xxxxx",
"connection_id": "2102xxxxx"
}
}Supported Providers
| Provider Key | Provider Name | Notes |
|---|---|---|
telnyx | Telnyx | Recommended for high volume |
twilio | Twilio | Widest geographic coverage |
vonage | Vonage | Strong European coverage |
plivo | Plivo | Cost-effective option |
cloudonix | Cloudonix | Enterprise SIP |
vobiz | Vobiz | Regional provider |
signalwire | SignalWire | Twilio-compatible API |
To get the exact required fields for each provider's config object:
/organizations/telephony-providers/metadataSet Default Outbound
/organizations/telephony-configs/{id}/set-default-outboundDesignates this configuration as the default for outbound calls. The Public Agent API and campaign engine use the default unless overridden in the request.
No request body required.
Phone Numbers (CLIs)
Phone numbers on a configuration serve as caller IDs. Campaign concurrency is limited by the number of active phone numbers — you cannot dial more simultaneously than you have CLIs configured.
List phone numbers
/organizations/telephony-configs/{id}/phone-numbersAdd a phone number
/organizations/telephony-configs/{id}/phone-numbersRequest body:
{
"phone_number": "+14155550100",
"label": "San Francisco Office"
}Remove a phone number
/organizations/telephony-configs/{id}/phone-numbers/{phone_number_id}Telephony Config Warnings
/organizations/telephony-config-warningsReturns aggregated warning counts for all telephony configurations — useful for surfacing configuration issues in a dashboard without fetching every config individually.