| GET | /messages |
|---|
import java.math.*
import java.util.*
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*
open class ListMessages : ListRequest<MessageInfo>()
{
/**
* The IDs of the account whose messages you want to retrieve
*/
@ApiMember(Description="The IDs of the account whose messages you want to retrieve")
var accountIds:ArrayList<String> = ArrayList<String>()
/**
* The IDs of the customers whose messages you want to retrieve
*/
@ApiMember(Description="The IDs of the customers whose messages you want to retrieve")
var customerIds:ArrayList<String> = ArrayList<String>()
/**
* The IDs of the endpoints whose messages you want to retrieve
*/
@ApiMember(Description="The IDs of the endpoints whose messages you want to retrieve")
var endpointIds:ArrayList<String> = ArrayList<String>()
/**
* The ID of the conversations whose messages you want to retrieve
*/
@ApiMember(Description="The ID of the conversations whose messages you want to retrieve")
var conversationIds:ArrayList<String> = ArrayList<String>()
/**
* The date after which messages should be retrieved
*/
@ApiMember(Description="The date after which messages should be retrieved")
var afterDate:String? = 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 MessageInfo
{
var id:String? = null
var accountId:String? = null
var customerId:String? = null
var endpointId:String? = null
var endpointDisplayName:String? = null
var date:String? = null
var direction:MessageDirections? = null
var otherAddress:String? = null
var sender:String? = null
var text:String? = null
var isUnread:Boolean? = null
}
enum class MessageDirections
{
Incoming,
Outgoing,
}
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 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 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 .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 /messages HTTP/1.1 Host: evovoice.io Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"items":[{"id":"String","accountId":"String","customerId":"String","endpointId":"String","endpointDisplayName":"String","date":"String","direction":"Incoming","otherAddress":"String","sender":"String","text":"String","isUnread":false}],"totalCount":0,"totalPages":0,"hasMorePages":false}