List Language Groups

Deprecated alias for GET /api/v1/voice_groups/.

GET /api/v1/language_groups/

List Language Groups

cURL

curl --request GET \
  --url https://api.syllable.cloud/api/v1/language_groups/ \
  --header 'Syllable-API-Key: <api-key>'

200

{
  "items": [
    {
      "name": "Call Center 1 Languages",
      "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,
      "updated_at": "2024-01-01T00:00:00Z",
      "last_updated_by": "[e-mail]",
      "description": "Languages spoken by operators at Call Center 1",
      "edit_comments": "Added Spanish support.",
      "agents_info": [
        {
          "id": 1,
          "name": "Test Agent"
        }
      ],
      "validation_issues": [
        {
          "id": "<string>",
          "message": "<string>",
          "severity": "error",
          "path": "<string>",
          "value": "<string>"
        }
      ]
    }
  ],
  "page": 0,
  "page_size": 25,
  "total_pages": 4,
  "total_count": 100
}

Authorizations

Syllable-API-Key · string · header · required

Query Parameters

page · integer | null · default: 0

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

Required range: x >= 0

Example:

0

limit · integer · default: 25

The maximum number of items to return

Required range: x >= 0

Example:

25

search_fields · enum<string>[]

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

Deprecated enum mirroring VoiceGroupProperties values.

Available options: name, description, skip_current_language_in_message, updated_at, last_updated_by, lifecycle_status

Example:

"name"

search_field_values · string[]

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

Example:

"Some Object Name"

order_by · enum<string> | null

The field whose value should be used to order the results Deprecated enum mirroring VoiceGroupProperties values.

Available options: name, description, skip_current_language_in_message, updated_at, last_updated_by, lifecycle_status

Example:

"name"

order_by_direction · enum<string> | null

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

Available options: asc, desc

fields · enum<string>[] | null

The fields to include in the response

Deprecated enum mirroring VoiceGroupProperties values.

Available options: name, description, skip_current_language_in_message, updated_at, last_updated_by, lifecycle_status

start_datetime · string | null

The start datetime for filtering results

Example:

"2023-01-01T00:00:00Z"

end_datetime · string | null

The end datetime for filtering results

Example:

"2024-01-01T00:00:00Z"

Response

200

application/json

Successful Response

items · LanguageGroupResponse · object[] · required

List of items returned from the query

Show child attributes

page · integer · required

The page number of the results (0-based)

Example:

0

page_size · integer · required

The number of items returned per page

Example:

25

total_pages · integer | null

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

Example:

4

total_count · integer | null

The total number of items returned from the query

Example:

100