Cisco Unity Express -- Language and Prompts REST PI Service Operation
From DocWiki
Main page: Cisco Unity Express -- REST PI Service Operations
Previous page: Cisco Unity Express -- Business Schedule and Holidays REST PI Service Operation
Next page: Cisco Unity Express -- Restriction Tables REST PI Service Operation
Search the Cisco Unity Express documentation on the DocWiki:
Contents |
Language and Prompts
Classes
Figure 10: Language and Prompt
Language
| Class Name |
Language | ||
|---|---|---|---|
| Extends From |
ManagedBaseElement | ||
| Description |
Represents a language installed in the system. | ||
| XML Namespace |
http://language.model.rest.aesop.cisco.com | ||
| Field Name | Type | Constraints | Comments |
|
locale |
String |
Specified as xx_YY where xx is the langugage code and YY is the country code. For example, en_US. |
Locale name represented by this language. |
|
language |
String |
Full language name. For example, "English" for locale "en_US". | |
|
country |
String |
Full country name. For example, "United States" for locale value "en_US". |
Prompt
| Class Name |
Prompt | ||
|---|---|---|---|
| Extends From |
ManagedBaseElement | ||
| Description |
Represents a prompt file installed in the system. | ||
| XML Namespace |
http://language.model.rest.aesop.cisco.com | ||
| Field Name | Type | Constraints | Comments |
|
promptName |
String |
Name of the prompt file. | |
|
size |
Integer |
Read Only |
Size of the file (in Bytes) |
|
creationDate |
String |
Read Only |
Date when the prompt file was created |
Resources
Language
| Resource URI | Operation | Input | Return Value |
|---|---|---|---|
|
/languages |
GET (read all languages installed) |
BaseElementList (containing list of Language objects) | |
|
/languages/{lang} |
GET (Read an installed language) |
Language | |
|
/languages/default |
GET (Read system default language) |
Language | |
|
PUT (Set a language as system default) |
Language |
Prompts
| Resource URI | Operation | Input | Return Value |
|---|---|---|---|
|
/languages/{language}/prompts/user |
GET (read information about all prompts) |
BaseElementList (containing list of Prompt objects) | |
|
/languages/{language}/prompts/user/{promptname} While uploading audio wav file, use query parameter overwrite to replace any file with the same name. /languages/{language}/prompts/user/{prompt name}?overwrite=true |
GET (Read information about an installed prompt) |
Accept: application/xml |
Prompt |
|
GET (Download the audio wav file for a prompt) |
Accept: audio/x-wav |
The prompt audio wav file | |
|
PUT Update prompt (change prompt file name) |
Content-type: application/xml Prompt | ||
|
PUT (Upload prompt audio wav file) |
Content-type: audio/x-wav Prompt wav file | ||
|
DELETE (Delete prompt file from server) |
