Get all outbound voice profiles

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

GET /outbound_voice_profiles

JavaScript

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const outboundVoiceProfile of client.outboundVoiceProfiles.list()) {
  console.log(outboundVoiceProfile.id);
}

import os
from telnyx import Telnyx

client = Telnyx(
    api_key=os.environ.get("TELNYX_API_KEY"),  # This is the default and can be omitted
)
page = client.outbound_voice_profiles.list()
page = page.data[0]
print(page.id)

package main

import (
	"context"
	"fmt"

	"github.com/team-telnyx/telnyx-go"
	"github.com/team-telnyx/telnyx-go/option"
)

func main() {
	client := telnyx.NewClient(
		option.WithAPIKey("My API Key"),
	)
	page, err := client.OutboundVoiceProfiles.List(context.TODO(), telnyx.OutboundVoiceProfileListParams{})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", page)
}

package com.telnyx.sdk.example;

import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
import com.telnyx.sdk.models.outboundvoiceprofiles.OutboundVoiceProfileListPage;
import com.telnyx.sdk.models.outboundvoiceprofiles.OutboundVoiceProfileListParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        TelnyxClient client = TelnyxOkHttpClient.fromEnv();

        OutboundVoiceProfileListPage page = client.outboundVoiceProfiles().list();
    }
}

require "telnyx"

telnyx = Telnyx::Client.new(api_key: "My API Key")

page = telnyx.outbound_voice_profiles.list

puts(page)

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Telnyx\Client;
use Telnyx\Core\Exceptions\APIException;

$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');

try {
  $page = $client->outboundVoiceProfiles->list(
    filter: ['name' => ['contains' => 'office-profile']],
    pageNumber: 0,
    pageSize: 0,
    sort: 'name',
  );

  var_dump($page);
} catch (APIException $e) {
  echo $e->getMessage();
}

telnyx outbound-voice-profiles list \
  --api-key 'My API Key'

curl --request GET \
  --url https://api.telnyx.com/v2/outbound_voice_profiles \
  --header 'Authorization: Bearer <token>'

200

{
  "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": [
          "[phone]"
        ],
        "call_recording_channels": "dual",
        "call_recording_format": "mp3"
      },
      "billing_group_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
      "calling_window": {
        "start_time": "08:00:00.00Z",
        "end_time": "20:00:00.00Z",
        "calls_per_cld": 5
      },
      "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
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page · object

Consolidated page parameter (deepObject style). Originally: page[size], page[number]

Show child attributes

filter · object

Consolidated filter parameter (deepObject style). Originally: filter[name][contains]

Show child attributes

sort · enum<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.

Available options: enabled, -enabled, created_at, -created_at, name, -name, service_plan, -service_plan, traffic_type, -traffic_type, usage_payment_method, -usage_payment_method

Example:

"name"

Response

200

application/json

Successful response

data · Outbound Voice Profile · object[]

Show child attributes

meta · object

Show child attributes