Get all outbound voice profiles

GET 
/outbound_voice_profiles

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

Request

Query Parameters

page[number] integer

Possible values: >= 1

Default value: 1

The page number to load.

page[size] integer

Possible values: >= 1 and <= 250

Default value: 20

The size of the page.

filter[name][contains] string

Optional filter on outbound voice profile name.

sort string
Possible values: [enabled, -enabled, created_at, -created_at, name, -name, service_plan, -service_plan, traffic_type, -traffic_type, usage_payment_method, -usage_payment_method]
Default value: -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.

Responses

200: Successful response

application/json

• Schema
• Example (from schema)

Schema

data

object[]

Array [

id int64

Identifies the resource.

record_type string

Identifies the type of the resource.

name stringrequired

Possible values: >= 3 characters

A user-supplied name to help with organization.

connections_count integer

Amount of connections associated with this outbound voice profile.

traffic_type TrafficType (string)

Possible values: [conversational, short_duration]

Default value: conversational

Specifies the type of traffic allowed in this profile.

service_plan ServicePlan (string)

Possible values: [us, international, global]

Default value: global

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.

concurrent_call_limit integernullable

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

enabled boolean

Default value: true

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

tags string[]

usage_payment_method UsagePaymentMethod (string)

Possible values: [tariff, rate-deck]

Default value: rate-deck

Setting for how costs for outbound profile are calculated.

whitelisted_destinations string[]

Default value: US,CA

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

max_destination_rate number

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

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

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

call_recording

object

call_recording_type string

Possible values: [all, none, by_caller_phone_number]

Specifies which calls are recorded.

call_recording_caller_phone_numbers string[]

When call_recording_type is 'by_caller_phone_number', only outbound calls using one of these numbers will be recorded. Numbers must be specified in E164 format.

call_recording_channels string

Possible values: [single, dual]

Default value: single

When using 'dual' channels, the final audio file will be a stereo recording with the first leg on channel A, and the rest on channel B.

call_recording_format string

Possible values: [wav, mp3]

Default value: wav

The audio file format for calls being recorded.

billing_group_id uuidnullable

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

created_at string

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

updated_at string

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

]

meta

object

total_pages integer

total_results integer

page_number integer

page_size integer

{
  "data": [
    {
      "id": "1293384261075731499",
      "record_type": "outbound_voice_profile",
      "name": "office",
      "connections_count": 12,
      "traffic_type": "conversational",
      "service_plan": "global",
      "concurrent_call_limit": 10,
      "enabled": true,
      "tags": [
        "office-profile"
      ],
      "usage_payment_method": "rate-deck",
      "whitelisted_destinations": [
        "US",
        "BR",
        "AU"
      ],
      "max_destination_rate": 10,
      "daily_spend_limit": "100.00",
      "daily_spend_limit_enabled": true,
      "call_recording": {
        "call_recording_type": "by_caller_phone_number",
        "call_recording_caller_phone_numbers": [
          "+19705555098"
        ],
        "call_recording_channels": "dual",
        "call_recording_format": "mp3"
      },
      "billing_group_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
      "created_at": "2018-02-02T22:25:27.521Z",
      "updated_at": "2018-02-02T22:25:27.521Z"
    }
  ],
  "meta": {
    "total_pages": 3,
    "total_results": 55,
    "page_number": 2,
    "page_size": 25
  }
}

401: Unauthorized

422: Bad request

Loading...