| GET | /portal/activity |
|---|
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*
open class AppGetActivity : ListRequest<SessionInfo>()
{
open var accountId:String? = null
open var customerId:String? = null
open var fromAddressFilter:String? = null
open var toAddressFilter:String? = null
open var startDateTime:String? = null
open var endDateTime:String? = null
}
open class ListRequest<T> : IGet
{
/**
* The page of data to retrieve
*/
@ApiMember(Description="The page of data to retrieve")
open 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")
open var all:Boolean? = null
/**
* The number per page to retrieve
*/
@ApiMember(Description="The number per page to retrieve")
open var countPerPage:Int? = null
/**
* Specific IDs
*/
@ApiMember(Description="Specific IDs")
open var specificIds:ArrayList<String>? = null
/**
* Specify a sort field
*/
@ApiMember(Description="Specify a sort field")
open var sortField:String? = null
/**
* Specify a sort order
*/
@ApiMember(Description="Specify a sort order")
open 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")
open var simplifiedPaging:Boolean? = null
}
enum class SortOrders
{
Ascend,
Descend,
}
open class SessionInfo : EntityInfo()
{
/**
* The state of the session
*/
@ApiMember(Description="The state of the session")
open var dialState:SessionDialState? = null
/**
* The call state of the session
*/
@ApiMember(Description="The call state of the session")
open var callState:SessionCallState? = null
/**
* The queue state of the session
*/
@ApiMember(Description="The queue state of the session")
open var queueState:SessionQueueStates? = null
/**
* The ID of the account associated with the flow
*/
@ApiMember(Description="The ID of the account associated with the flow")
open var accountId:String? = null
/**
* The name of the account associated with the session
*/
@ApiMember(Description="The name of the account associated with the session")
open var accountName:String? = null
/**
* The ID of the customer this session is associated with
*/
@ApiMember(Description="The ID of the customer this session is associated with")
open var customerId:String? = null
/**
* The customer breadcrumb this session is associated with
*/
@ApiMember(Description="The customer breadcrumb this session is associated with")
open var customerBreadcrumb:ArrayList<CustomerBreadcrumb>? = null
/**
* The name of the customer this session is associated with
*/
@ApiMember(Description="The name of the customer this session is associated with")
open var customerName:String? = null
/**
* The ID of the endpoint associated with this session
*/
@ApiMember(Description="The ID of the endpoint associated with this session")
open var endpointId:String? = null
/**
* The name of the endpoint associated with this session
*/
@ApiMember(Description="The name of the endpoint associated with this session")
open var endpointName:String? = null
/**
* The date the call completed
*/
@ApiMember(Description="The date the call completed")
open var dateCompleted:String? = null
/**
* The destination of the session (e.g. what was entered into the Dial box)
*/
@ApiMember(Description="The destination of the session (e.g. what was entered into the Dial box)")
open var destination:String? = null
/**
* The to address if any
*/
@ApiMember(Description="The to address if any")
open var toAddress:String? = null
/**
* The from address if any
*/
@ApiMember(Description="The from address if any")
open var fromAddress:String? = null
/**
* The from name if any
*/
@ApiMember(Description="The from name if any")
open var fromName:String? = null
/**
* Answered by name (if any)
*/
@ApiMember(Description="Answered by name (if any)")
open var answeredByName:String? = null
/**
* The ID of the queue member assigned to this call
*/
@ApiMember(Description="The ID of the queue member assigned to this call")
open var queueMemberId:String? = null
/**
* The flow channel
*/
@ApiMember(Description="The flow channel")
open var channel:FlowChannels? = null
/**
* Has the session ended
*/
@ApiMember(Description="Has the session ended")
open var ended:Boolean? = null
/**
* The outcome of the call
*/
@ApiMember(Description="The outcome of the call")
open var outcome:String? = null
/**
* The twilio Call SID of this session
*/
@ApiMember(Description="The twilio Call SID of this session")
open var callSid:String? = null
/**
* Any console data for this session
*/
@ApiMember(Description="Any console data for this session")
open var consoleData:String? = null
/**
* The name of the hold queue for this call
*/
@ApiMember(Description="The name of the hold queue for this call")
open var holdQueueName:String? = null
/**
* The user ID who put this call on hold
*/
@ApiMember(Description="The user ID who put this call on hold")
open var heldByUserId:String? = null
/**
* The reason for the hold
*/
@ApiMember(Description="The reason for the hold")
open var holdReason:SessionHoldReasons? = null
/**
* The SID of the conference if in a conference call
*/
@ApiMember(Description="The SID of the conference if in a conference call")
open var conferenceSid:String? = null
/**
* The display name for this session
*/
@ApiMember(Description="The display name for this session")
open var displayName:String? = null
/**
* The log entries for this session
*/
@ApiMember(Description="The log entries for this session")
open var log:ArrayList<SessionLogInfo>? = null
/**
* The members of this session
*/
@ApiMember(Description="The members of this session")
open var members:ArrayList<SessionMemberInfo>? = null
/**
* The callback number (typically used for SIP to User calls)
*/
@ApiMember(Description="The callback number (typically used for SIP to User calls)")
open var callbackNumber:String? = null
/**
* The ID of the endpoint that answered
*/
@ApiMember(Description="The ID of the endpoint that answered")
open var answeredById:String? = null
/**
* Is this session incoming or outgoing?
*/
@ApiMember(Description="Is this session incoming or outgoing?")
open var direction:SessionDirections? = null
/**
* The phone number that this session is coming from (used with SMS chats)
*/
@ApiMember(Description="The phone number that this session is coming from (used with SMS chats)")
open var fromPhoneNumber:String? = null
/**
* The Call SID of the most recently added conference participant
*/
@ApiMember(Description="The Call SID of the most recently added conference participant")
open var mostRecentParticipantCallSid:String? = null
/**
* Was this session missed?
*/
@ApiMember(Description="Was this session missed?")
open var wasMissed:Boolean? = null
/**
* The ring queue that the call is currently in
*/
@ApiMember(Description="The ring queue that the call is currently in")
open var ringQueueId:String? = null
}
open class EntityInfo
{
/**
* The ID of the object
*/
@ApiMember(Description="The ID of the object")
open var id:String? = null
/**
* The date the object was created
*/
@ApiMember(Description="The date the object was created")
open var dateCreated:String? = null
/**
* The date the object was last modified
*/
@ApiMember(Description="The date the object was last modified")
open var dateLastModified:String? = null
/**
* The user that created this object
*/
@ApiMember(Description="The user that created this object")
open var createdBy:String? = null
/**
* The user that last modified this object
*/
@ApiMember(Description="The user that last modified this object")
open var lastModifiedBy:String? = null
}
enum class SessionDialState
{
None,
Active,
}
enum class SessionCallState
{
Disconnected,
Ringing,
Connected,
Hold,
Passive,
}
enum class SessionQueueStates
{
None,
Queued,
Ringing,
Connected,
Hold,
Disconnected,
}
open class CustomerBreadcrumb
{
open var id:String? = null
open var name:String? = null
}
enum class FlowChannels
{
Voice,
Chat,
Fax,
}
enum class SessionHoldReasons
{
None,
Transferring,
}
open class SessionLogInfo
{
open var date:String? = null
open var message:String? = null
}
open class SessionMemberInfo
{
open var identity:String? = null
open var endpointId:String? = null
open var displayName:String? = null
open var isOriginalMember:Boolean? = null
open var avatarUrl:String? = null
open var applicationData:HashMap<String,String>? = null
open var callState:SessionMemberCallState? = null
open var role:SessionMemberRoles? = null
open var callSid:String? = null
open var muted:Boolean? = null
}
enum class SessionMemberCallState
{
None,
Ringing,
Connected,
Hold,
}
enum class SessionMemberRoles
{
None,
Caller,
Agent,
Transfer,
}
enum class SessionDirections
{
Incoming,
Outgoing,
}
open class ListResponse<T>
{
/**
* The items
*/
@ApiMember(Description="The items")
open var items:ArrayList<AccountInfo>? = null
/**
* The total number of items
*/
@ApiMember(Description="The total number of items")
open var totalCount:Int? = null
/**
* The total number of pages
*/
@ApiMember(Description="The total number of pages")
open 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")
open var hasMorePages:Boolean? = null
}
open class AccountInfo : EntityInfo()
{
/**
* The name of this account
*/
@ApiMember(Description="The name of this account")
open var name:String? = null
/**
* The ID of this account's parent
*/
@ApiMember(Description="The ID of this account's parent")
open var parentAccountId:String? = null
/**
* The twilio account SID
*/
@ApiMember(Description="The twilio account SID")
open var twilioAccountSid:String? = null
/**
* The ancestors of this account. Useful for breadcrumbs
*/
@ApiMember(Description="The ancestors of this account. Useful for breadcrumbs")
open var ancestorIds:ArrayList<String>? = null
/**
* The max number of phone numbers this account can have
*/
@ApiMember(Description="The max number of phone numbers this account can have")
open var maxPhoneNumbers:Int? = null
/**
* This account is BYOA
*/
@ApiMember(Description="This account is BYOA")
open var isBYOA:Boolean? = null
/**
* TrustHub Profile Sid
*/
@ApiMember(Description="TrustHub Profile Sid")
open var trustHubProfileSid:String? = null
/**
* The ID of the logo file
*/
@ApiMember(Description="The ID of the logo file")
open var logoId:String? = null
/**
* The URI of the logo file
*/
@ApiMember(Description="The URI of the logo file")
open var logoUri:String? = null
/**
* The billing settings for this account
*/
@ApiMember(Description="The billing settings for this account")
open var billingSettings:BillingSettings? = null
}
open class BillingSettings
{
open var base:BillingItem? = null
open var localNumbers:BillingItem? = null
open var tollFreeNumbers:BillingItem? = null
open var inboundVoiceCalls:BillingItem? = null
open var outboundVoiceCalls:BillingItem? = null
open var inboundFaxes:BillingItem? = null
open var outboundFaxes:BillingItem? = null
open var inboundSmsMessages:BillingItem? = null
open var outboundSmsMessages:BillingItem? = null
open var aiInsights:BillingItem? = null
open var aiLiveMinutes:BillingItem? = null
open var aiMessages:BillingItem? = null
}
open class BillingItem
{
open var baseCost:Double? = null
open var rawUnitMultiplier:Double? = null
open var unitCost:Double? = null
open var allowance:Int? = null
}
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 /portal/activity HTTP/1.1 Host: team.evovoice.io Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<ListResponseOfSessionInfoBWxtuWQa 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.Sessions">
<d2p1:SessionInfo>
<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:AnsweredById>String</d2p1:AnsweredById>
<d2p1:AnsweredByName>String</d2p1:AnsweredByName>
<d2p1:CallSid>String</d2p1:CallSid>
<d2p1:CallState>Disconnected</d2p1:CallState>
<d2p1:CallbackNumber>String</d2p1:CallbackNumber>
<d2p1:Channel>Voice</d2p1:Channel>
<d2p1:ConferenceSid>String</d2p1:ConferenceSid>
<d2p1:ConsoleData>String</d2p1:ConsoleData>
<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:DateCompleted>String</d2p1:DateCompleted>
<d2p1:Destination>String</d2p1:Destination>
<d2p1:DialState>None</d2p1:DialState>
<d2p1:Direction>Incoming</d2p1:Direction>
<d2p1:DisplayName>String</d2p1:DisplayName>
<d2p1:Ended>false</d2p1:Ended>
<d2p1:EndpointId>String</d2p1:EndpointId>
<d2p1:EndpointName>String</d2p1:EndpointName>
<d2p1:FromAddress>String</d2p1:FromAddress>
<d2p1:FromName>String</d2p1:FromName>
<d2p1:FromPhoneNumber>String</d2p1:FromPhoneNumber>
<d2p1:HeldByUserId>String</d2p1:HeldByUserId>
<d2p1:HoldQueueName>String</d2p1:HoldQueueName>
<d2p1:HoldReason>None</d2p1:HoldReason>
<d2p1:Log>
<d2p1:SessionLogInfo>
<d2p1:Date>String</d2p1:Date>
<d2p1:Message>String</d2p1:Message>
</d2p1:SessionLogInfo>
</d2p1:Log>
<d2p1:Members>
<d2p1:SessionMemberInfo>
<d2p1:ApplicationData xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d6p1:KeyValueOfstringstring>
<d6p1:Key>String</d6p1:Key>
<d6p1:Value>String</d6p1:Value>
</d6p1:KeyValueOfstringstring>
</d2p1:ApplicationData>
<d2p1:AvatarUrl>String</d2p1:AvatarUrl>
<d2p1:CallSid>String</d2p1:CallSid>
<d2p1:CallState>None</d2p1:CallState>
<d2p1:DisplayName>String</d2p1:DisplayName>
<d2p1:EndpointId>String</d2p1:EndpointId>
<d2p1:Identity>String</d2p1:Identity>
<d2p1:IsOriginalMember>false</d2p1:IsOriginalMember>
<d2p1:Muted>false</d2p1:Muted>
<d2p1:Role>None</d2p1:Role>
</d2p1:SessionMemberInfo>
</d2p1:Members>
<d2p1:MostRecentParticipantCallSid>String</d2p1:MostRecentParticipantCallSid>
<d2p1:Outcome>String</d2p1:Outcome>
<d2p1:QueueMemberId>String</d2p1:QueueMemberId>
<d2p1:QueueState>None</d2p1:QueueState>
<d2p1:RingQueueId>String</d2p1:RingQueueId>
<d2p1:ToAddress>String</d2p1:ToAddress>
<d2p1:WasMissed>false</d2p1:WasMissed>
</d2p1:SessionInfo>
</Items>
<TotalCount>0</TotalCount>
<TotalPages>0</TotalPages>
</ListResponseOfSessionInfoBWxtuWQa>