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

import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


/**
* Retrieve alerts
*/
@Api(Description="Retrieve alerts")
open class ListAlerts : ListRequest<AlertInfo>()
{
    /**
    * Filter by accounts
    */
    @ApiMember(Description="Filter by accounts")
    open var accountIds:ArrayList<String>? = null

    /**
    * Filter by name
    */
    @ApiMember(Description="Filter by name")
    open var nameFilter:String? = null
}

open class ListRequest<T> : IGet
{
    /**
    * The page of data to retrieve
    */
    @ApiMember(Description="The page of data to retrieve")
    open var page:Int? = null

    /**
    * If you want all objects to be returned. This should be used with care
    */
    @ApiMember(Description="If you want all objects to be returned. This should be used with care")
    open var all:Boolean? = null

    /**
    * The number per page to retrieve
    */
    @ApiMember(Description="The number per page to retrieve")
    open var countPerPage:Int? = null

    /**
    * Specific IDs
    */
    @ApiMember(Description="Specific IDs")
    open var specificIds:ArrayList<String>? = null

    /**
    * Specify a sort field
    */
    @ApiMember(Description="Specify a sort field")
    open var sortField:String? = null

    /**
    * Specify a sort order
    */
    @ApiMember(Description="Specify a sort order")
    open var sortOrder:SortOrders? = null

    /**
    * Disables total / page counts - improves performance. Returns only data. If there is no more data, Items will be empty array
    */
    @ApiMember(Description="Disables total / page counts - improves performance. Returns only data. If there is no more data, Items will be empty array")
    open var simplifiedPaging:Boolean? = null
}

enum class SortOrders
{
    Ascend,
    Descend,
}

open class AlertInfo : EntityInfo()
{
    /**
    * The ID of the account associated with this alert
    */
    @ApiMember(Description="The ID of the account associated with this alert")
    open var accountId:String? = null

    /**
    * The name of the alert
    */
    @ApiMember(Description="The name of the alert")
    open var name:String? = null

    /**
    * The trigger alert
    */
    @ApiMember(Description="The trigger alert")
    open var trigger:AlertTriggers? = null

    /**
    * The number of hours for the window over which the alert will trigger
    */
    @ApiMember(Description="The number of hours for the window over which the alert will trigger")
    open var windowHours:Double? = null

    /**
    * The value at which the alert will trigger
    */
    @ApiMember(Description="The value at which the alert will trigger")
    open var threshold:Double? = null

    /**
    * The email addresses (one per line) to notify
    */
    @ApiMember(Description="The email addresses (one per line) to notify")
    open var notificationEmailAddresses:String? = null

    /**
    * Customer selection for this alert
    */
    @ApiMember(Description="Customer selection for this alert")
    open var customerSelection:AlertCustomerSelection? = null

    /**
    * The list of customer IDs for the selection model
    */
    @ApiMember(Description="The list of customer IDs for the selection model")
    open var customerIds:ArrayList<String>? = null
}

open class EntityInfo
{
    /**
    * The ID of the object
    */
    @ApiMember(Description="The ID of the object")
    open var id:String? = null

    /**
    * The date the object was created
    */
    @ApiMember(Description="The date the object was created")
    open var dateCreated:String? = null

    /**
    * The date the object was last modified
    */
    @ApiMember(Description="The date the object was last modified")
    open var dateLastModified:String? = null

    /**
    * The user that created this object
    */
    @ApiMember(Description="The user that created this object")
    open var createdBy:String? = null

    /**
    * The user that last modified this object
    */
    @ApiMember(Description="The user that last modified this object")
    open var lastModifiedBy:String? = null
}

enum class AlertTriggers
{
    CallSpend,
    CallCount,
}

enum class AlertCustomerSelection
{
    AllCustomers,
    ExcludeCustomers,
    IncludeCustomers,
}

open class ListResponse<T>
{
    /**
    * The items
    */
    @ApiMember(Description="The items")
    open var items:ArrayList<AccountInfo>? = null

    /**
    * The total number of items
    */
    @ApiMember(Description="The total number of items")
    open var totalCount:Int? = null

    /**
    * The total number of pages
    */
    @ApiMember(Description="The total number of pages")
    open var totalPages:Int? = null

    /**
    * Are there more pages of items? Used with simplified paging
    */
    @ApiMember(Description="Are there more pages of items? Used with simplified paging")
    open var hasMorePages:Boolean? = null
}

open class AccountInfo : EntityInfo()
{
    /**
    * The name of this account
    */
    @ApiMember(Description="The name of this account")
    open var name:String? = null

    /**
    * The ID of this account's parent
    */
    @ApiMember(Description="The ID of this account's parent")
    open var parentAccountId:String? = null

    /**
    * The twilio account SID
    */
    @ApiMember(Description="The twilio account SID")
    open var twilioAccountSid:String? = null

    /**
    * The ancestors of this account. Useful for breadcrumbs
    */
    @ApiMember(Description="The ancestors of this account. Useful for breadcrumbs")
    open var ancestorIds:ArrayList<String>? = null

    /**
    * The max number of phone numbers this account can have
    */
    @ApiMember(Description="The max number of phone numbers this account can have")
    open var maxPhoneNumbers:Int? = null

    /**
    * This account is BYOA
    */
    @ApiMember(Description="This account is BYOA")
    open var isBYOA:Boolean? = null

    /**
    * TrustHub Profile Sid
    */
    @ApiMember(Description="TrustHub Profile Sid")
    open var trustHubProfileSid:String? = null

    /**
    * The ID of the logo file
    */
    @ApiMember(Description="The ID of the logo file")
    open var logoId:String? = null

    /**
    * The URI of the logo file
    */
    @ApiMember(Description="The URI of the logo file")
    open var logoUri:String? = null

    /**
    * The billing settings for this account
    */
    @ApiMember(Description="The billing settings for this account")
    open var billingSettings:BillingSettings? = null

    /**
    * Enable international settings for the account?
    */
    @ApiMember(Description="Enable international settings for the account?")
    open var enableInternationalSettings:Boolean? = null

    /**
    * The default list of country codes the account can dial when not specified on customer
    */
    @ApiMember(Description="The default list of country codes the account can dial when not specified on customer")
    open var defaultInternationalCountryCodes:ArrayList<String>? = null
}

open class BillingSettings
{
    open var base:BillingItem? = null
    open var localNumbers:BillingItem? = null
    open var tollFreeNumbers:BillingItem? = null
    open var inboundVoiceCalls:BillingItem? = null
    open var outboundVoiceCalls:BillingItem? = null
    open var inboundFaxes:BillingItem? = null
    open var outboundFaxes:BillingItem? = null
    open var inboundSmsMessages:BillingItem? = null
    open var outboundSmsMessages:BillingItem? = null
    open var aiInsights:BillingItem? = null
    open var aiLiveMinutes:BillingItem? = null
    open var aiMessages:BillingItem? = null
    open var aiTranscriptions:BillingItem? = null
}

open class BillingItem
{
    open var baseCost:Double? = null
    open var rawUnitMultiplier:Double? = null
    open var unitCost:Double? = null
    open var allowance:Int? = null
}

Kotlin ListAlerts DTOs

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>