Requires any of the roles: | SystemAdministrator, Manager, Customer |
GET | /notifications |
---|
export class NodeParameterMap
{
[key:string] : NodeParameter;
public constructor(init?: Partial<NodeParameterMap>) { (Object as any).assign(this, init); }
}
export enum SortOrders
{
Ascend = 'Ascend',
Descend = 'Descend',
}
export class ListRequest<T> implements IGet
{
/**
* The page of data to retrieve
*/
// @ApiMember(Description="The page of data to retrieve")
public page?: number;
/**
* 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")
public all?: boolean;
/**
* The number per page to retrieve
*/
// @ApiMember(Description="The number per page to retrieve")
public countPerPage?: number;
/**
* Specific IDs
*/
// @ApiMember(Description="Specific IDs")
public specificIds?: string[];
/**
* Specify a sort field
*/
// @ApiMember(Description="Specify a sort field")
public sortField?: string;
/**
* Specify a sort order
*/
// @ApiMember(Description="Specify a sort order")
public sortOrder?: SortOrders;
/**
* 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")
public simplifiedPaging?: boolean;
public constructor(init?: Partial<ListRequest<T>>) { (Object as any).assign(this, init); }
}
export class EntityInfo
{
/**
* The ID of the object
*/
// @ApiMember(Description="The ID of the object")
public id?: string;
/**
* The date the object was created
*/
// @ApiMember(Description="The date the object was created")
public dateCreated?: string;
/**
* The date the object was last modified
*/
// @ApiMember(Description="The date the object was last modified")
public dateLastModified?: string;
/**
* The user that created this object
*/
// @ApiMember(Description="The user that created this object")
public createdBy?: string;
/**
* The user that last modified this object
*/
// @ApiMember(Description="The user that last modified this object")
public lastModifiedBy?: string;
public constructor(init?: Partial<EntityInfo>) { (Object as any).assign(this, init); }
}
export class CustomerBreadcrumb
{
public id?: string;
public name?: string;
public constructor(init?: Partial<CustomerBreadcrumb>) { (Object as any).assign(this, init); }
}
export enum NotificationTypes
{
Email = 'Email',
Sms = 'Sms',
Push = 'Push',
IncomingCall = 'IncomingCall',
OutgoingCall = 'OutgoingCall',
}
export class NotificationRecipientInfo
{
/**
* The address of the recipient
*/
// @ApiMember(Description="The address of the recipient")
public address?: string;
/**
* Extra info about the recipient e.g. CC, BCC
*/
// @ApiMember(Description="Extra info about the recipient e.g. CC, BCC")
public extra?: string;
/**
* The name of the recipient
*/
// @ApiMember(Description="The name of the recipient")
public name?: string;
public constructor(init?: Partial<NotificationRecipientInfo>) { (Object as any).assign(this, init); }
}
export enum FileTypes
{
Upload = 'Upload',
VoiceMessage = 'VoiceMessage',
CallRecording = 'CallRecording',
Fax = 'Fax',
Attachment = 'Attachment',
FaxOutgoing = 'FaxOutgoing',
}
export class FileInfo extends EntityInfo
{
/**
* The type of file this is
*/
// @ApiMember(Description="The type of file this is")
public type?: FileTypes;
/**
* The account ID this file is associated with
*/
// @ApiMember(Description="The account ID this file is associated with")
public accountId?: string;
/**
* The name of the account this file is associated with
*/
// @ApiMember(Description="The name of the account this file is associated with")
public accountName?: string;
/**
* The ID of the customer this file is associated with
*/
// @ApiMember(Description="The ID of the customer this file is associated with")
public customerId?: string;
/**
* The name of the customer this file is associated with
*/
// @ApiMember(Description="The name of the customer this file is associated with")
public customerName?: string;
/**
* The breadcrumb to the customer for this file
*/
// @ApiMember(Description="The breadcrumb to the customer for this file")
public customerBreadcrumb?: CustomerBreadcrumb[];
/**
* The ID of the user this file is assocaited with
*/
// @ApiMember(Description="The ID of the user this file is assocaited with")
public userId?: string;
/**
* The name of the user this file is associated with
*/
// @ApiMember(Description="The name of the user this file is associated with")
public userName?: string;
/**
* The original file name for the file
*/
// @ApiMember(Description="The original file name for the file")
public fileName?: string;
/**
* The URI of the file
*/
// @ApiMember(Description="The URI of the file")
public uri?: string;
/**
* The Content type of the file
*/
// @ApiMember(Description="The Content type of the file")
public contentType?: string;
/**
* The size of the file
*/
// @ApiMember(Description="The size of the file")
public contentLength?: number;
/**
* The Twilio ID of the recording
*/
// @ApiMember(Description="The Twilio ID of the recording")
public recordingSid?: string;
/**
* The duration of the recording in seconds
*/
// @ApiMember(Description="The duration of the recording in seconds")
public recordingDuration?: number;
/**
* Who is the recording from?
*/
// @ApiMember(Description="Who is the recording from?")
public recordingFrom?: string;
/**
* Transcription (if available)
*/
// @ApiMember(Description="Transcription (if available)")
public transcription?: string;
/**
* From Address (e.g. caller ID) for incoming calls
*/
// @ApiMember(Description="From Address (e.g. caller ID) for incoming calls")
public fromAddress?: string;
/**
* To Address (e.g. dialed number) for outgoing calls
*/
// @ApiMember(Description="To Address (e.g. dialed number) for outgoing calls")
public toAddress?: string;
public constructor(init?: Partial<FileInfo>) { super(init); (Object as any).assign(this, init); }
}
export class NotificationInfo extends EntityInfo
{
/**
* The account ID this endpoint is associated with
*/
// @ApiMember(Description="The account ID this endpoint is associated with")
public accountId?: string;
/**
* The name of the account this endpoint is associated with
*/
// @ApiMember(Description="The name of the account this endpoint is associated with")
public accountName?: string;
/**
* The ID of the customer this endpoint is associated with
*/
// @ApiMember(Description="The ID of the customer this endpoint is associated with")
public customerId?: string;
/**
* The name of the customer this endpoint is associated with
*/
// @ApiMember(Description="The name of the customer this endpoint is associated with")
public customerName?: string;
/**
* The breadcrumb to the customer for this endpoint
*/
// @ApiMember(Description="The breadcrumb to the customer for this endpoint")
public customerBreadcrumb?: CustomerBreadcrumb[];
/**
* The type of notification
*/
// @ApiMember(Description="The type of notification")
public type?: NotificationTypes;
/**
* The subject of the notification
*/
// @ApiMember(Description="The subject of the notification")
public subject?: string;
/**
* The body of the notification
*/
// @ApiMember(Description="The body of the notification")
public body?: string;
/**
* The recipients of this notification
*/
// @ApiMember(Description="The recipients of this notification")
public recipients?: NotificationRecipientInfo[];
/**
* The list of attachments
*/
// @ApiMember(Description="The list of attachments")
public attachments?: FileInfo[];
/**
* The original from for the session
*/
// @ApiMember(Description="The original from for the session")
public from?: string;
/**
* The original To for the session
*/
// @ApiMember(Description="The original To for the session")
public to?: string;
/**
* Was there an error?
*/
// @ApiMember(Description="Was there an error?")
public error?: boolean;
/**
* The error message
*/
// @ApiMember(Description="The error message")
public errorMessage?: string;
public constructor(init?: Partial<NotificationInfo>) { super(init); (Object as any).assign(this, init); }
}
/**
* Lists all endpoints
*/
// @Api(Description="Lists all endpoints")
export class ListNotifications extends ListRequest<NotificationInfo>
{
/**
* The IDs of the account whose notifications you want to retrieve
*/
// @ApiMember(Description="The IDs of the account whose notifications you want to retrieve")
public accountIds?: string[];
/**
* The IDs of the customers whose notifications you want to retrieve
*/
// @ApiMember(Description="The IDs of the customers whose notifications you want to retrieve")
public customerIds?: string[];
/**
* Filter by From
*/
// @ApiMember(Description="Filter by From")
public fromFilter?: string;
/**
* Filter by To
*/
// @ApiMember(Description="Filter by To")
public toFilter?: string;
/**
* Filter by Subject
*/
// @ApiMember(Description="Filter by Subject")
public subjectFilter?: string;
/**
* The start date to retrieve usage records for (YYYY-MM-DD)
*/
// @ApiMember(Description="The start date to retrieve usage records for (YYYY-MM-DD)")
public startDate?: string;
/**
* The end date to retrieve usage records for (YYYY-MM-DD)
*/
// @ApiMember(Description="The end date to retrieve usage records for (YYYY-MM-DD)")
public endDate?: string;
/**
* Filter by type
*/
// @ApiMember(Description="Filter by type")
public type?: NotificationTypes;
public constructor(init?: Partial<ListNotifications>) { super(init); (Object as any).assign(this, init); }
}
export class BillingItem
{
public baseCost?: number;
public rawUnitMultiplier?: number;
public unitCost?: number;
public allowance?: number;
public constructor(init?: Partial<BillingItem>) { (Object as any).assign(this, init); }
}
export class BillingSettings
{
public base?: BillingItem;
public localNumbers?: BillingItem;
public tollFreeNumbers?: BillingItem;
public inboundVoiceCalls?: BillingItem;
public outboundVoiceCalls?: BillingItem;
public inboundFaxes?: BillingItem;
public outboundFaxes?: BillingItem;
public inboundSmsMessages?: BillingItem;
public outboundSmsMessages?: BillingItem;
public constructor(init?: Partial<BillingSettings>) { (Object as any).assign(this, init); }
}
export class AccountInfo extends EntityInfo
{
/**
* The name of this account
*/
// @ApiMember(Description="The name of this account")
public name?: string;
/**
* The ID of this account's parent
*/
// @ApiMember(Description="The ID of this account's parent")
public parentAccountId?: string;
/**
* The twilio account SID
*/
// @ApiMember(Description="The twilio account SID")
public twilioAccountSid?: string;
/**
* The ancestors of this account. Useful for breadcrumbs
*/
// @ApiMember(Description="The ancestors of this account. Useful for breadcrumbs")
public ancestorIds?: string[];
/**
* The max number of phone numbers this account can have
*/
// @ApiMember(Description="The max number of phone numbers this account can have")
public maxPhoneNumbers?: number;
/**
* This account is BYOA
*/
// @ApiMember(Description="This account is BYOA")
public isBYOA?: boolean;
/**
* TrustHub Profile Sid
*/
// @ApiMember(Description="TrustHub Profile Sid")
public trustHubProfileSid?: string;
/**
* The ID of the logo file
*/
// @ApiMember(Description="The ID of the logo file")
public logoId?: string;
/**
* The URI of the logo file
*/
// @ApiMember(Description="The URI of the logo file")
public logoUri?: string;
/**
* The billing settings for this account
*/
// @ApiMember(Description="The billing settings for this account")
public billingSettings?: BillingSettings;
public constructor(init?: Partial<AccountInfo>) { super(init); (Object as any).assign(this, init); }
}
export class ListResponse<AccountInfo>
{
/**
* The items
*/
// @ApiMember(Description="The items")
public items?: AccountInfo[];
/**
* The total number of items
*/
// @ApiMember(Description="The total number of items")
public totalCount?: number;
/**
* The total number of pages
*/
// @ApiMember(Description="The total number of pages")
public totalPages?: number;
/**
* Are there more pages of items? Used with simplified paging
*/
// @ApiMember(Description="Are there more pages of items? Used with simplified paging")
public hasMorePages?: boolean;
public constructor(init?: Partial<ListResponse<AccountInfo>>) { (Object as any).assign(this, init); }
}
TypeScript ListNotifications DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /notifications HTTP/1.1 Host: evovoice.io Accept: application/xml
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <ListResponseOfNotificationInfofvYQJmgX 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.Notifications"> <d2p1:NotificationInfo> <CreatedBy>String</CreatedBy> <DateCreated>String</DateCreated> <DateLastModified>String</DateLastModified> <Id>String</Id> <LastModifiedBy>String</LastModifiedBy> <d2p1:AccountId>String</d2p1:AccountId> <d2p1:AccountName>String</d2p1:AccountName> <d2p1:Attachments xmlns:d4p1="http://schemas.datacontract.org/2004/07/Voice.Api.Files"> <d4p1:FileInfo> <CreatedBy>String</CreatedBy> <DateCreated>String</DateCreated> <DateLastModified>String</DateLastModified> <Id>String</Id> <LastModifiedBy>String</LastModifiedBy> <d4p1:AccountId>String</d4p1:AccountId> <d4p1:AccountName>String</d4p1:AccountName> <d4p1:ContentLength>0</d4p1:ContentLength> <d4p1:ContentType>String</d4p1:ContentType> <d4p1:CustomerBreadcrumb xmlns:d6p1="http://schemas.datacontract.org/2004/07/Voice.Api.Customers"> <d6p1:CustomerBreadcrumb> <d6p1:Id>String</d6p1:Id> <d6p1:Name>String</d6p1:Name> </d6p1:CustomerBreadcrumb> </d4p1:CustomerBreadcrumb> <d4p1:CustomerId>String</d4p1:CustomerId> <d4p1:CustomerName>String</d4p1:CustomerName> <d4p1:FileName>String</d4p1:FileName> <d4p1:FromAddress>String</d4p1:FromAddress> <d4p1:RecordingDuration>0</d4p1:RecordingDuration> <d4p1:RecordingFrom>String</d4p1:RecordingFrom> <d4p1:RecordingSid>String</d4p1:RecordingSid> <d4p1:ToAddress>String</d4p1:ToAddress> <d4p1:Transcription>String</d4p1:Transcription> <d4p1:Type>Upload</d4p1:Type> <d4p1:Uri>String</d4p1:Uri> <d4p1:UserId>String</d4p1:UserId> <d4p1:UserName>String</d4p1:UserName> </d4p1:FileInfo> </d2p1:Attachments> <d2p1:Body>String</d2p1:Body> <d2p1:CustomerBreadcrumb xmlns:d4p1="http://schemas.datacontract.org/2004/07/Voice.Api.Customers"> <d4p1:CustomerBreadcrumb> <d4p1:Id>String</d4p1:Id> <d4p1:Name>String</d4p1:Name> </d4p1:CustomerBreadcrumb> </d2p1:CustomerBreadcrumb> <d2p1:CustomerId>String</d2p1:CustomerId> <d2p1:CustomerName>String</d2p1:CustomerName> <d2p1:Error>false</d2p1:Error> <d2p1:ErrorMessage>String</d2p1:ErrorMessage> <d2p1:From>String</d2p1:From> <d2p1:Recipients> <d2p1:NotificationRecipientInfo> <d2p1:Address>String</d2p1:Address> <d2p1:Extra>String</d2p1:Extra> <d2p1:Name>String</d2p1:Name> </d2p1:NotificationRecipientInfo> </d2p1:Recipients> <d2p1:Subject>String</d2p1:Subject> <d2p1:To>String</d2p1:To> <d2p1:Type>Email</d2p1:Type> </d2p1:NotificationInfo> </Items> <TotalCount>0</TotalCount> <TotalPages>0</TotalPages> </ListResponseOfNotificationInfofvYQJmgX>