The Vocera Messaging Platform API / Methods |
Alerts are identified by an external system ID. This ID is used in the callback notification calls and in the GetAlertStatus methods.
If a user is not found in the VMP Server, the return array contains the appropriate PagingAlertUserStatusInfo with ERROR status and User unknown detail text.
Parameter | Type | Description |
---|---|---|
Guid | String |
A reference to the VMP instance served by the VMP Paging gateway. The default is MAIN. |
User |
String |
The user login (configured in VMP Administrator). |
Password | String | The user password (configured in VMP Administrator). |
Message | String | The alert message with all options. |
Responses | String | The array of responses. |
Users | String | The array of recipients. |
DLS | String | The list of distribution list ids. The Public ID should be used, and can be configured in the VMP Administrator. Responses and delivery notifications are not supported for distribution lists. |
CallbackInfo | String | The status notification callback descriptor. The VMP Server supports a callback failover mechanism. It is implemented as a callback notification queue. Status change notifications will be kept in the queue for 24 hours. If the VMP gateway cannot successfully submit a notification during the 24 hour period, the notification is discarded. Gateway clients can use the Paging_GetAlert status call to poll the alert status and update their database. |
Return type: WWI.WIC.WWS. PagingAlertUserStatusInfo[]