Skip to main content

Say

Definition​

Say converts written text to voice. This is a verbal message that the calling party will hear. Supported attributes can be added to customize the type of voice and the number of repetitions of the message.

warning

Note that the maximum number of characters that can be input to the Say verb is 1,024.

Integers added to the Say verb will be read according to how they are entered. "123" will be read as "one hundred twenty-three" and "1 2 3" will be read as "one two three". To add a pause in the message, close out the Say tag, insert a Pause tag, and then open a new Say tag with the rest of the text.

Supported Attributes​

These attributes can be used to modify the Say verb. They are inserted as name-value pairs in the start-tag.

AttributeData TypeDescription
loopintegerThe amount of times that the message will play. Integers entered into this field must be greater than or equal to 0. Enter 0 to play the message repeatedly until the call is ended. The maximum value accepted in this field is 100. The default value is 1.
loopPauseintegerThe number of seconds between each loop repetition. Integers entered into this field must be greater than or equal to 1. The maximum value accepted in this field is 300. The default value is 0, meaning that there will be no pause between repetitions.
voicestringThe type of voice that will read the text. By default, only two values are accepted in this field: man and woman. The default value is man. However, for an additional fee you can also have Amazon Polly voices enabled. To enable Amazon Polly voices as well as to learn about the fee amount, please contact technical support at support@carrierx.com. For a complete list of Amazon Polly voices supported by CarrierX, please refer to this table. The syntax to use an Amazon Polly voice is similar to the conventional voice attribute syntax, but instead of man or woman use an Amazon Polly name in the Polly.Name format, e.g. <Say voice="Polly.Kimberly" loop="1">.

Example​

In this example, a thank you message will be read twice to the calling party because loop is set to 2. Between loops one and two, there will be a five second pause because loopPause is set to 5.

<Response>
  <Say voice="woman" loop="2" loopPause="5">Thank you for calling customer service</Say>
</Response>

Nesting Rules​

  • You cannot nest other verbs or nouns within the Say verb.
  • You can nest the Say verb within the Gather and PreAnswer FlexML verbs.