Evo Voice

<back to all web services

GetAlert

Get a specific alert

Requires Authentication
Requires any of the roles:SystemAdministrator, Manager, Customer
The following routes are available for this service:
GET/alerts/{alertId}
GetAlert Parameters:
NameParameterData TypeRequiredDescription
AlertIdpathstringNoThe ID of the alert you want to get
AlertInfo Parameters:
NameParameterData TypeRequiredDescription
AccountIdformstringNoThe ID of the account associated with this alert
NameformstringNoThe name of the alert
TriggerformAlertTriggersNoThe trigger alert
WindowHoursformdoubleNoThe number of hours for the window over which the alert will trigger
ThresholdformdoubleNoThe value at which the alert will trigger
NotificationEmailAddressesformstringNoThe email addresses (one per line) to notify
EntityInfo Parameters:
NameParameterData TypeRequiredDescription
IdformstringNoThe ID of the object
DateCreatedformstringNoThe date the object was created
DateLastModifiedformstringNoThe date the object was last modified
CreatedByformstringNoThe user that created this object
LastModifiedByformstringNoThe user that last modified this object
AlertTriggers Enum:
CallSpend

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /alerts/{alertId} HTTP/1.1 
Host: evovoice.io 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"accountId":"String","name":"String","trigger":"CallSpend","windowHours":0,"threshold":0,"notificationEmailAddresses":"String","id":"String","dateCreated":"String","dateLastModified":"String","createdBy":"String","lastModifiedBy":"String"}