Evo Voice

ListAlerts

Retrieve alerts

**Requires Authentication**
Requires any of the roles:	SystemAdministrator, Manager, Customer

The following routes are available for this service:
GET	/alerts

**ListAlerts** Parameters:
Name	Parameter	Data Type	Required	Description
AccountIds	query	List<string>	No	Filter by accounts
NameFilter	query	string	No	Filter by name

**ListRequest<T>** Parameters:
Name	Parameter	Data Type	Required	Description
Page	form	int	No	The page of data to retrieve
All	form	bool	No	If you want all objects to be returned. This should be used with care
CountPerPage	form	int	No	The number per page to retrieve
SpecificIds	form	List<string>	No	Specific IDs
SortField	form	string	No	Specify a sort field
SortOrder	form	SortOrders	No	Specify a sort order
SimplifiedPaging	form	bool	No	Disables total / page counts - improves performance. Returns only data. If there is no more data, Items will be empty array

**SortOrders** Enum:
Ascend
Descend

**AlertInfo** Parameters:
Name	Parameter	Data Type	Required	Description
AccountId	form	string	No	The ID of the account associated with this alert
Name	form	string	No	The name of the alert
Trigger	form	AlertTriggers	No	The trigger alert
WindowHours	form	double	No	The number of hours for the window over which the alert will trigger
Threshold	form	double	No	The value at which the alert will trigger
NotificationEmailAddresses	form	string	No	The email addresses (one per line) to notify
CustomerSelection	form	AlertCustomerSelection	No	Customer selection for this alert
CustomerIds	form	List<string>	No	The list of customer IDs for the selection model

**EntityInfo** Parameters:
Name	Parameter	Data Type	Required	Description
Id	form	string	No	The ID of the object
DateCreated	form	string	No	The date the object was created
DateLastModified	form	string	No	The date the object was last modified
CreatedBy	form	string	No	The user that created this object
LastModifiedBy	form	string	No	The user that last modified this object

**AlertTriggers** Enum:
CallSpend
CallCount

**AlertCustomerSelection** Enum:
AllCustomers
ExcludeCustomers
IncludeCustomers

**ListResponse<T>** Parameters:
Name	Parameter	Data Type	Required	Description
Items	form	List<AccountInfo>	No	The items
TotalCount	form	int	No	The total number of items
TotalPages	form	int	No	The total number of pages
HasMorePages	form	bool	No	Are there more pages of items? Used with simplified paging

**AccountInfo** Parameters:
Name	Parameter	Data Type	Required	Description
Name	form	string	No	The name of this account
ParentAccountId	form	string	No	The ID of this account's parent
TwilioAccountSid	form	string	No	The twilio account SID
AncestorIds	form	List<string>	No	The ancestors of this account. Useful for breadcrumbs
MaxPhoneNumbers	form	int	No	The max number of phone numbers this account can have
IsBYOA	form	bool	No	This account is BYOA
TrustHubProfileSid	form	string	No	TrustHub Profile Sid
LogoId	form	string	No	The ID of the logo file
LogoUri	form	string	No	The URI of the logo file
BillingSettings	form	BillingSettings	No	The billing settings for this account
EnableInternationalSettings	form	bool	No	Enable international settings for the account?
DefaultInternationalCountryCodes	form	List<string>	No	The default list of country codes the account can dial when not specified on customer

**BillingSettings** Parameters:
Name	Parameter	Data Type	Required
Base	form	BillingItem	No
LocalNumbers	form	BillingItem	No
TollFreeNumbers	form	BillingItem	No
InboundVoiceCalls	form	BillingItem	No
OutboundVoiceCalls	form	BillingItem	No
InboundFaxes	form	BillingItem	No
OutboundFaxes	form	BillingItem	No
InboundSmsMessages	form	BillingItem	No
OutboundSmsMessages	form	BillingItem	No
AIInsights	form	BillingItem	No
AILiveMinutes	form	BillingItem	No
AIMessages	form	BillingItem	No
AITranscriptions	form	BillingItem	No

**BillingItem** Parameters:
Name	Parameter	Data Type	Required
BaseCost	form	double	No
RawUnitMultiplier	form	double	No
UnitCost	form	double	No
Allowance	form	int	No

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

HTTP + XML

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

GET /alerts HTTP/1.1 
Host: evovoice.io 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ListResponseOfAlertInfoLEzmHoIb xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Voice.Api">
  <HasMorePages>false</HasMorePages>
  <Items xmlns:d2p1="http://schemas.datacontract.org/2004/07/Voice.Api.Alerts">
    <d2p1:AlertInfo>
      <CreatedBy>String</CreatedBy>
      <DateCreated>String</DateCreated>
      <DateLastModified>String</DateLastModified>
      <Id>String</Id>
      <LastModifiedBy>String</LastModifiedBy>
      <d2p1:AccountId>String</d2p1:AccountId>
      <d2p1:CustomerIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </d2p1:CustomerIds>
      <d2p1:CustomerSelection>AllCustomers</d2p1:CustomerSelection>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:NotificationEmailAddresses>String</d2p1:NotificationEmailAddresses>
      <d2p1:Threshold>0</d2p1:Threshold>
      <d2p1:Trigger>CallSpend</d2p1:Trigger>
      <d2p1:WindowHours>0</d2p1:WindowHours>
    </d2p1:AlertInfo>
  </Items>
  <TotalCount>0</TotalCount>
  <TotalPages>0</TotalPages>
</ListResponseOfAlertInfoLEzmHoIb>