When sending Text to Speech messages, you may specify SSML commands to customize how words are robotically spoken.
For example:
| Input | Output |
|---|---|
| "Hello, your account code A148271 is overdue by $500. Contact us to resolve." | "Hello, your account code A-one hundred and forty eight thousand, two hundred and seventy-one is overdue by $500. Contact us to resolve." |
| "Hello, your account code <spell>A148271</spell> is overdue by <currency>$500</currency>. Contact us to resolve." | "Hello, your account code A-one-four-eight-two-seven-one is overdue by five hundred dollars. Contact us to resolve." |
A list of available commands:
| Command | Example | Explanation |
|---|---|---|
| <breath/> | Hello <breath/> how are you? | Adds a breathing sound to improve realism |
| <address> | The meeting will be held at <address>5 Smart Way, Auckland</address> | Reads text as a street address |
| <telephone> | You can contact us on <telephone>0800 555 333</telephone> | Reads text as a telephone number |
| <spell> | Your reference number is <spell>916483</spell> | Spells each character individually |
| <time> | Your appointment is booked for <time>5:45</time> | Reads text as hour:minutes |
| <date> | Your appointment is booked for <date>2021-12-25</date> | Reads text as a date (input is year-month-day) |
| <date:dmy> | Your appointment is booked for <date>25-12-2021</date> | Reads text as a date (input is day-month-year) |
| <date:mdy> | Your appointment is booked for <date>12-25-2021</date> | Reads text as a date (input is month-day-year) |
| <date:ymd> | Your appointment is booked for <date>2021-12-25</date> | Reads text as a date (input is year-month-day) |
| <number> | Your reference number is <number>916483</number> | Spells each digit individually |
| <fraction> | Special offer, <fraction>1/2</fraction> price, today only | Reads a fraction as a word (1/2 = half) |
| <cardinal> | Your current account balance is <cardinal>54.23</cardinal> | Reads text as a cardinal number (54.23 = fifty-four) |
| <ordinal> | You are the <ordinal>4th<ordinal> caller! | Reads text as an ordinal number (fourth) |
| <loud> | Please call us back <loud>now</loud> | Increases the voice's pitch |
| <soft> | Thanks for calling, <soft>putting you through now</soft> | Decreases the voice's pitch |
| <fast> | Thank you. <fast>Terms and conditions apply.</fast> | Increases the rate of the voice |
| <slow> | <slow>Contact us today</slow> to lock in this special | Decreases the rate of the voice |
| <emphasis> | It is <emphasis>very</emphasis> important to check... | Adjusts the voice to be loud and slow |
| <break/> | Hello <break/> thank you for taking this call | Adds a one second pause |
| <break:1/> | Call back <break:1/> at a time that suits you | Adds a 100 millisecond pause (0.1 seconds) |
| <break:3/> | Call back <break:3/> at a time that suits you | Adds a 300 millisecond pause (0.3 seconds) |
| <break:5/> | Call back <break:3/> at a time that suits you | Adds a 500 millisecond pause (0.5 seconds) |