| Requires any of the roles: | SystemAdministrator, Manager, Customer |
| GET | /notifications |
|---|
import java.math.*
import java.util.*
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*
/**
* Lists all endpoints
*/
@Api(Description="Lists all endpoints")
open class ListNotifications : 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")
var accountIds:ArrayList<String> = ArrayList<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")
var customerIds:ArrayList<String> = ArrayList<String>()
/**
* Filter by From
*/
@ApiMember(Description="Filter by From")
var fromFilter:String? = null
/**
* Filter by To
*/
@ApiMember(Description="Filter by To")
var toFilter:String? = null
/**
* Filter by Subject
*/
@ApiMember(Description="Filter by Subject")
var subjectFilter:String? = null
/**
* The start date to retrieve usage records for (YYYY-MM-DD)
*/
@ApiMember(Description="The start date to retrieve usage records for (YYYY-MM-DD)")
var startDate:String? = null
/**
* The end date to retrieve usage records for (YYYY-MM-DD)
*/
@ApiMember(Description="The end date to retrieve usage records for (YYYY-MM-DD)")
var endDate:String? = null
/**
* Filter by type
*/
@ApiMember(Description="Filter by type")
@SerializedName("type") var Type:NotificationTypes? = null
}
open class ListRequest<T> : IGet
{
/**
* The page of data to retrieve
*/
@ApiMember(Description="The page of data to retrieve")
var page:Int? = null
/**
* 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")
var all:Boolean? = null
/**
* The number per page to retrieve
*/
@ApiMember(Description="The number per page to retrieve")
var countPerPage:Int? = null
/**
* Specific IDs
*/
@ApiMember(Description="Specific IDs")
var specificIds:ArrayList<String> = ArrayList<String>()
/**
* Specify a sort field
*/
@ApiMember(Description="Specify a sort field")
var sortField:String? = null
/**
* Specify a sort order
*/
@ApiMember(Description="Specify a sort order")
var sortOrder:SortOrders? = null
/**
* 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")
var simplifiedPaging:Boolean? = null
}
enum class SortOrders
{
Ascend,
Descend,
}
open class NotificationInfo : EntityInfo()
{
/**
* The account ID this endpoint is associated with
*/
@ApiMember(Description="The account ID this endpoint is associated with")
var accountId:String? = null
/**
* The name of the account this endpoint is associated with
*/
@ApiMember(Description="The name of the account this endpoint is associated with")
var accountName:String? = null
/**
* The ID of the customer this endpoint is associated with
*/
@ApiMember(Description="The ID of the customer this endpoint is associated with")
var customerId:String? = null
/**
* The name of the customer this endpoint is associated with
*/
@ApiMember(Description="The name of the customer this endpoint is associated with")
var customerName:String? = null
/**
* The breadcrumb to the customer for this endpoint
*/
@ApiMember(Description="The breadcrumb to the customer for this endpoint")
var customerBreadcrumb:ArrayList<CustomerBreadcrumb> = ArrayList<CustomerBreadcrumb>()
/**
* The type of notification
*/
@ApiMember(Description="The type of notification")
@SerializedName("type") var Type:NotificationTypes? = null
/**
* The subject of the notification
*/
@ApiMember(Description="The subject of the notification")
var subject:String? = null
/**
* The body of the notification
*/
@ApiMember(Description="The body of the notification")
var body:String? = null
/**
* The recipients of this notification
*/
@ApiMember(Description="The recipients of this notification")
var recipients:ArrayList<NotificationRecipientInfo> = ArrayList<NotificationRecipientInfo>()
/**
* The list of attachments
*/
@ApiMember(Description="The list of attachments")
var attachments:ArrayList<FileInfo> = ArrayList<FileInfo>()
/**
* The original from for the session
*/
@ApiMember(Description="The original from for the session")
var from:String? = null
/**
* The original To for the session
*/
@ApiMember(Description="The original To for the session")
var to:String? = null
/**
* Was there an error?
*/
@ApiMember(Description="Was there an error?")
var error:Boolean? = null
/**
* The error message
*/
@ApiMember(Description="The error message")
var errorMessage:String? = null
}
open class EntityInfo
{
/**
* The ID of the object
*/
@ApiMember(Description="The ID of the object")
var id:String? = null
/**
* The date the object was created
*/
@ApiMember(Description="The date the object was created")
var dateCreated:String? = null
/**
* The date the object was last modified
*/
@ApiMember(Description="The date the object was last modified")
var dateLastModified:String? = null
/**
* The user that created this object
*/
@ApiMember(Description="The user that created this object")
var createdBy:String? = null
/**
* The user that last modified this object
*/
@ApiMember(Description="The user that last modified this object")
var lastModifiedBy:String? = null
}
open class CustomerBreadcrumb
{
var id:String? = null
var name:String? = null
}
enum class NotificationTypes
{
Email,
Sms,
Push,
IncomingCall,
OutgoingCall,
}
open class NotificationRecipientInfo
{
/**
* The address of the recipient
*/
@ApiMember(Description="The address of the recipient")
var address:String? = null
/**
* Extra info about the recipient e.g. CC, BCC
*/
@ApiMember(Description="Extra info about the recipient e.g. CC, BCC")
var extra:String? = null
/**
* The name of the recipient
*/
@ApiMember(Description="The name of the recipient")
var name:String? = null
}
open class FileInfo : EntityInfo()
{
/**
* The type of file this is
*/
@ApiMember(Description="The type of file this is")
@SerializedName("type") var Type:FileTypes? = null
/**
* The account ID this file is associated with
*/
@ApiMember(Description="The account ID this file is associated with")
var accountId:String? = null
/**
* The name of the account this file is associated with
*/
@ApiMember(Description="The name of the account this file is associated with")
var accountName:String? = null
/**
* The ID of the customer this file is associated with
*/
@ApiMember(Description="The ID of the customer this file is associated with")
var customerId:String? = null
/**
* The name of the customer this file is associated with
*/
@ApiMember(Description="The name of the customer this file is associated with")
var customerName:String? = null
/**
* The breadcrumb to the customer for this file
*/
@ApiMember(Description="The breadcrumb to the customer for this file")
var customerBreadcrumb:ArrayList<CustomerBreadcrumb> = ArrayList<CustomerBreadcrumb>()
/**
* The ID of the user this file is assocaited with
*/
@ApiMember(Description="The ID of the user this file is assocaited with")
var userId:String? = null
/**
* The name of the user this file is associated with
*/
@ApiMember(Description="The name of the user this file is associated with")
var userName:String? = null
/**
* The original file name for the file
*/
@ApiMember(Description="The original file name for the file")
var fileName:String? = null
/**
* The URI of the file
*/
@ApiMember(Description="The URI of the file")
var uri:String? = null
/**
* The Content type of the file
*/
@ApiMember(Description="The Content type of the file")
var contentType:String? = null
/**
* The size of the file
*/
@ApiMember(Description="The size of the file")
var contentLength:Long? = null
/**
* The Twilio ID of the recording
*/
@ApiMember(Description="The Twilio ID of the recording")
var recordingSid:String? = null
/**
* The duration of the recording in seconds
*/
@ApiMember(Description="The duration of the recording in seconds")
var recordingDuration:Int? = null
/**
* Who is the recording from?
*/
@ApiMember(Description="Who is the recording from?")
var recordingFrom:String? = null
/**
* Transcription (if available)
*/
@ApiMember(Description="Transcription (if available)")
var transcription:String? = null
/**
* From Address (e.g. caller ID) for incoming calls
*/
@ApiMember(Description="From Address (e.g. caller ID) for incoming calls")
var fromAddress:String? = null
/**
* To Address (e.g. dialed number) for outgoing calls
*/
@ApiMember(Description="To Address (e.g. dialed number) for outgoing calls")
var toAddress:String? = null
}
enum class FileTypes
{
Upload,
VoiceMessage,
CallRecording,
Fax,
Attachment,
FaxOutgoing,
}
open class ListResponse<AccountInfo>
{
/**
* The items
*/
@ApiMember(Description="The items")
var items:ArrayList<AccountInfo> = ArrayList<AccountInfo>()
/**
* The total number of items
*/
@ApiMember(Description="The total number of items")
var totalCount:Int? = null
/**
* The total number of pages
*/
@ApiMember(Description="The total number of pages")
var totalPages:Int? = null
/**
* Are there more pages of items? Used with simplified paging
*/
@ApiMember(Description="Are there more pages of items? Used with simplified paging")
var hasMorePages:Boolean? = null
}
open class AccountInfo : EntityInfo()
{
/**
* The name of this account
*/
@ApiMember(Description="The name of this account")
var name:String? = null
/**
* The ID of this account's parent
*/
@ApiMember(Description="The ID of this account's parent")
var parentAccountId:String? = null
/**
* The twilio account SID
*/
@ApiMember(Description="The twilio account SID")
var twilioAccountSid:String? = null
/**
* The ancestors of this account. Useful for breadcrumbs
*/
@ApiMember(Description="The ancestors of this account. Useful for breadcrumbs")
var ancestorIds:ArrayList<String> = ArrayList<String>()
/**
* The max number of phone numbers this account can have
*/
@ApiMember(Description="The max number of phone numbers this account can have")
var maxPhoneNumbers:Int? = null
/**
* This account is BYOA
*/
@ApiMember(Description="This account is BYOA")
var isBYOA:Boolean? = null
/**
* TrustHub Profile Sid
*/
@ApiMember(Description="TrustHub Profile Sid")
var trustHubProfileSid:String? = null
/**
* The ID of the logo file
*/
@ApiMember(Description="The ID of the logo file")
var logoId:String? = null
/**
* The URI of the logo file
*/
@ApiMember(Description="The URI of the logo file")
var logoUri:String? = null
/**
* The billing settings for this account
*/
@ApiMember(Description="The billing settings for this account")
var billingSettings:BillingSettings? = null
}
open class BillingSettings
{
var base:BillingItem? = null
var localNumbers:BillingItem? = null
var tollFreeNumbers:BillingItem? = null
var inboundVoiceCalls:BillingItem? = null
var outboundVoiceCalls:BillingItem? = null
var inboundFaxes:BillingItem? = null
var outboundFaxes:BillingItem? = null
var inboundSmsMessages:BillingItem? = null
var outboundSmsMessages:BillingItem? = null
}
open class BillingItem
{
var baseCost:Double? = null
var rawUnitMultiplier:Double? = null
var unitCost:Double? = null
var allowance:Int? = null
}
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
}