Language pack reference
- Helen Griffith
| In this page |
|---|
Folder structure and file names
Language packs are stored in a defined folder structure within VCC's Amazon Simple Storage Service (S3) storage area. The root folder for language packs is called language_packs. Each pack has its own folder within the root; the pack's folder can have any name. Folder and file names are case-sensitive and must be labelled exactly as specified in this page; do not translate folder and file names.
Audio files
Audio files are stored in the sysprompts folder within the language pack's root folder.
Numbers (cardinal)
Number audio files are stored in the numbers folder within the sysprompts folder. A cardinal number range must start from 0. A range starting from 1 is not valid.
Standard grammar
File name | Maximum range |
|---|---|
0.wav | 0 |
x.wav | x (up to 99) |
99.wav | 99 |
hundred.wav | 999 |
thousand.wav | 999,999 |
million.wav | 999,999,999 |
billion.wav | Approximately 2 billion |
minus.wav | Enables negative numbers |
British English grammar
File name | Audio | Maximum range |
|---|---|---|
0.wav | "zero" | 0 |
x.wav | - | x (up to 19) |
x0.wav | - | x9 |
hundred.wav | "hundred" | 999 |
thousand.wav | "thousand" | 999,999 |
million.wav | "million" | 999,999,999 |
billion.wav | "billion" | Approximately 2 billion |
| and.wav | "and" | |
minus.wav | "minus" | Enables negative numbers |
| double.wav | "double" | |
| oh.wav | "oh" | |
| triple.wav | "triple" |
Ordinal numbers
Ordinal number audio files are stored in the ordinal folder within the sysprompts folder.
The ordinal number range must not exceed the cardinal number range; cardinal number audio files are used to build some ordinal numbers, for example, the ordinal number 26th uses audio files for "twenty" (cardinal) and "sixth" (ordinal).
Standard grammar
| File name | Maximum range |
|---|---|
0.wav (optional) | 0 |
1er.wav | This value is a special value for the first item and is not used to form other numbers. |
1.wav | 1.wav is only used to construct ordinal numbers greater than 100, ending in '01'. In some languages, 1.wav can be the same recording as 1er.wav. |
x.wav | x (up to 99) |
99.wav | 99 |
hundred.wav | 999 |
thousand.wav | 999,999 |
million.wav | 999,999,999 |
billion.wav | Approximately 2 billion |
British English grammar
File name | Audio | Maximum range |
|---|---|---|
0.wav (optional) | 0 | |
x.wav | x (up to 19) | |
x0.wav | x9 | |
hundred.wav | "hundredth" | 999 |
thousand.wav | "thousandth" | 999,999 |
million.wav | "millionth" | 999,999,999 |
billion.wav | "billionth" | Approximately 2 billion |
Letters
Letter audio files are stored in the alphabet folder within the sysprompts folder.
Currently only the Latin alphabet is supported.
The following files enable announcements that include single letters:
- a.wav to z.wav
- space.wav
All letters must be provided with a recording. For announcements that contain both letters and numbers, audio files for 0-9 must be provided in the numbers folder.
Currencies
Currency audio files are stored in the currency folder within the sysprompts folder.
Announcements including currencies require four audio files for the currency, its fractional value, and both their plurals. The file names include the three letter standard code for the currency. The following example uses the euro (EUR):
File name | Audio |
|---|---|
EUR.wav | "euro" |
EURs.wav | "euros" |
EURcent.wav | "cent" |
EURcents.wav | "cents" |
Using example, €123.45 would be expressed as "123 euros 45 cents", whilst €1.00 would be expressed as "1 euro".
Pound sterling requires audio files with the file names GBP.wav, GBPs.wav, GBPcent.wav, GBPcents.wav.
All files for a currency must exist. However, for some currencies, the singular and plural forms are the same. In such a case, the audio file for the plural form should contain the audio for the singular form. Also, some currencies have no fractional value. In these cases, the audio files for fractional values should contain a short blank recording. The fractional XXXcent.wav and XXXcents.wav audio files are only used if there is a fractional component actually present.
Days of the week
Days of the week audio files are stored in the date folder within the sysprompts folder.
The following files enable Day of Week announcements:
- Monday.wav
- Tuesday.wav
- Wednesday.wav
- Thursday.wav
- Friday.wav
- Saturday.wav
- Sunday.wav
- yesterday.wav
- today.wav
- tomorrow.wav
Do not translate the file names.
Months
Month audio files are stored in the date folder within the sysprompts folder.
The following files enable announcements that include the date:
- January.wav
- February.wav
- March.wav
- April.wav
- May.wav
- June.wav
- July.wav
- August.wav
- September.wav
- October.wav
- November.wav
- December.wav
Do not translate the file names.
Miscellaneous prompts
Miscellaneous prompt audio files are stored in the prompts folder within the sysprompts folder.
Add the following recordings to unlock various capabilities.
File | Notes |
|---|---|
and.wav | Used in various announcements including currencies, times and dates. |
am.wav | Used in time announcements in languages that use British English. Standard grammar uses 24-hour time. |
day.wav | Used to announce durations, such as wait time announcements. |
of.wav | Used in data announcements in languages that use British English grammar |
currentposintro.wav | Used to announce a caller's position in the queue using cardinal numbers. currentposintro.wav is played before the number and currentposoutro.wav is played after the number. Depending on requirements, either or both can be present. If both ordinal and cardinal versions are available, then the ordinal version is used. |
| currentposoutro.wav | |
currentposordinalintro.wav | Used to announce a caller's position in the queue using ordinal numbers. currentposordinalintro.wav is played before the number and currentposordinaloutro.wav is played after the number. Depending on requirements, either or both can be present. |
| currentposordinaloutro.wav | |
targettimeintro.wav | Used to announce target waiting times in a skills based ACD. targettimeintro.wav is played before the target wait time and targettimeoutro.wav is played after the period. Depending on requirements, either or both can be present. |
| targettimeoutro.wav | |
recenttimeintro.wav | Used to announce recent answer times in a skills based ACD. recenttimeintro.wav is played before the recent wait time and recenttimeoutro.wav is played after the period. Depending on requirements, either or both can be present. |
| recenttimeoutro.wav | |
recenttimeimmediate.wav | Used instead of the normal recent answer times if the time is very short (optional). |
Summary file
You need to supply various metadata about your language pack. A summary file is stored in the root folder along with the sysprompts directory. The summary file must be in JavaScript Object Notation (JSON) format and have a filename of language_pack_definition.json.
The summary file describes the contents of the language pack and contains the following elements:
Voice name (compulsory) (voice)
Give your language pack a voice name. Voice name is not currently used. Language packs with different language codes can share the same voice name.
Not currently used but may be used later.
Language code (compulsory) (languageCode)
The language code identifies the language that this language pack is for. The value contains both a language and a locale and must be provided in ISO-639 format, for example, en-GB. The language pack with the language code en-GB contains audio files for British English.
You need to provide a language code in ISO-639 format. You should include a language identifier and a locale. For example, en-GB refers to English (United Kingdom). Language code is case-sensitive.
Grammar (compulsory) (grammar)
grammar must be either EnglishBritish or Standard.
Default for language (optional) (defaultForLanguage)
Languages, such as English and French, can have many variants usually based on the location that they are used in. For example, British English is slightly different from American English; Standard French is different from Canadian French. You can set any of the variants as the default for the language.
If an announcement requires an audio file that is not available in the variant's language pack, the announcement can use an audio file from the default pack for the language. If the language has no default language pack, the announcement will use the audio file from the British English or Standard language pack depending on the language set for your account.
If you wish for a pack to be used as the default pack for a particular language, regardless of locale, set defaultForLanguage to true. For example, if set to true for a Portuguese (Portugal) (pt-PT) pack, this pack could be used for a Brazilian (pt-BR) locale if a required audio file is not available in the Brazilian language pack. If a more specific language pack is available, announcements will always use this.
Example summary file
{
"languageCode": "en-GB",
"defaultForLanguage": true,
"grammar": "Standard",
"voice": "Kate"
}
Example language packs
Complete pack (English (United Kingdom))
Folders and files
- CompletePack_en-GB (folder)
- language_pack_definition.json
- sysprompts (folder)
- alphabet (folder)
- a.wav
- b.wav
- c.wav
- d.wav
- e.wav
- f.wav
- g.wav
- h.wav
- i.wav
- j.wav
- k.wav
- l.wav
- m.wav
- n.wav
- o.wav
- p.wav
- q.wav
- r.wav
- s.wav
- space.wav
- t.wav
- u.wav
- v.wav
- w.wav
- x.wav
- y.wav
- z.wav
- currency (folder)
- AUD.wav
- AUDcent.wav
- AUDcents.wav
- AUDs.wav
- EUR.wav
- EURcent.wav
- EURcents.wav
- EURs.wav
- GBP.wav
- GBPcent.wav
- GBPcents.wav
- GBPs.wav
- USD.wav
- USDcent.wav
- USDcents.wav
- USDs.wav
- date (folder)
- April.wav
- August.wav
- December.wav
- February.wav
- Friday.wav
- January.wav
- July.wav
- June.wav
- March.wav
- May.wav
- Monday.wav
- November.wav
- October.wav
- Saturday.wav
- September.wav
- Sunday.wav
- Thursday.wav
- today.wav
- tomorrow.wav
- Tuesday.wav
- Wednesday.wav
- yesterday.wav
- numbers (folder)
- 0.wav
- x.wav (where x = 1 to 19)
- x0.wav (where x = 1 to 9)
- and.wav
- billion.wav
- double.wav
- hundred.wav
- million.wav
- minus.wav
- oh.wav
- thousand.wav
- triple.wav
- ordinal (folder)
- 0.wav
- x.wav (where x = 1 to 19)
- x0.wav (where x = 1 to 9)
- billion.wav
hundred.wav
- million.wav
thousand.wav
- prompts (folder)
- am.wav
- and.wav
- currentposintro.wav
- currentposoutro.wav
- currentposordinalintro.wav
- currentposordinaloutro.wav
- hour.wav
- hours.wav
- minute.wav
- minutes.wav
- of.wav
- pm.wav
- recenttimeimmediate.wav
- recenttimeintro.wav
- recenttimeoutro.wav
- second.wav
- seconds.wav
- targettimeintro.wav
- targettimeoutro.wav
- alphabet (folder)
Summary file
{
"languageCode": "en-GB",
"defaultForLanguage": true,
"grammar": "EnglishBritish",
"voice": "Kate"
}
Place in queue announcements pack (English (United Kingdom))
Folders and files
- PlaceInQueuePack_en-GB (folder)
- language_pack_definition.json
- sysprompts (folder)
- numbers (folder)
- 0.wav
- 1.wav
- 10.wav
- 11.wav
- 12.wav
- 13.wav
- 14.wav
- 15.wav
- 16.wav
- 17.wav
- 18.wav
- 19.wav
- 2.wav
- 20.wav
- 3.wav
- 30.wav
- 4.wav
- 40.wav
- 5.wav
- 50.wav
- 6.wav
- 60.wav
- 7.wav
- 70.wav
- 8.wav
- 80.wav
- 9.wav
- 90.wav
- and.wav
- double.wav
- hundred.wav
- million.wav
- oh.wav
- thousand.wav
- triple.wav
- ordinal (folder)
- 1.wav
- 10.wav
- 11.wav
- 12.wav
- 13.wav
- 14.wav
- 15.wav
- 16.wav
- 17.wav
- 18.wav
- 19.wav
- 2.wav
- 20.wav
- 3.wav
- 30.wav
- 4.wav
- 5.wav
- 6.wav
- 7.wav
- 8.wav
- 9.wav
- prompts (folder)
- currentposintro.wav
- currentposordinalintro.wav
- currentposordinaloutro.wav
- currentposoutro.wav
- numbers (folder)
Summary file
{
"languageCode": "en-GB",
"defaultForLanguage": true,
"grammar": "EnglishBritish",
"voice": "Kate"
}
Zip file
For general assistance, please contact Customer Support.
For help using this documentation, please send an email to docs_feedback@vonage.com. We're happy to hear from you. Your contribution helps everyone at Vonage! Please include the name of the page in your email.