Evo Voice

<back to all web services

ListAlerts

Retrieve alerts

using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Voice.Api.Alerts;
using Voice.Api;
using Voice.Api.Accounts;

namespace Voice.Api
{
    public partial class EntityInfo
    {
        ///<summary>
        ///The ID of the object
        ///</summary>
        [ApiMember(Description="The ID of the object")]
        public virtual string Id { get; set; }

        ///<summary>
        ///The date the object was created
        ///</summary>
        [ApiMember(Description="The date the object was created")]
        public virtual string DateCreated { get; set; }

        ///<summary>
        ///The date the object was last modified
        ///</summary>
        [ApiMember(Description="The date the object was last modified")]
        public virtual string DateLastModified { get; set; }

        ///<summary>
        ///The user that created this object
        ///</summary>
        [ApiMember(Description="The user that created this object")]
        public virtual string CreatedBy { get; set; }

        ///<summary>
        ///The user that last modified this object
        ///</summary>
        [ApiMember(Description="The user that last modified this object")]
        public virtual string LastModifiedBy { get; set; }
    }

    public partial class ListRequest<T>
        : IGet
    {
        ///<summary>
        ///The page of data to retrieve
        ///</summary>
        [ApiMember(Description="The page of data to retrieve")]
        public virtual int Page { get; set; }

        ///<summary>
        ///If you want all objects to be returned. This should be used with care
        ///</summary>
        [ApiMember(Description="If you want all objects to be returned. This should be used with care")]
        public virtual bool All { get; set; }

        ///<summary>
        ///The number per page to retrieve
        ///</summary>
        [ApiMember(Description="The number per page to retrieve")]
        public virtual int CountPerPage { get; set; }

        ///<summary>
        ///Specific IDs
        ///</summary>
        [ApiMember(Description="Specific IDs")]
        public virtual List<string> SpecificIds { get; set; }

        ///<summary>
        ///Specify a sort field
        ///</summary>
        [ApiMember(Description="Specify a sort field")]
        public virtual string SortField { get; set; }

        ///<summary>
        ///Specify a sort order
        ///</summary>
        [ApiMember(Description="Specify a sort order")]
        public virtual SortOrders SortOrder { get; set; }

        ///<summary>
        ///Disables total / page counts - improves performance. Returns only data. If there is no more data, Items will be empty array
        ///</summary>
        [ApiMember(Description="Disables total / page counts - improves performance. Returns only data. If there is no more data, Items will be empty array")]
        public virtual bool SimplifiedPaging { get; set; }
    }

    public partial class ListResponse<T>
    {
        ///<summary>
        ///The items
        ///</summary>
        [ApiMember(Description="The items")]
        public virtual List<AccountInfo> Items { get; set; }

        ///<summary>
        ///The total number of items
        ///</summary>
        [ApiMember(Description="The total number of items")]
        public virtual int TotalCount { get; set; }

        ///<summary>
        ///The total number of pages
        ///</summary>
        [ApiMember(Description="The total number of pages")]
        public virtual int TotalPages { get; set; }

        ///<summary>
        ///Are there more pages of items? Used with simplified paging
        ///</summary>
        [ApiMember(Description="Are there more pages of items? Used with simplified paging")]
        public virtual bool HasMorePages { get; set; }
    }

    public enum SortOrders
    {
        Ascend,
        Descend,
    }

}

namespace Voice.Api.Accounts
{
    public partial class AccountInfo
        : EntityInfo
    {
        ///<summary>
        ///The name of this account
        ///</summary>
        [ApiMember(Description="The name of this account")]
        public virtual string Name { get; set; }

        ///<summary>
        ///The ID of this account's parent
        ///</summary>
        [ApiMember(Description="The ID of this account's parent")]
        public virtual string ParentAccountId { get; set; }

        ///<summary>
        ///The twilio account SID
        ///</summary>
        [ApiMember(Description="The twilio account SID")]
        public virtual string TwilioAccountSid { get; set; }

        ///<summary>
        ///The ancestors of this account. Useful for breadcrumbs
        ///</summary>
        [ApiMember(Description="The ancestors of this account. Useful for breadcrumbs")]
        public virtual List<string> AncestorIds { get; set; }

        ///<summary>
        ///The max number of phone numbers this account can have
        ///</summary>
        [ApiMember(Description="The max number of phone numbers this account can have")]
        public virtual int MaxPhoneNumbers { get; set; }

        ///<summary>
        ///This account is BYOA
        ///</summary>
        [ApiMember(Description="This account is BYOA")]
        public virtual bool IsBYOA { get; set; }

        ///<summary>
        ///TrustHub Profile Sid
        ///</summary>
        [ApiMember(Description="TrustHub Profile Sid")]
        public virtual string TrustHubProfileSid { get; set; }

        ///<summary>
        ///The ID of the logo file
        ///</summary>
        [ApiMember(Description="The ID of the logo file")]
        public virtual string LogoId { get; set; }

        ///<summary>
        ///The URI of the logo file
        ///</summary>
        [ApiMember(Description="The URI of the logo file")]
        public virtual string LogoUri { get; set; }

        ///<summary>
        ///The billing settings for this account
        ///</summary>
        [ApiMember(Description="The billing settings for this account")]
        public virtual BillingSettings BillingSettings { get; set; }

        ///<summary>
        ///Enable international settings for the account?
        ///</summary>
        [ApiMember(Description="Enable international settings for the account?")]
        public virtual bool EnableInternationalSettings { get; set; }

        ///<summary>
        ///The default list of country codes the account can dial when not specified on customer
        ///</summary>
        [ApiMember(Description="The default list of country codes the account can dial when not specified on customer")]
        public virtual List<string> DefaultInternationalCountryCodes { get; set; }
    }

    public partial class BillingItem
    {
        public virtual double BaseCost { get; set; }
        public virtual double RawUnitMultiplier { get; set; }
        public virtual double UnitCost { get; set; }
        public virtual int Allowance { get; set; }
    }

    public partial class BillingSettings
    {
        public virtual BillingItem Base { get; set; }
        public virtual BillingItem LocalNumbers { get; set; }
        public virtual BillingItem TollFreeNumbers { get; set; }
        public virtual BillingItem InboundVoiceCalls { get; set; }
        public virtual BillingItem OutboundVoiceCalls { get; set; }
        public virtual BillingItem InboundFaxes { get; set; }
        public virtual BillingItem OutboundFaxes { get; set; }
        public virtual BillingItem InboundSmsMessages { get; set; }
        public virtual BillingItem OutboundSmsMessages { get; set; }
        public virtual BillingItem AIInsights { get; set; }
        public virtual BillingItem AILiveMinutes { get; set; }
        public virtual BillingItem AIMessages { get; set; }
        public virtual BillingItem AITranscriptions { get; set; }
    }

}

namespace Voice.Api.Alerts
{
    public enum AlertCustomerSelection
    {
        AllCustomers,
        ExcludeCustomers,
        IncludeCustomers,
    }

    public partial class AlertInfo
        : EntityInfo
    {
        ///<summary>
        ///The ID of the account associated with this alert
        ///</summary>
        [ApiMember(Description="The ID of the account associated with this alert")]
        public virtual string AccountId { get; set; }

        ///<summary>
        ///The name of the alert
        ///</summary>
        [ApiMember(Description="The name of the alert")]
        public virtual string Name { get; set; }

        ///<summary>
        ///The trigger alert
        ///</summary>
        [ApiMember(Description="The trigger alert")]
        public virtual AlertTriggers Trigger { get; set; }

        ///<summary>
        ///The number of hours for the window over which the alert will trigger
        ///</summary>
        [ApiMember(Description="The number of hours for the window over which the alert will trigger")]
        public virtual double WindowHours { get; set; }

        ///<summary>
        ///The value at which the alert will trigger
        ///</summary>
        [ApiMember(Description="The value at which the alert will trigger")]
        public virtual double Threshold { get; set; }

        ///<summary>
        ///The email addresses (one per line) to notify
        ///</summary>
        [ApiMember(Description="The email addresses (one per line) to notify")]
        public virtual string NotificationEmailAddresses { get; set; }

        ///<summary>
        ///Customer selection for this alert
        ///</summary>
        [ApiMember(Description="Customer selection for this alert")]
        public virtual AlertCustomerSelection CustomerSelection { get; set; }

        ///<summary>
        ///The list of customer IDs for the selection model
        ///</summary>
        [ApiMember(Description="The list of customer IDs for the selection model")]
        public virtual List<string> CustomerIds { get; set; }
    }

    public enum AlertTriggers
    {
        CallSpend,
        CallCount,
    }

    ///<summary>
    ///Retrieve alerts
    ///</summary>
    [Api(Description="Retrieve alerts")]
    public partial class ListAlerts
        : ListRequest<AlertInfo>
    {
        ///<summary>
        ///Filter by accounts
        ///</summary>
        [ApiMember(Description="Filter by accounts")]
        public virtual List<string> AccountIds { get; set; }

        ///<summary>
        ///Filter by name
        ///</summary>
        [ApiMember(Description="Filter by name")]
        public virtual string NameFilter { get; set; }
    }

}

C# ListAlerts DTOs

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>