Skip to main content
GET
/
outbound_voice_profiles
JavaScript
import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: 'My API Key',
});

const outboundVoiceProfiles = await client.outboundVoiceProfiles.list();

console.log(outboundVoiceProfiles.data);
{
  "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",
      "calling_window": {
        "start_time": "08:00:00",
        "end_time": "20:00:00",
        "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]

​
filter
object

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

​
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 <code>-</code> prefix.<br/><br/> That is: <ul>

<li> <code>name</code>: sorts the result by the <code>name</code> field in ascending order. </li> <li> <code>-name</code>: sorts the result by the <code>name</code> field in descending order. </li> </ul> <br/>
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

Successful response

​
data
Outbound Voice Profile · object[]
​
meta
object