Outbound Voice Profiles API

Outbound voice profiles operations API

Get all outbound voice profiles

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

SecuritybearerAuth
Request
query Parameters
page[number]
integer >= 1
Default: 1

The page number to load

page[size]
integer [ 1 .. 250 ]
Default: 20

The size of the page

filter[name][contains]
string

Optional filter on outbound voice profile name.

Example: filter[name][contains]=office-profile
sort
string
Default: "-created_at"

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.

Enum: "enabled" "-enabled" "created_at" "-created_at" "name" "-name" "service_plan" "-service_plan" "traffic_type" "-traffic_type" "usage_payment_method" "-usage_payment_method"
Example: sort=name
Responses
200

Successful response

Response Schema: application/json
Array of objects (Outbound Voice Profile)
object (PaginationMeta)
401

Unauthorized

422

Bad request

get/outbound_voice_profiles
Request samples 
import telnyx
telnyx.api_key = "YOUR_API_KEY"

telnyx.OutboundVoiceProfile.list(page={"number":1,"size":20})
Response samples
application/json
{
  • "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 profile

Create an outbound voice profile.

SecuritybearerAuth
Request
Request Body schema: application/json
required

Parameters that can be defined when creating an outbound voice profile

billing_group_id
string <uuid>
Default: null

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

object (OutboundCallRecording)
concurrent_call_limit
integer

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

daily_spend_limit
string

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_enabled
boolean
Default: false

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

enabled
boolean
Default: true

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

max_destination_rate
number

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

name
required
string >= 3 characters

A user-supplied name to help with organization.

service_plan
string (ServicePlan)

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.

Enum: "us" "international" "global"
tags
Array of strings
traffic_type
string (TrafficType)

Specifies the type of traffic allowed in this profile.

Enum: "conversational" "short_duration"
usage_payment_method
string (UsagePaymentMethod)

Setting for how costs for outbound profile are calculated.

Enum: "tariff" "rate-deck"
whitelisted_destinations
Array of strings
Default: ["US","CA"]

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

Responses
200

Successful response

Response Schema: application/json
object (OutboundVoiceProfile)
billing_group_id
string <uuid>
Default: null

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

object (OutboundCallRecording)
concurrent_call_limit
integer

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

connections_count
integer

Amount of connections associated with this outbound voice profile.

created_at
string

ISO 8601 formatted date-time indicating when the resource was created.

daily_spend_limit
string

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_enabled
boolean
Default: false

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

enabled
boolean
Default: true

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

id
string <int64>

Identifies the resource.

max_destination_rate
number

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

name
required
string >= 3 characters

A user-supplied name to help with organization.

record_type
string

Identifies the type of the resource.

service_plan
string (ServicePlan)

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.

Enum: "us" "international" "global"
tags
Array of strings
traffic_type
string (TrafficType)

Specifies the type of traffic allowed in this profile.

Enum: "conversational" "short_duration"
updated_at
string

ISO 8601 formatted date-time indicating when the resource was updated.

usage_payment_method
string (UsagePaymentMethod)

Setting for how costs for outbound profile are calculated.

Enum: "tariff" "rate-deck"
whitelisted_destinations
Array of strings
Default: ["US","CA"]

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

401

Unauthorized

404

Resource not found

422

Bad request

post/outbound_voice_profiles
Request samples
application/json
{
  • "billing_group_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
  • "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 samples
application/json
{
  • "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 profile

Deletes an existing outbound voice profile.

SecuritybearerAuth
Request
path Parameters
id
required
string <uuid>

Identifies the resource.

Example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
Responses
200

Successful response

Response Schema: application/json
object (OutboundVoiceProfile)
billing_group_id
string <uuid>
Default: null

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

object (OutboundCallRecording)
concurrent_call_limit
integer

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

connections_count
integer

Amount of connections associated with this outbound voice profile.

created_at
string

ISO 8601 formatted date-time indicating when the resource was created.

daily_spend_limit
string

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_enabled
boolean
Default: false

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

enabled
boolean
Default: true

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

id
string <int64>

Identifies the resource.

max_destination_rate
number

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

name
required
string >= 3 characters

A user-supplied name to help with organization.

record_type
string

Identifies the type of the resource.

service_plan
string (ServicePlan)

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.

Enum: "us" "international" "global"
tags
Array of strings
traffic_type
string (TrafficType)

Specifies the type of traffic allowed in this profile.

Enum: "conversational" "short_duration"
updated_at
string

ISO 8601 formatted date-time indicating when the resource was updated.

usage_payment_method
string (UsagePaymentMethod)

Setting for how costs for outbound profile are calculated.

Enum: "tariff" "rate-deck"
whitelisted_destinations
Array of strings
Default: ["US","CA"]

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

401

Unauthorized

404

Resource not found

422

Bad request

delete/outbound_voice_profiles/{id}
Request samples 
import telnyx
telnyx.api_key = "YOUR_API_KEY"

res = telnyx.OutboundVoiceProfile.retrieve('id')
res.delete()
Response samples
application/json
{
  • "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 profile

Retrieves the details of an existing outbound voice profile.

SecuritybearerAuth
Request
path Parameters
id
required
string <uuid>

Identifies the resource.

Example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
Responses
200

Successful response

Response Schema: application/json
object (OutboundVoiceProfile)
billing_group_id
string <uuid>
Default: null

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

object (OutboundCallRecording)
concurrent_call_limit
integer

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

connections_count
integer

Amount of connections associated with this outbound voice profile.

created_at
string

ISO 8601 formatted date-time indicating when the resource was created.

daily_spend_limit
string

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_enabled
boolean
Default: false

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

enabled
boolean
Default: true

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

id
string <int64>

Identifies the resource.

max_destination_rate
number

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

name
required
string >= 3 characters

A user-supplied name to help with organization.

record_type
string

Identifies the type of the resource.

service_plan
string (ServicePlan)

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.

Enum: "us" "international" "global"
tags
Array of strings
traffic_type
string (TrafficType)

Specifies the type of traffic allowed in this profile.

Enum: "conversational" "short_duration"
updated_at
string

ISO 8601 formatted date-time indicating when the resource was updated.

usage_payment_method
string (UsagePaymentMethod)

Setting for how costs for outbound profile are calculated.

Enum: "tariff" "rate-deck"
whitelisted_destinations
Array of strings
Default: ["US","CA"]

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

401

Unauthorized

404

Resource not found

422

Bad request

get/outbound_voice_profiles/{id}
Request samples 
import telnyx
telnyx.api_key = "YOUR_API_KEY"

telnyx.OutboundVoiceProfile.retrieve("id")
Response samples
application/json
{
  • "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.

Updates an existing outbound voice profile.

SecuritybearerAuth
Request
path Parameters
id
required
string <uuid>

Identifies the resource.

Example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
Request Body schema: application/json
required

Parameters that can be updated on an outbound voice profile

billing_group_id
string <uuid>
Default: null

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

object (OutboundCallRecording)
concurrent_call_limit
integer

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

daily_spend_limit
string

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_enabled
boolean
Default: false

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

enabled
boolean
Default: true

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

max_destination_rate
number

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

name
required
string >= 3 characters

A user-supplied name to help with organization.

service_plan
string (ServicePlan)

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.

Enum: "us" "international" "global"
tags
Array of strings
traffic_type
string (TrafficType)

Specifies the type of traffic allowed in this profile.

Enum: "conversational" "short_duration"
usage_payment_method
string (UsagePaymentMethod)

Setting for how costs for outbound profile are calculated.

Enum: "tariff" "rate-deck"
whitelisted_destinations
Array of strings
Default: ["US","CA"]

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

Responses
200

Successful response

Response Schema: application/json
object (OutboundVoiceProfile)
billing_group_id
string <uuid>
Default: null

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

object (OutboundCallRecording)
concurrent_call_limit
integer

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

connections_count
integer

Amount of connections associated with this outbound voice profile.

created_at
string

ISO 8601 formatted date-time indicating when the resource was created.

daily_spend_limit
string

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_enabled
boolean
Default: false

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

enabled
boolean
Default: true

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

id
string <int64>

Identifies the resource.

max_destination_rate
number

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

name
required
string >= 3 characters

A user-supplied name to help with organization.

record_type
string

Identifies the type of the resource.

service_plan
string (ServicePlan)

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.

Enum: "us" "international" "global"
tags
Array of strings
traffic_type
string (TrafficType)

Specifies the type of traffic allowed in this profile.

Enum: "conversational" "short_duration"
updated_at
string

ISO 8601 formatted date-time indicating when the resource was updated.

usage_payment_method
string (UsagePaymentMethod)

Setting for how costs for outbound profile are calculated.

Enum: "tariff" "rate-deck"
whitelisted_destinations
Array of strings
Default: ["US","CA"]

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

401

Unauthorized

404

Resource not found

422

Bad request

patch/outbound_voice_profiles/{id}
Request samples
application/json
{
  • "billing_group_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
  • "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 samples
application/json
{
  • "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"
      ]
    }
}