Cisco Unity Express -- Triggers REST PI Service Operation
From DocWiki
Main page: Cisco Unity Express -- REST PI Service Operations
Previous page: Cisco Unity Express -- User Defaults REST PI Service Operation
Next page: Cisco Unity Express -- Caller Call Flow REST PI Service Operation
Search the Cisco Unity Express documentation on the DocWiki:
Contents |
Triggers
Classes
Figure 23: Trigger
Trigger
| Class Name |
Trigger | ||
|---|---|---|---|
| Extends From |
ManagedBaseElement | ||
| Description |
Class representing the SIP and JTPAI triggers | ||
| XML Namespace |
http://trigger.model.rest.aesop.cisco.com | ||
| Field Name | Type | Constraints | Comments |
|
appName |
String |
Name of the application to start when a trigger is entered | |
|
enabled |
Boolean |
Enable or disable the trigger | |
|
idleTimeout |
Integer |
The number of milliseconds to wait for a caller's response before the call is disconnected. | |
|
locale |
String |
Language used for the system prompts that are heard by the caller when a trigger is activated. | |
|
maxSessions |
Integer |
Maximum value is determined by the number of ports purchased for the application. |
Maximum number of subscribers who can access a trigger simultaneously |
|
triggerId |
String |
For SIP and JTAPI trigger types, triggerId is the phone number that acts as the trigger to start the application on the JTAPI or SIP proxy server. The number value should be the last four digits of the full telephone number that callers dial to reach the auto attendant. For trigger type HTTP, the trigger ID is the URL suffix string. | |
|
type |
TriggerType |
Trigger type |
TriggerType
| Class Name |
TriggerType (Enumeration Class) |
|---|---|
| Extends From | |
| Description |
Enumeration of trigger types |
| XML Namespace |
http://trigger.model.rest.aesop.cisco.com |
| Enum Values |
SIP JTAPI HTTP |
Resources
| Resource URI | Operation | Input | Return Value |
|---|---|---|---|
|
/triggers |
GET (read all triggers defined for all types) |
BaseElementList Containing list of Trigger objects | |
|
/triggers/{triggerType} where triggerType is one of SIP, JTAPI or HTTP |
POST (define a new trigger of type triggerType) |
Trigger | |
|
/triggers/{triggerType}/{triggerId} |
GET (read a trigger) |
Trigger | |
|
PUT (update a trigger) |
Trigger | ||
|
DELETE (delete a trigger) |
