| Requires any of the roles: | SystemAdministrator, Manager, Customer |
| GET | /notifications |
|---|
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Voice.Api.Notifications;
using Voice.Api;
using Voice.Api.Customers;
using Voice.Api.Files;
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
{
public ListRequest()
{
SpecificIds = new List<string>{};
}
///<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<AccountInfo>
{
public ListResponse()
{
Items = new List<AccountInfo>{};
}
///<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
{
public AccountInfo()
{
AncestorIds = new List<string>{};
}
///<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; }
}
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; }
}
}
namespace Voice.Api.Customers
{
public partial class CustomerBreadcrumb
{
public virtual string Id { get; set; }
public virtual string Name { get; set; }
}
}
namespace Voice.Api.Files
{
public partial class FileInfo
: EntityInfo
{
public FileInfo()
{
CustomerBreadcrumb = new List<CustomerBreadcrumb>{};
}
///<summary>
///The type of file this is
///</summary>
[ApiMember(Description="The type of file this is")]
public virtual FileTypes Type { get; set; }
///<summary>
///The account ID this file is associated with
///</summary>
[ApiMember(Description="The account ID this file is associated with")]
public virtual string AccountId { get; set; }
///<summary>
///The name of the account this file is associated with
///</summary>
[ApiMember(Description="The name of the account this file is associated with")]
public virtual string AccountName { get; set; }
///<summary>
///The ID of the customer this file is associated with
///</summary>
[ApiMember(Description="The ID of the customer this file is associated with")]
public virtual string CustomerId { get; set; }
///<summary>
///The name of the customer this file is associated with
///</summary>
[ApiMember(Description="The name of the customer this file is associated with")]
public virtual string CustomerName { get; set; }
///<summary>
///The breadcrumb to the customer for this file
///</summary>
[ApiMember(Description="The breadcrumb to the customer for this file")]
public virtual List<CustomerBreadcrumb> CustomerBreadcrumb { get; set; }
///<summary>
///The ID of the user this file is assocaited with
///</summary>
[ApiMember(Description="The ID of the user this file is assocaited with")]
public virtual string UserId { get; set; }
///<summary>
///The name of the user this file is associated with
///</summary>
[ApiMember(Description="The name of the user this file is associated with")]
public virtual string UserName { get; set; }
///<summary>
///The original file name for the file
///</summary>
[ApiMember(Description="The original file name for the file")]
public virtual string FileName { get; set; }
///<summary>
///The URI of the file
///</summary>
[ApiMember(Description="The URI of the file")]
public virtual string Uri { get; set; }
///<summary>
///The Content type of the file
///</summary>
[ApiMember(Description="The Content type of the file")]
public virtual string ContentType { get; set; }
///<summary>
///The size of the file
///</summary>
[ApiMember(Description="The size of the file")]
public virtual long ContentLength { get; set; }
///<summary>
///The Twilio ID of the recording
///</summary>
[ApiMember(Description="The Twilio ID of the recording")]
public virtual string RecordingSid { get; set; }
///<summary>
///The duration of the recording in seconds
///</summary>
[ApiMember(Description="The duration of the recording in seconds")]
public virtual int RecordingDuration { get; set; }
///<summary>
///Who is the recording from?
///</summary>
[ApiMember(Description="Who is the recording from?")]
public virtual string RecordingFrom { get; set; }
///<summary>
///Transcription (if available)
///</summary>
[ApiMember(Description="Transcription (if available)")]
public virtual string Transcription { get; set; }
///<summary>
///From Address (e.g. caller ID) for incoming calls
///</summary>
[ApiMember(Description="From Address (e.g. caller ID) for incoming calls")]
public virtual string FromAddress { get; set; }
///<summary>
///To Address (e.g. dialed number) for outgoing calls
///</summary>
[ApiMember(Description="To Address (e.g. dialed number) for outgoing calls")]
public virtual string ToAddress { get; set; }
}
public enum FileTypes
{
Upload,
VoiceMessage,
CallRecording,
Fax,
Attachment,
FaxOutgoing,
}
}
namespace Voice.Api.Notifications
{
///<summary>
///Lists all endpoints
///</summary>
[Api(Description="Lists all endpoints")]
public partial class ListNotifications
: ListRequest<NotificationInfo>
{
public ListNotifications()
{
AccountIds = new List<string>{};
CustomerIds = new List<string>{};
}
///<summary>
///The IDs of the account whose notifications you want to retrieve
///</summary>
[ApiMember(Description="The IDs of the account whose notifications you want to retrieve")]
public virtual List<string> AccountIds { get; set; }
///<summary>
///The IDs of the customers whose notifications you want to retrieve
///</summary>
[ApiMember(Description="The IDs of the customers whose notifications you want to retrieve")]
public virtual List<string> CustomerIds { get; set; }
///<summary>
///Filter by From
///</summary>
[ApiMember(Description="Filter by From")]
public virtual string FromFilter { get; set; }
///<summary>
///Filter by To
///</summary>
[ApiMember(Description="Filter by To")]
public virtual string ToFilter { get; set; }
///<summary>
///Filter by Subject
///</summary>
[ApiMember(Description="Filter by Subject")]
public virtual string SubjectFilter { get; set; }
///<summary>
///The start date to retrieve usage records for (YYYY-MM-DD)
///</summary>
[ApiMember(Description="The start date to retrieve usage records for (YYYY-MM-DD)")]
public virtual string StartDate { get; set; }
///<summary>
///The end date to retrieve usage records for (YYYY-MM-DD)
///</summary>
[ApiMember(Description="The end date to retrieve usage records for (YYYY-MM-DD)")]
public virtual string EndDate { get; set; }
///<summary>
///Filter by type
///</summary>
[ApiMember(Description="Filter by type")]
public virtual NotificationTypes? Type { get; set; }
}
public partial class NotificationInfo
: EntityInfo
{
public NotificationInfo()
{
CustomerBreadcrumb = new List<CustomerBreadcrumb>{};
Recipients = new List<NotificationRecipientInfo>{};
Attachments = new List<FileInfo>{};
}
///<summary>
///The account ID this endpoint is associated with
///</summary>
[ApiMember(Description="The account ID this endpoint is associated with")]
public virtual string AccountId { get; set; }
///<summary>
///The name of the account this endpoint is associated with
///</summary>
[ApiMember(Description="The name of the account this endpoint is associated with")]
public virtual string AccountName { get; set; }
///<summary>
///The ID of the customer this endpoint is associated with
///</summary>
[ApiMember(Description="The ID of the customer this endpoint is associated with")]
public virtual string CustomerId { get; set; }
///<summary>
///The name of the customer this endpoint is associated with
///</summary>
[ApiMember(Description="The name of the customer this endpoint is associated with")]
public virtual string CustomerName { get; set; }
///<summary>
///The breadcrumb to the customer for this endpoint
///</summary>
[ApiMember(Description="The breadcrumb to the customer for this endpoint")]
public virtual List<CustomerBreadcrumb> CustomerBreadcrumb { get; set; }
///<summary>
///The type of notification
///</summary>
[ApiMember(Description="The type of notification")]
public virtual NotificationTypes Type { get; set; }
///<summary>
///The subject of the notification
///</summary>
[ApiMember(Description="The subject of the notification")]
public virtual string Subject { get; set; }
///<summary>
///The body of the notification
///</summary>
[ApiMember(Description="The body of the notification")]
public virtual string Body { get; set; }
///<summary>
///The recipients of this notification
///</summary>
[ApiMember(Description="The recipients of this notification")]
public virtual List<NotificationRecipientInfo> Recipients { get; set; }
///<summary>
///The list of attachments
///</summary>
[ApiMember(Description="The list of attachments")]
public virtual List<FileInfo> Attachments { get; set; }
///<summary>
///The original from for the session
///</summary>
[ApiMember(Description="The original from for the session")]
public virtual string From { get; set; }
///<summary>
///The original To for the session
///</summary>
[ApiMember(Description="The original To for the session")]
public virtual string To { get; set; }
///<summary>
///Was there an error?
///</summary>
[ApiMember(Description="Was there an error?")]
public virtual bool Error { get; set; }
///<summary>
///The error message
///</summary>
[ApiMember(Description="The error message")]
public virtual string ErrorMessage { get; set; }
}
public partial class NotificationRecipientInfo
{
///<summary>
///The address of the recipient
///</summary>
[ApiMember(Description="The address of the recipient")]
public virtual string Address { get; set; }
///<summary>
///Extra info about the recipient e.g. CC, BCC
///</summary>
[ApiMember(Description="Extra info about the recipient e.g. CC, BCC")]
public virtual string Extra { get; set; }
///<summary>
///The name of the recipient
///</summary>
[ApiMember(Description="The name of the recipient")]
public virtual string Name { get; set; }
}
public enum NotificationTypes
{
Email,
Sms,
Push,
IncomingCall,
OutgoingCall,
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
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,
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
}