Sign in

v52

OpenAPI 3.1.0raw.githubusercontent.com2026-07-311,1941,9384.1 MB
Outbound Voice Profiles

Create an outbound voice profile

Create an outbound voice profile.

post/outbound_voice_profiles

Request body

billing_group_idstring uuid nullable

The ID of the billing group associated with the outbound proflile. Defaults to null (for no group assigned).

concurrent_call_limitinteger nullable

Must be no more than your global concurrent call limit. Null means no limit.

daily_spend_limitstring

The maximum amount of usage charges, in USD, you want Telnyx to allow on this outbound voice profile in a day before disallowing new calls.

daily_spend_limit_enabledboolean

Specifies whether to enforce the daily_spend_limit on this outbound voice profile.

enabledboolean

Specifies whether the outbound voice profile can be used. Disabled profiles will result in outbound calls being blocked for the associated Connections.

max_destination_ratenumber

Maximum rate (price per minute) for a Destination to be allowed when making outbound calls.

namestring required

A user-supplied name to help with organization.

service_plan'global'

Indicates the coverage of the termination regions.

tagsstring[]
traffic_type'conversational'

Specifies the type of traffic allowed in this profile.

usage_payment_method'rate-deck'

Setting for how costs for outbound profile are calculated.

whitelisted_destinationsstring[]

The list of destinations you want to be able to call using this outbound voice profile formatted in alpha2.

Example request

{
  "billing_group_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
  "calling_window": {
    "calls_per_cld": 5,
    "end_time": "20:00:00.00Z",
    "start_time": "08:00:00.00Z"
  },
  "concurrent_call_limit": 10,
  "daily_spend_limit": "100.00",
  "daily_spend_limit_enabled": true,
  "enabled": true,
  "max_destination_rate": 10,
  "name": "office",
  "service_plan": "global",
  "tags": [
    "office-profile"
  ],
  "traffic_type": "conversational",
  "usage_payment_method": "rate-deck",
  "whitelisted_destinations": [
    "US",
    "BR",
    "AU"
  ]
}

Response

Successful response

Example response

{
  "data": {
    "billing_group_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
    "call_recording": {
      "call_recording_caller_phone_numbers": [
        "+19705555098"
      ],
      "call_recording_channels": "dual",
      "call_recording_format": "mp3",
      "call_recording_type": "by_caller_phone_number"
    },
    "calling_window": {
      "calls_per_cld": 5,
      "end_time": "20:00:00.00Z",
      "start_time": "08:00:00.00Z"
    },
    "concurrent_call_limit": 10,
    "connections_count": 12,
    "created_at": "2018-02-02T22:25:27.521Z",
    "daily_spend_limit": "100.00",
    "daily_spend_limit_enabled": true,
    "enabled": true,
    "id": "1293384261075731499",
    "max_destination_rate": 10,
    "name": "office",
    "record_type": "outbound_voice_profile",
    "service_plan": "global",
    "tags": [
      "office-profile"
    ],
    "traffic_type": "conversational",
    "updated_at": "2018-02-02T22:25:27.521Z",
    "usage_payment_method": "rate-deck",
    "whitelisted_destinations": [
      "US",
      "BR",
      "AU"
    ]
  }
}