ASasksyllable
voice_groups

Get Voice Group

Changed on

Fetch a given voice group.

get/api/v1/voice_groups/{voice_group_id}

Request

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

Path parameters

voice_group_idinteger required

Response

Successful Response

namestring required

The name of the language group.

descriptionstring nullable

Description of the language group.

skip_current_language_in_messageboolean required

Whether a custom message using the language group to generate a language DTMF menu should skip the agent's current language in the menu.

idinteger required

The ID of the language group to update.

edit_commentsstring nullable

Comments for the most recent edit to the language group.

updated_atstring date-time required

Timestamp of the last update to the language group.

last_updated_bystring required

Email of the user who last updated the language group.

Example response

{
  "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"
}

Changes

  • 547a632a6e36Revision changes
    • info

      added the optional property to the response with the status

  • 609194a6be9cRevision changes
    • warning

      added the new Cartesia enum value to the // response property for the response status

    • warning

      added the new Corey (US) enum value to the // response property for the response status

    • warning

      added the new Daniel (US) enum value to the // response property for the response status

    • warning

      added the new Emilio (MX) enum value to the // response property for the response status

    • warning

      added the new Emma (US) enum value to the // response property for the response status

    • warning

      added the new Fernanda (MX) enum value to the // response property for the response status

    • warning

      added the new Haeun (KR) enum value to the // response property for the response status

    • warning

      added the new Hua (CN) enum value to the // response property for the response status

    • warning

      added the new Jaewon (KR) enum value to the // response property for the response status

    • warning

      added the new Linda (US) enum value to the // response property for the response status

    • warning

      added the new Liu (CN) enum value to the // response property for the response status

    • warning

      added the new Marta (ES) enum value to the // response property for the response status

    • warning

      added the new Mateo (MX) enum value to the // response property for the response status

    • warning

      added the new Minji (KR) enum value to the // response property for the response status

    • warning

      added the new Skylar (US) enum value to the // response property for the response status

    • warning

      added the new Suda (TH) enum value to the // response property for the response status

    • warning

      added the new Taehyun (KR) enum value to the // response property for the response status

    • warning

      added the new Xia (VN) enum value to the // response property for the response status

    • warning

      added the new Ximena (MX) enum value to the // response property for the response status