v52

OpenAPI 3.1.0raw.githubusercontent.com2026-07-311,1941,9384.1 MB
Outbound Voice Profiles

Get all outbound voice profiles

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

get/outbound_voice_profiles

Query parameters

numberinteger

The page number to load.

sizeinteger

The size of the page.

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

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

{
  "name": {
    "contains": "office-profile"
  }
}
sort'enabled' | '-enabled' | 'created_at' | '-created_at' | 'name' | '-name' | 'service_plan' | '-service_plan' | 'traffic_type' | '-traffic_type' | 'usage_payment_method' | '-usage_payment_method'
Example:name

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/>

Response

Successful response

Example 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"
      },
      "calling_window": {
        "calls_per_cld": 5,
        "end_time": "20:00:00.00Z",
        "start_time": "08:00:00.00Z"
      },
      "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
  }
}