Evo Voice

ListNotifications

Lists all endpoints

**Requires Authentication**
Requires any of the roles:	SystemAdministrator, Manager, Customer

The following routes are available for this service:
GET	/notifications

**ListNotifications** Parameters:
Name	Parameter	Data Type	Required	Description
AccountIds	query	List<string>	No	The IDs of the account whose notifications you want to retrieve
CustomerIds	query	List<string>	No	The IDs of the customers whose notifications you want to retrieve
FromFilter	query	string	No	Filter by From
ToFilter	query	string	No	Filter by To
SubjectFilter	query	string	No	Filter by Subject
StartDate	query	string	No	The start date to retrieve usage records for (YYYY-MM-DD)
EndDate	query	string	No	The end date to retrieve usage records for (YYYY-MM-DD)
Type	query	NotificationTypes?	No	Filter by type

**ListRequest<T>** Parameters:
Name	Parameter	Data Type	Required	Description
Page	form	int	No	The page of data to retrieve
All	form	bool	No	If you want all objects to be returned. This should be used with care
CountPerPage	form	int	No	The number per page to retrieve
SpecificIds	form	List<string>	No	Specific IDs
SortField	form	string	No	Specify a sort field
SortOrder	form	SortOrders	No	Specify a sort order
SimplifiedPaging	form	bool	No	Disables total / page counts - improves performance. Returns only data. If there is no more data, Items will be empty array

**SortOrders** Enum:
Ascend
Descend

**NotificationInfo** Parameters:
Name	Parameter	Data Type	Required	Description
AccountId	form	string	No	The account ID this endpoint is associated with
AccountName	form	string	No	The name of the account this endpoint is associated with
CustomerId	form	string	No	The ID of the customer this endpoint is associated with
CustomerName	form	string	No	The name of the customer this endpoint is associated with
CustomerBreadcrumb	form	List<CustomerBreadcrumb>	No	The breadcrumb to the customer for this endpoint
Type	form	NotificationTypes	No	The type of notification
Subject	form	string	No	The subject of the notification
Body	form	string	No	The body of the notification
Recipients	form	List<NotificationRecipientInfo>	No	The recipients of this notification
Attachments	form	List<FileInfo>	No	The list of attachments
From	form	string	No	The original from for the session
To	form	string	No	The original To for the session
Error	form	bool	No	Was there an error?
ErrorMessage	form	string	No	The error message

**EntityInfo** Parameters:
Name	Parameter	Data Type	Required	Description
Id	form	string	No	The ID of the object
DateCreated	form	string	No	The date the object was created
DateLastModified	form	string	No	The date the object was last modified
CreatedBy	form	string	No	The user that created this object
LastModifiedBy	form	string	No	The user that last modified this object

**CustomerBreadcrumb** Parameters:
Name	Parameter	Data Type	Required	Description
Id	form	string	No
Name	form	string	No

**NotificationTypes** Enum:
Email
Sms
Push
IncomingCall
OutgoingCall

**NotificationRecipientInfo** Parameters:
Name	Parameter	Data Type	Required	Description
Address	form	string	No	The address of the recipient
Extra	form	string	No	Extra info about the recipient e.g. CC, BCC
Name	form	string	No	The name of the recipient

**FileInfo** Parameters:
Name	Parameter	Data Type	Required	Description
Type	form	FileTypes	No	The type of file this is
AccountId	form	string	No	The account ID this file is associated with
AccountName	form	string	No	The name of the account this file is associated with
CustomerId	form	string	No	The ID of the customer this file is associated with
CustomerName	form	string	No	The name of the customer this file is associated with
CustomerBreadcrumb	form	List<CustomerBreadcrumb>	No	The breadcrumb to the customer for this file
UserId	form	string	No	The ID of the user this file is assocaited with
UserName	form	string	No	The name of the user this file is associated with
FileName	form	string	No	The original file name for the file
Uri	form	string	No	The URI of the file
ContentType	form	string	No	The Content type of the file
ContentLength	form	long	No	The size of the file
RecordingSid	form	string	No	The Twilio ID of the recording
RecordingDuration	form	int	No	The duration of the recording in seconds
RecordingFrom	form	string	No	Who is the recording from?
Transcription	form	string	No	Transcription (if available)
FromAddress	form	string	No	From Address (e.g. caller ID) for incoming calls
ToAddress	form	string	No	To Address (e.g. dialed number) for outgoing calls
AITranscription	form	string	No	The AI transcription for this call

**FileTypes** Enum:
Upload
VoiceMessage
CallRecording
Fax
Attachment
FaxOutgoing

**ListResponse<T>** Parameters:
Name	Parameter	Data Type	Required	Description
Items	form	List<AccountInfo>	No	The items
TotalCount	form	int	No	The total number of items
TotalPages	form	int	No	The total number of pages
HasMorePages	form	bool	No	Are there more pages of items? Used with simplified paging

**AccountInfo** Parameters:
Name	Parameter	Data Type	Required	Description
Name	form	string	No	The name of this account
ParentAccountId	form	string	No	The ID of this account's parent
TwilioAccountSid	form	string	No	The twilio account SID
AncestorIds	form	List<string>	No	The ancestors of this account. Useful for breadcrumbs
MaxPhoneNumbers	form	int	No	The max number of phone numbers this account can have
IsBYOA	form	bool	No	This account is BYOA
TrustHubProfileSid	form	string	No	TrustHub Profile Sid
LogoId	form	string	No	The ID of the logo file
LogoUri	form	string	No	The URI of the logo file
BillingSettings	form	BillingSettings	No	The billing settings for this account

**BillingSettings** Parameters:
Name	Parameter	Data Type	Required
Base	form	BillingItem	No
LocalNumbers	form	BillingItem	No
TollFreeNumbers	form	BillingItem	No
InboundVoiceCalls	form	BillingItem	No
OutboundVoiceCalls	form	BillingItem	No
InboundFaxes	form	BillingItem	No
OutboundFaxes	form	BillingItem	No
InboundSmsMessages	form	BillingItem	No
OutboundSmsMessages	form	BillingItem	No
AIInsights	form	BillingItem	No
AILiveMinutes	form	BillingItem	No
AIMessages	form	BillingItem	No

**BillingItem** Parameters:
Name	Parameter	Data Type	Required
BaseCost	form	double	No
RawUnitMultiplier	form	double	No
UnitCost	form	double	No
Allowance	form	int	No

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

HTTP + 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,
					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
}