| Requires any of the roles: | SystemAdministrator, Manager, Customer |
| GET | /notifications |
|---|
"use strict";
/** @typedef {'Ascend'|'Descend'} */
export var SortOrders;
(function (SortOrders) {
SortOrders["Ascend"] = "Ascend"
SortOrders["Descend"] = "Descend"
})(SortOrders || (SortOrders = {}));
/** @typedef T {any} */
export class ListRequest {
/** @param {{page?:number,all?:boolean,countPerPage?:number,specificIds?:string[],sortField?:string,sortOrder?:SortOrders,simplifiedPaging?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {number}
* @description The page of data to retrieve */
page;
/**
* @type {boolean}
* @description If you want all objects to be returned. This should be used with care */
all;
/**
* @type {number}
* @description The number per page to retrieve */
countPerPage;
/**
* @type {string[]}
* @description Specific IDs */
specificIds;
/**
* @type {string}
* @description Specify a sort field */
sortField;
/**
* @type {SortOrders}
* @description Specify a sort order */
sortOrder;
/**
* @type {boolean}
* @description Disables total / page counts - improves performance. Returns only data. If there is no more data, Items will be empty array */
simplifiedPaging;
}
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;
}
export class CustomerBreadcrumb {
/** @param {{id?:string,name?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
id;
/** @type {string} */
name;
}
/** @typedef {'Email'|'Sms'|'Push'|'IncomingCall'|'OutgoingCall'} */
export var NotificationTypes;
(function (NotificationTypes) {
NotificationTypes["Email"] = "Email"
NotificationTypes["Sms"] = "Sms"
NotificationTypes["Push"] = "Push"
NotificationTypes["IncomingCall"] = "IncomingCall"
NotificationTypes["OutgoingCall"] = "OutgoingCall"
})(NotificationTypes || (NotificationTypes = {}));
export class NotificationRecipientInfo {
/** @param {{address?:string,extra?:string,name?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description The address of the recipient */
address;
/**
* @type {string}
* @description Extra info about the recipient e.g. CC, BCC */
extra;
/**
* @type {string}
* @description The name of the recipient */
name;
}
/** @typedef {'Upload'|'VoiceMessage'|'CallRecording'|'Fax'|'Attachment'|'FaxOutgoing'} */
export var FileTypes;
(function (FileTypes) {
FileTypes["Upload"] = "Upload"
FileTypes["VoiceMessage"] = "VoiceMessage"
FileTypes["CallRecording"] = "CallRecording"
FileTypes["Fax"] = "Fax"
FileTypes["Attachment"] = "Attachment"
FileTypes["FaxOutgoing"] = "FaxOutgoing"
})(FileTypes || (FileTypes = {}));
export class FileInfo extends EntityInfo {
/** @param {{type?:FileTypes,accountId?:string,accountName?:string,customerId?:string,customerName?:string,customerBreadcrumb?:CustomerBreadcrumb[],userId?:string,userName?:string,fileName?:string,uri?:string,contentType?:string,contentLength?:number,recordingSid?:string,recordingDuration?:number,recordingFrom?:string,transcription?:string,fromAddress?:string,toAddress?:string,aiTranscription?:string,id?:string,dateCreated?:string,dateLastModified?:string,createdBy?:string,lastModifiedBy?:string}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/**
* @type {FileTypes}
* @description The type of file this is */
type;
/**
* @type {string}
* @description The account ID this file is associated with */
accountId;
/**
* @type {string}
* @description The name of the account this file is associated with */
accountName;
/**
* @type {string}
* @description The ID of the customer this file is associated with */
customerId;
/**
* @type {string}
* @description The name of the customer this file is associated with */
customerName;
/**
* @type {CustomerBreadcrumb[]}
* @description The breadcrumb to the customer for this file */
customerBreadcrumb;
/**
* @type {string}
* @description The ID of the user this file is assocaited with */
userId;
/**
* @type {string}
* @description The name of the user this file is associated with */
userName;
/**
* @type {string}
* @description The original file name for the file */
fileName;
/**
* @type {string}
* @description The URI of the file */
uri;
/**
* @type {string}
* @description The Content type of the file */
contentType;
/**
* @type {number}
* @description The size of the file */
contentLength;
/**
* @type {string}
* @description The Twilio ID of the recording */
recordingSid;
/**
* @type {number}
* @description The duration of the recording in seconds */
recordingDuration;
/**
* @type {string}
* @description Who is the recording from? */
recordingFrom;
/**
* @type {string}
* @description Transcription (if available) */
transcription;
/**
* @type {string}
* @description From Address (e.g. caller ID) for incoming calls */
fromAddress;
/**
* @type {string}
* @description To Address (e.g. dialed number) for outgoing calls */
toAddress;
/**
* @type {string}
* @description The AI transcription for this call */
aiTranscription;
}
export class NotificationInfo extends EntityInfo {
/** @param {{accountId?:string,accountName?:string,customerId?:string,customerName?:string,customerBreadcrumb?:CustomerBreadcrumb[],type?:NotificationTypes,subject?:string,body?:string,recipients?:NotificationRecipientInfo[],attachments?:FileInfo[],from?:string,to?:string,error?:boolean,errorMessage?:string,id?:string,dateCreated?:string,dateLastModified?:string,createdBy?:string,lastModifiedBy?:string}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/**
* @type {string}
* @description The account ID this endpoint is associated with */
accountId;
/**
* @type {string}
* @description The name of the account this endpoint is associated with */
accountName;
/**
* @type {string}
* @description The ID of the customer this endpoint is associated with */
customerId;
/**
* @type {string}
* @description The name of the customer this endpoint is associated with */
customerName;
/**
* @type {CustomerBreadcrumb[]}
* @description The breadcrumb to the customer for this endpoint */
customerBreadcrumb;
/**
* @type {NotificationTypes}
* @description The type of notification */
type;
/**
* @type {string}
* @description The subject of the notification */
subject;
/**
* @type {string}
* @description The body of the notification */
body;
/**
* @type {NotificationRecipientInfo[]}
* @description The recipients of this notification */
recipients;
/**
* @type {FileInfo[]}
* @description The list of attachments */
attachments;
/**
* @type {string}
* @description The original from for the session */
from;
/**
* @type {string}
* @description The original To for the session */
to;
/**
* @type {boolean}
* @description Was there an error? */
error;
/**
* @type {string}
* @description The error message */
errorMessage;
}
export class ListNotifications extends ListRequest {
/** @param {{accountIds?:string[],customerIds?:string[],fromFilter?:string,toFilter?:string,subjectFilter?:string,startDate?:string,endDate?:string,type?:NotificationTypes,page?:number,all?:boolean,countPerPage?:number,specificIds?:string[],sortField?:string,sortOrder?:SortOrders,simplifiedPaging?:boolean}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/**
* @type {string[]}
* @description The IDs of the account whose notifications you want to retrieve */
accountIds;
/**
* @type {string[]}
* @description The IDs of the customers whose notifications you want to retrieve */
customerIds;
/**
* @type {string}
* @description Filter by From */
fromFilter;
/**
* @type {string}
* @description Filter by To */
toFilter;
/**
* @type {string}
* @description Filter by Subject */
subjectFilter;
/**
* @type {string}
* @description The start date to retrieve usage records for (YYYY-MM-DD) */
startDate;
/**
* @type {string}
* @description The end date to retrieve usage records for (YYYY-MM-DD) */
endDate;
/**
* @type {?NotificationTypes}
* @description Filter by type */
type;
}
export class BillingItem {
/** @param {{baseCost?:number,rawUnitMultiplier?:number,unitCost?:number,allowance?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
baseCost;
/** @type {number} */
rawUnitMultiplier;
/** @type {number} */
unitCost;
/** @type {number} */
allowance;
}
export class BillingSettings {
/** @param {{base?:BillingItem,localNumbers?:BillingItem,tollFreeNumbers?:BillingItem,inboundVoiceCalls?:BillingItem,outboundVoiceCalls?:BillingItem,inboundFaxes?:BillingItem,outboundFaxes?:BillingItem,inboundSmsMessages?:BillingItem,outboundSmsMessages?:BillingItem,aiInsights?:BillingItem,aiLiveMinutes?:BillingItem}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {BillingItem} */
base;
/** @type {BillingItem} */
localNumbers;
/** @type {BillingItem} */
tollFreeNumbers;
/** @type {BillingItem} */
inboundVoiceCalls;
/** @type {BillingItem} */
outboundVoiceCalls;
/** @type {BillingItem} */
inboundFaxes;
/** @type {BillingItem} */
outboundFaxes;
/** @type {BillingItem} */
inboundSmsMessages;
/** @type {BillingItem} */
outboundSmsMessages;
/** @type {BillingItem} */
aiInsights;
/** @type {BillingItem} */
aiLiveMinutes;
}
export class AccountInfo extends EntityInfo {
/** @param {{name?:string,parentAccountId?:string,twilioAccountSid?:string,ancestorIds?:string[],maxPhoneNumbers?:number,isBYOA?:boolean,trustHubProfileSid?:string,logoId?:string,logoUri?:string,billingSettings?:BillingSettings,id?:string,dateCreated?:string,dateLastModified?:string,createdBy?:string,lastModifiedBy?:string}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/**
* @type {string}
* @description The name of this account */
name;
/**
* @type {string}
* @description The ID of this account's parent */
parentAccountId;
/**
* @type {string}
* @description The twilio account SID */
twilioAccountSid;
/**
* @type {string[]}
* @description The ancestors of this account. Useful for breadcrumbs */
ancestorIds;
/**
* @type {number}
* @description The max number of phone numbers this account can have */
maxPhoneNumbers;
/**
* @type {boolean}
* @description This account is BYOA */
isBYOA;
/**
* @type {string}
* @description TrustHub Profile Sid */
trustHubProfileSid;
/**
* @type {string}
* @description The ID of the logo file */
logoId;
/**
* @type {string}
* @description The URI of the logo file */
logoUri;
/**
* @type {BillingSettings}
* @description The billing settings for this account */
billingSettings;
}
/** @typedef T {any} */
export class ListResponse {
/** @param {{items?:AccountInfo[],totalCount?:number,totalPages?:number,hasMorePages?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {AccountInfo[]}
* @description The items */
items;
/**
* @type {number}
* @description The total number of items */
totalCount;
/**
* @type {number}
* @description The total number of pages */
totalPages;
/**
* @type {boolean}
* @description Are there more pages of items? Used with simplified paging */
hasMorePages;
}
JavaScript ListNotifications DTOs
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
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /notifications HTTP/1.1 Host: team.evovoice.io Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"items":[{"accountId":"String","accountName":"String","customerId":"String","customerName":"String","customerBreadcrumb":[{"id":"String","name":"String"}],"type":"Email","subject":"String","body":"String","recipients":[{"address":"String","extra":"String","name":"String"}],"attachments":[{"type":"Upload","accountId":"String","accountName":"String","customerId":"String","customerName":"String","customerBreadcrumb":[{"id":"String","name":"String"}],"userId":"String","userName":"String","fileName":"String","uri":"String","contentType":"String","contentLength":0,"recordingSid":"String","recordingDuration":0,"recordingFrom":"String","transcription":"String","fromAddress":"String","toAddress":"String","aiTranscription":"String","id":"String","dateCreated":"String","dateLastModified":"String","createdBy":"String","lastModifiedBy":"String"}],"from":"String","to":"String","error":false,"errorMessage":"String","id":"String","dateCreated":"String","dateLastModified":"String","createdBy":"String","lastModifiedBy":"String"}],"totalCount":0,"totalPages":0,"hasMorePages":false}