---
title: "Get supported TTS placeholders for purpose"
method: GET
path: "/ccaas/voice/2/tts/options/placeholders/{ttsPurpose}"
tags: ["customer-engagement", "conversations", "tts-options-calls"]
---

# Get supported TTS placeholders for purpose

`GET /ccaas/voice/2/tts/options/placeholders/{ttsPurpose}`

## Request

- Base URL: `https://api.infobip.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.infobip.com/ccaas/voice/2/tts/options/placeholders/{ttsPurpose}`
- Auth: one of:
  - API key in header `Authorization`
  - API key in header `Authorization`
  - HTTP basic
  - OAuth 2
    - Client credentials
    - Token URL: `https://api.infobip.com/auth/1/oauth2/token`

Use this method to retrieve supported TTS placeholders for specified purpose.

## Path parameters

- `ttsPurpose` 'WAITING_STRATEGY_GREETING_MESSAGE' | 'WAITING_STRATEGY_ANNOUNCEMENT_MESSAGE' | 'WAITING_STRATEGY_MAXIMUM_WAIT_TIME_MESSAGE' | 'WORKING_HOURS_AWAY_MESSAGE' | 'TRANSFER_STRATEGY_MESSAGE' | 'ON_HOLD_MESSAGE' | 'CALLBACK_CONFIRMATION_MESSAGE' | 'WAITING_STRATEGY_GREETING_MESSAGE' | 'WAITING_STRATEGY_ANNOUNCEMENT_MESSAGE' | 'WAITING_STRATEGY_MAXIMUM_WAIT_TIME_MESSAGE' | 'WORKING_HOURS_AWAY_MESSAGE' | 'TRANSFER_STRATEGY_MESSAGE' | 'ON_HOLD_MESSAGE' | 'CALLBACK_CONFIRMATION_MESSAGE', required: Purpose for which placeholders will be used in text-to-speech.

## Response `200`

OK

- B979cda441a7c661201042835d7dc18eaec3fa68a2905164912469051f8b8866GetPlaceholdersApiResponse
  - `type` 'POSITION_IN_QUEUE' | 'POSITION_IN_QUEUE': Placeholder type. Determines the purpose of the placeholder.
  - `sayAs` 'DEFAULT' | 'ORDINAL' | 'CARDINAL' | 'DEFAULT' | 'ORDINAL' | 'CARDINAL': Dictates how resolved value will be spoken when using the placeholder. DEFAULT means that there is no control as to how the value will be spoken and it depends on the TTS engine. ORDINAL means that the value will be spoken as an ordinal number. CARDINAL means that the value will be spoken as a cardinal number.
  - `placeholderValue` string: Value to be placed in TTS text field which will be resolved in runtime to an actual value. This value is used to identify the placeholder. For example, {{QUEUE_POSITION_DEFAULT}} is a placeholder for the position in the queue with DEFAULT sayAs option. Here is example Text-to-Speech text: "You are {{QUEUE_POSITION_DEFAULT}} in the queue."
  - `placeholderPaddingSize` integer: Specifies how many characters will be added by the system in the background to correctly resolve the placeholder. This number is added to current TTS text length and counts toward max TTS text length.
  - `requiresSSML` boolean: Specifies whether this placeholder requires TTS voice to support SSML.

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found
- `500`: Internal Server Error

---

[API](https://skmtc.dev/infobip/apis/infobip-openapi-specification.md) - [All operations](https://skmtc.dev/infobip/apis/infobip-openapi-specification/llms.txt) - [OpenAPI document](https://skmtc.dev/infobip/apis/infobip-openapi-specification/revisions/9dcbbaf902de?raw)