INinfobip
customer-engagement
conversations
tts-options-calls

Get supported TTS placeholders for purpose

Use this method to retrieve supported TTS placeholders for specified 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)
  • Auth
    • API key in header Authorization
    • or API key in header Authorization
    • or HTTP basic
    • or OAuth 2
      Client credentials
      Token URL: https://api.infobip.com/auth/1/oauth2/token

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

OK

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.

placeholderValuestring

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."

placeholderPaddingSizeinteger

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.

requiresSSMLboolean

Specifies whether this placeholder requires TTS voice to support SSML.

Example response

{
  "type": "POSITION_IN_QUEUE",
  "sayAs": "DEFAULT",
  "placeholderValue": "{{QUEUE_POSITION_DEFAULT}}",
  "placeholderPaddingSize": 20,
  "requiresSSML": false
}

Changes

No recorded changes to this operation across all 1 revision of this API.