ASasksyllable
voice_groups

List Voice Groups

Changed on

Fetch voice groups.

get/api/v1/voice_groups/

Request

  • Base URL
    https://api.syllable.cloud
  • URL
    https://api.syllable.cloud/api/v1/voice_groups/
  • Auth
    API key in header Syllable-API-Key

Query parameters

pageinteger nullable

The page number from which to start (0-based)

limitinteger

The maximum number of items to return

Example:25
search_fieldsVoiceGroupProperties[]

String names of fields to search. Correspond by index to search field values

search_field_valuesstring[]

Values of fields to search. Correspond by index to search fields. Unless field name contains "list", an individual search field value cannot be a list

order_by'name' | 'description' | 'skip_current_language_in_message' | 'updated_at' | 'last_updated_by' | 'lifecycle_status'

Names of voice group fields supported for filtering/sorting on list endpoint.

The field whose value should be used to order the results

order_by_direction'asc' | 'desc'

The direction in which to order list results, either ascending or descending.

The direction in which to order the results

fieldsVoiceGroupProperties[] nullable

The fields to include in the response

start_datetimestring nullable

The start datetime for filtering results

Example:2023-01-01T00:00:00Z
end_datetimestring nullable

The end datetime for filtering results

Example:2024-01-01T00:00:00Z

Response

Successful Response

pageinteger required

The page number of the results (0-based)

page_sizeinteger required

The number of items returned per page

total_pagesinteger nullable

The total number of pages of results given the indicated page size

total_countinteger nullable

The total number of items returned from the query

Example response

{
  "items": [
    {
      "name": "Call Center 1 Languages",
      "description": "Languages spoken by operators at Call Center 1",
      "language_configs": [
        {
          "dtmf_code": 1,
          "language_code": "en-US",
          "voice_display_name": "Alloy",
          "voice_provider": "OpenAI"
        },
        {
          "dtmf_code": 2,
          "language_code": "es-US",
          "voice_display_name": "es-US-Neural2-B",
          "voice_provider": "Google"
        }
      ],
      "skip_current_language_in_message": true,
      "id": 1,
      "edit_comments": "Added Spanish support.",
      "agents_info": [
        {
          "id": 1,
          "name": "Test Agent"
        }
      ],
      "updated_at": "2024-01-01T00:00:00Z",
      "last_updated_by": "user@mail.com"
    }
  ],
  "page_size": 25,
  "total_pages": 4,
  "total_count": 100
}

Changes

  • 305657905d18Revision changes
    • info

      added the enum value lifecycle_status to the property anyOf[subschema #1: VoiceGroupProperties]/ of the query request parameter order_by

    • info

      added the enum value lifecycle_status to the property anyOf[subschema #1]/items/ of the query request parameter fields

    • info

      added the enum value lifecycle_status to the property items/ of the query request parameter search_fields

  • 547a632a6e36Revision changes
    • info

      added the optional property // to the response with the status