List voice designs

Returns a paginated list of voice designs belonging to the authenticated account.

GET /voice_designs

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 voiceDesignListResponse of client.voiceDesigns.list()) {
  console.log(voiceDesignListResponse.id);
}

200

{
  "data": [
    {
      "record_type": "voice_design",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "provider": "telnyx",
      "provider_supported_models": [
        "<string>"
      ]
    }
  ],
  "meta": {
    "page_number": 1,
    "page_size": 20,
    "total_results": 42,
    "total_pages": 3
  }
}

Query Parameters

page[number] · integer · default: 1

Page number for pagination (1-based).

Required range: x >= 1

page[size] · integer · default: 20

Number of results per page.

Required range: 1 <= x <= 250

filter[name] · string

Case-insensitive substring filter on the name field.

sort · enum<string> · default: -created_at

Sort order. Prefix with - for descending. Defaults to -created_at.

Available options: name, -name, created_at, -created_at

Response

200

application/json

A paginated list of voice designs.

Paginated list of voice designs.

data · object[]

Array of voice design summary objects.

Show child attributes

meta · object

Pagination metadata returned with list responses.

Show child attributes

Example:

{
  "page_number": 1,
  "page_size": 20,
  "total_results": 42,
  "total_pages": 3
}