SetLanguage
Description (v1.2.1)
Set the language for the remaining actions of the callflow.
Use the language [language].
Release notes
Version 1.2.1 - General deployment
- Bugfix: Action was not compatible with the Communication Server module.
Version 1.2.0 - Deprecated
- Bugfix: Action sometimes stops dialplan execution on the Communication Server module.
- Deprecated: Action does not work at all on the Communication Server module.
Version 1.1 - Early deployment
- Improvement: Compatibility with the Communication Server module
Version 1.00 - General deployment
How it works
The action enables setting the most suitable language for a call. The required argument for this action is a shortened version of the language.
Example:
- English: en
- French: fr
- Dutch: nl
If the action is executed, every message playing action (PlayPrompt, Voicemail, IVR, ... . ) following it will look for the message in a certain location on the filesystem of the SOP. The standard location is represented here by
~/
.
- All custom English messages will be stored in
~/
.
- All custom French messages will be stored in a subdirectory of
~/
, ~/fr
to be precise.
- All custom Dutch messages will be stored in a subdirectory of
~/
, ~/nl
to be precise.
If the message is not found in the chosen language, the system will try to find the message in English in
~/
. If that location doesn't contain the message either, it is up to the message playing action (PlayPrompt, Voicemail, IVR, ... . ) to determine what is to be done.
Standard messages and custom messages
Most systems come with a standard set of messages in various languages. Custom messages can also be recorded. Standard messages and custom messages are stored in separate locations:
- Standard messages:
~/
- Custom messages:
~/prompt/
The approach to set the desired language remains the same: Only the language needs to be set, the relative location on the filesystem will be defined by the global parameter containing a reference to the message (or "Prompt").
Custom languages
This approach allows an administrator to record messages in any language required and to use them in a callflow, as long as the argument for this action matches the filesystem location.
Example of use
Play a standard message in French
- Use SetLanguage with the 'fr' argument
- Further in the callflow, use PlayPrompt with the '${agent-loggedoff}' argument.
- The system will look for and play the message
~/fr/agent-loggedoff.*
, which will be the message in French
- If the message isn't found, it will look for and play
~/agent-loggedoff.*
, which will be the message in English
Play a custom message in Dutch
- Use SetLanguage with the 'nl' argument
- Further in the callflow, use PlayPrompt with the '${main-number-greeting}' argument.
- The system will look for and play the message
~/prompt/nl/main-number-greeting.*
, which will be the message in Dutch
- If the message isn't found, it will look for and play
~/prompt/main-number-greeting.*
, which will be the message in English