Open SidemenuAPI Reference
API Reference
Close Sidemenu

Outbound Voice Profiles

Get all outbound voice profileslistOutboundVoiceProfiles

get https://api.telnyx.com/v2/outbound_voice_profiles

Get all outbound voice profiles belonging to the user that match the given filters.

curl -X GET \
  --header "Content-Type: application/json" \
  --header "Accept: application/json" \
  --header "Authorization: Bearer YOUR_API_KEY" \
  --globoff "https://api.telnyx.com/v2/outbound_voice_profiles?page[number]=1&page[size]=20"
Parameters
In query
page[number]
integer (1)
optional

The page number to load

Default: 1
page[size]
integer (1 - 250)
optional

The size of the page

Default: 20
filter[name][contains]
string
optional

Optional filter on outbound voice profile name.

Example: "office-profile"
sort
string
optional

Specifies the sort order for results. By default sorting direction is ascending. To have the results sorted in descending order add the - prefix.

That is:

  • name: sorts the result by the name field in ascending order.
  • -name: sorts the result by the name field in descending order.

Default: "-created_at"
Example: "name"
Options: [ "enabled", "-enabled", "created_at", "-created_at", "name", "-name", "service_plan", "-service_plan", "traffic_type", "-traffic_type", "usage_payment_method", "-usage_payment_method" ]
Responses
200

Successful response

401

Unauthorized

422

Bad request

Success 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"
      },
      "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"
      ]
    }
  ],
  "meta": {
    "page_number": 2,
    "page_size": 25,
    "total_pages": 3,
    "total_results": 55
  }
}

Create an outbound voice profilecreateOutboundVoiceProfile

post https://api.telnyx.com/v2/outbound_voice_profiles

Create an outbound voice profile.

curl -X POST \
  --header "Content-Type: application/json" \
  --header "Accept: application/json" \
  --header "Authorization: Bearer YOUR_API_KEY" \
  --data '{"name":"office","billing_group_id":"6a09cdc3-8948-47f0-aa62-74ac943d6c58"}' \
  https://api.telnyx.com/v2/outbound_voice_profiles
Parameters
In body (application/json)
name
string
required

A user-supplied name to help with organization.

Example: "office"
billing_group_id
string (uuid)
optional

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

Default: null
Example: "6a09cdc3-8948-47f0-aa62-74ac943d6c58"
call_recording
object
optional
Example: { "call_recording_caller_phone_numbers": [ "+19705555098" ], "call_recording_channels": "dual", "call_recording_format": "mp3", "call_recording_type": "by_caller_phone_number" }
concurrent_call_limit
integer
optional

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

Example: 10
daily_spend_limit
string
optional

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.

Example: "100.00"
daily_spend_limit_enabled
boolean
optional

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

Default: false
Example: true
enabled
boolean
optional

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

Default: true
Example: true
max_destination_rate
number
optional

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

service_plan
string
optional

Indicates the coverage of the termination regions. International and Global are the same but International may only be used for high volume/short duration Outbound Voice Profiles.

Default: "global"
Example: "global"
Options: [ "us", "international", "global" ]
tags
array of string
optional
Example: [ "office-profile" ]
traffic_type
string
optional

Specifies the type of traffic allowed in this profile.

Default: "conversational"
Example: "conversational"
Options: [ "conversational", "short_duration" ]
usage_payment_method
string
optional

Setting for how costs for outbound profile are calculated.

Default: "rate-deck"
Example: "tariff"
Options: [ "tariff", "rate-deck" ]
whitelisted_destinations
array of string
optional

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

Default: [ "US", "CA" ]
Example: [ "US", "BR", "AU" ]
Responses
200

Successful response

401

Unauthorized

404

Resource not found

422

Bad request

Success 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"
    },
    "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"
    ]
  }
}

Retrieve an outbound voice profileretrieveOutboundVoiceProfile

get https://api.telnyx.com/v2/outbound_voice_profiles/{id}

Retrieves the details of an existing outbound voice profile.

curl -X GET \
  --header "Content-Type: application/json" \
  --header "Accept: application/json" \
  --header "Authorization: Bearer YOUR_API_KEY" \
  --globoff "https://api.telnyx.com/v2/outbound_voice_profiles/1293384261075731499"
Parameters
In path
id
string (int64)
required

Identifies the resource.

Example: "1293384261075731499"
Responses
200

Successful response

401

Unauthorized

404

Resource not found

422

Bad request

Success 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"
    },
    "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"
    ]
  }
}

Updates an existing outbound voice profile.updateOutboundVoiceProfile

patch https://api.telnyx.com/v2/outbound_voice_profiles/{id}

Updates an existing outbound voice profile.

curl -X PATCH \
  --header "Content-Type: application/json" \
  --header "Accept: application/json" \
  --header "Authorization: Bearer YOUR_API_KEY" \
  --data '{"name":"office","billing_group_id":"6a09cdc3-8948-47f0-aa62-74ac943d6c58"}' \
  https://api.telnyx.com/v2/outbound_voice_profiles/1293384261075731499
Parameters
In path
id
string (int64)
required

Identifies the resource.

Example: "1293384261075731499"
In body (application/json)
name
string
required

A user-supplied name to help with organization.

Example: "office"
billing_group_id
string (uuid)
optional

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

Default: null
Example: "6a09cdc3-8948-47f0-aa62-74ac943d6c58"
call_recording
object
optional
Example: { "call_recording_caller_phone_numbers": [ "+19705555098" ], "call_recording_channels": "dual", "call_recording_format": "mp3", "call_recording_type": "by_caller_phone_number" }
concurrent_call_limit
integer
optional

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

Example: 10
daily_spend_limit
string
optional

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.

Example: "100.00"
daily_spend_limit_enabled
boolean
optional

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

Default: false
Example: true
enabled
boolean
optional

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

Default: true
Example: true
max_destination_rate
number
optional

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

service_plan
string
optional

Indicates the coverage of the termination regions. International and Global are the same but International may only be used for high volume/short duration Outbound Voice Profiles.

Default: "global"
Example: "global"
Options: [ "us", "international", "global" ]
tags
array of string
optional
Example: [ "office-profile" ]
traffic_type
string
optional

Specifies the type of traffic allowed in this profile.

Default: "conversational"
Example: "conversational"
Options: [ "conversational", "short_duration" ]
usage_payment_method
string
optional

Setting for how costs for outbound profile are calculated.

Default: "rate-deck"
Example: "tariff"
Options: [ "tariff", "rate-deck" ]
whitelisted_destinations
array of string
optional

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

Default: [ "US", "CA" ]
Example: [ "US", "BR", "AU" ]
Responses
200

Successful response

401

Unauthorized

404

Resource not found

422

Bad request

Success 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"
    },
    "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"
    ]
  }
}

Delete an outbound voice profiledeleteOutboundVoiceProfile

delete https://api.telnyx.com/v2/outbound_voice_profiles/{id}

Deletes an existing outbound voice profile.

curl -X DELETE \
  --header "Content-Type: application/json" \
  --header "Accept: application/json" \
  --header "Authorization: Bearer YOUR_API_KEY" \
  "https://api.telnyx.com/v2/outbound_voice_profiles/1293384261075731499"
Parameters
In path
id
string (int64)
required

Identifies the resource.

Example: "1293384261075731499"
Responses
200

Successful response

401

Unauthorized

404

Resource not found

422

Bad request

Success 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"
    },
    "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"
    ]
  }
}
Previous: Overview

Was this section helpful?