Unified Messaging Service Business Service Methods
The Unified Messaging Service (UMS) business service exposes the APIs described in the following table for updating the messages in the UMS cache, formatting messages, and attaching a new message display service. These APIs can be called from any run-time event, signal, workflow, or custom script.
Method | Arguments | Description |
---|---|---|
Add Messages |
[in] Source: String [in] Message List: Hierarchy |
Add a new list of messages to the message cache. Associate each message with the specified source. |
Update Messages |
[in] Source: String [in] Message List: Hierarchy |
Replace the current set of cached messages for the specified source with the new list of messages. Associate each message with the specified source. |
Delete Messages |
[in] Source: String [in] Message List: Hierarchy |
Delete all cached messages associated with the source or, if specified, the list of messages provided. Note: For deletion, only the message IDs need to be identified in the message
list. |
Get Messages |
[out] Message List: Hierarchy |
Output all unsuppressed, cached messages (regardless of source) including information derived from the message type (such as allowed responses). |
Process Response |
[in] Source: String Message Id: String [in] Response: String |
Process the end-user response to the specified message as defined by the message type. |
Reset |
Not applicable |
Delete all cached messages. |
Subscribe |
[in] Business Service: String [in] Method Name: String |
Add a Message Display business service to the list of services that are informed when a change occurs to the set of messages in the cache. |
Unsubscribe |
[in] Business Service: String |
Remove the specified business service from the list of services that are informed when a change occurs to the set of messages in the cache. |
Format Message |
[in/out] Message: Hierarchy |
Substitute and translate the text for the input message. The message is not displayed. |