Evo Voice

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}

"use strict";
export class EntityInfo {
    /** @param {{id?:string,dateCreated?:string,dateLastModified?:string,createdBy?:string,lastModifiedBy?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description The ID of the object */
    id;
    /**
     * @type {string}
     * @description The date the object was created */
    dateCreated;
    /**
     * @type {string}
     * @description The date the object was last modified */
    dateLastModified;
    /**
     * @type {string}
     * @description The user that created this object */
    createdBy;
    /**
     * @type {string}
     * @description The user that last modified this object */
    lastModifiedBy;
}
/** @typedef {'CallSpend'|'CallCount'} */
export var AlertTriggers;
(function (AlertTriggers) {
    AlertTriggers["CallSpend"] = "CallSpend"
    AlertTriggers["CallCount"] = "CallCount"
})(AlertTriggers || (AlertTriggers = {}));
/** @typedef {'AllCustomers'|'ExcludeCustomers'|'IncludeCustomers'} */
export var AlertCustomerSelection;
(function (AlertCustomerSelection) {
    AlertCustomerSelection["AllCustomers"] = "AllCustomers"
    AlertCustomerSelection["ExcludeCustomers"] = "ExcludeCustomers"
    AlertCustomerSelection["IncludeCustomers"] = "IncludeCustomers"
})(AlertCustomerSelection || (AlertCustomerSelection = {}));
export class AlertInfo extends EntityInfo {
    /** @param {{accountId?:string,name?:string,trigger?:AlertTriggers,windowHours?:number,threshold?:number,notificationEmailAddresses?:string,customerSelection?:AlertCustomerSelection,customerIds?:string[],id?:string,dateCreated?:string,dateLastModified?:string,createdBy?:string,lastModifiedBy?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /**
     * @type {string}
     * @description The ID of the account associated with this alert */
    accountId;
    /**
     * @type {string}
     * @description The name of the alert */
    name;
    /**
     * @type {AlertTriggers}
     * @description The trigger alert */
    trigger;
    /**
     * @type {number}
     * @description The number of hours for the window over which the alert will trigger */
    windowHours;
    /**
     * @type {number}
     * @description The value at which the alert will trigger */
    threshold;
    /**
     * @type {string}
     * @description The email addresses (one per line) to notify */
    notificationEmailAddresses;
    /**
     * @type {AlertCustomerSelection}
     * @description Customer selection for this alert */
    customerSelection;
    /**
     * @type {string[]}
     * @description The list of customer IDs for the selection model */
    customerIds;
}
export class GetAlert {
    /** @param {{alertId?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description The ID of the alert you want to get */
    alertId;
}

JavaScript GetAlert DTOs

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

HTTP + CSV

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: team.evovoice.io 
Accept: text/csv

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"accountId":"String","name":"String","trigger":"CallSpend","windowHours":0,"threshold":0,"notificationEmailAddresses":"String","customerSelection":"AllCustomers","customerIds":["String"],"id":"String","dateCreated":"String","dateLastModified":"String","createdBy":"String","lastModifiedBy":"String"}