| Required role: | User |
| GET | /sessions/active |
|---|
import java.math.*
import java.util.*
import net.servicestack.client.*
/**
* Get your active sessions. Will eventually replace GetMySessions
*/
@Api(Description="Get your active sessions. Will eventually replace GetMySessions")
open class GetActiveSessions
{
}
open class GetActiveSessionsResponse
{
var sessions:ArrayList<SessionInfo> = ArrayList<SessionInfo>()
}
open class SessionInfo : EntityInfo()
{
/**
* The state of the session
*/
@ApiMember(Description="The state of the session")
var dialState:SessionDialState? = null
/**
* The call state of the session
*/
@ApiMember(Description="The call state of the session")
var callState:SessionCallState? = null
/**
* The queue state of the session
*/
@ApiMember(Description="The queue state of the session")
var queueState:SessionQueueStates? = null
/**
* The ID of the account associated with the flow
*/
@ApiMember(Description="The ID of the account associated with the flow")
var accountId:String? = null
/**
* The name of the account associated with the session
*/
@ApiMember(Description="The name of the account associated with the session")
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")
var customerId:String? = null
/**
* The customer breadcrumb this session is associated with
*/
@ApiMember(Description="The customer breadcrumb this session is associated with")
var customerBreadcrumb:ArrayList<CustomerBreadcrumb> = ArrayList<CustomerBreadcrumb>()
/**
* The name of the customer this session is associated with
*/
@ApiMember(Description="The name of the customer this session is associated with")
var customerName:String? = null
/**
* The ID of the endpoint associated with this session
*/
@ApiMember(Description="The ID of the endpoint associated with this session")
var endpointId:String? = null
/**
* The name of the endpoint associated with this session
*/
@ApiMember(Description="The name of the endpoint associated with this session")
var endpointName:String? = null
/**
* The date the call completed
*/
@ApiMember(Description="The date the call completed")
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)")
var destination:String? = null
/**
* The to address if any
*/
@ApiMember(Description="The to address if any")
var toAddress:String? = null
/**
* The from address if any
*/
@ApiMember(Description="The from address if any")
var fromAddress:String? = null
/**
* The from name if any
*/
@ApiMember(Description="The from name if any")
var fromName:String? = null
/**
* Answered by name (if any)
*/
@ApiMember(Description="Answered by name (if any)")
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")
var queueMemberId:String? = null
/**
* The flow channel
*/
@ApiMember(Description="The flow channel")
var channel:FlowChannels? = null
/**
* Has the session ended
*/
@ApiMember(Description="Has the session ended")
var ended:Boolean? = null
/**
* The outcome of the call
*/
@ApiMember(Description="The outcome of the call")
var outcome:String? = null
/**
* The twilio Call SID of this session
*/
@ApiMember(Description="The twilio Call SID of this session")
var callSid:String? = null
/**
* Any console data for this session
*/
@ApiMember(Description="Any console data for this session")
var consoleData:String? = null
/**
* The name of the hold queue for this call
*/
@ApiMember(Description="The name of the hold queue for this call")
var holdQueueName:String? = null
/**
* The user ID who put this call on hold
*/
@ApiMember(Description="The user ID who put this call on hold")
var heldByUserId:String? = null
/**
* The reason for the hold
*/
@ApiMember(Description="The reason for the hold")
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")
var conferenceSid:String? = null
/**
* The display name for this session
*/
@ApiMember(Description="The display name for this session")
var displayName:String? = null
/**
* The log entries for this session
*/
@ApiMember(Description="The log entries for this session")
var log:ArrayList<SessionLogInfo> = ArrayList<SessionLogInfo>()
/**
* The members of this session
*/
@ApiMember(Description="The members of this session")
var members:ArrayList<SessionMemberInfo> = ArrayList<SessionMemberInfo>()
/**
* The callback number (typically used for SIP to User calls)
*/
@ApiMember(Description="The callback number (typically used for SIP to User calls)")
var callbackNumber:String? = null
/**
* The ID of the endpoint that answered
*/
@ApiMember(Description="The ID of the endpoint that answered")
var answeredById:String? = null
/**
* Is this session incoming or outgoing?
*/
@ApiMember(Description="Is this session incoming or outgoing?")
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)")
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")
var mostRecentParticipantCallSid:String? = null
/**
* Was this session missed?
*/
@ApiMember(Description="Was this session missed?")
var wasMissed:Boolean? = null
/**
* The ring queue that the call is currently in
*/
@ApiMember(Description="The ring queue that the call is currently in")
var ringQueueId: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
}
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
{
var id:String? = null
var name:String? = null
}
enum class FlowChannels
{
Voice,
Chat,
Fax,
}
enum class SessionHoldReasons
{
None,
Transferring,
}
open class SessionLogInfo
{
var date:String? = null
var message:String? = null
}
open class SessionMemberInfo
{
var identity:String? = null
var endpointId:String? = null
var displayName:String? = null
var isOriginalMember:Boolean? = null
var avatarUrl:String? = null
var applicationData:HashMap<String,String> = HashMap<String,String>()
var callState:SessionMemberCallState? = null
var role:SessionMemberRoles? = null
var callSid:String? = null
var muted:Boolean? = null
}
enum class SessionMemberCallState
{
None,
Ringing,
Connected,
Hold,
}
enum class SessionMemberRoles
{
None,
Caller,
Agent,
Transfer,
}
enum class SessionDirections
{
Incoming,
Outgoing,
}
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 /sessions/active HTTP/1.1 Host: evovoice.io Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<GetActiveSessionsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Sessions">
<Sessions>
<SessionInfo>
<CreatedBy xmlns="http://schemas.datacontract.org/2004/07/Voice.Api">String</CreatedBy>
<DateCreated xmlns="http://schemas.datacontract.org/2004/07/Voice.Api">String</DateCreated>
<DateLastModified xmlns="http://schemas.datacontract.org/2004/07/Voice.Api">String</DateLastModified>
<Id xmlns="http://schemas.datacontract.org/2004/07/Voice.Api">String</Id>
<LastModifiedBy xmlns="http://schemas.datacontract.org/2004/07/Voice.Api">String</LastModifiedBy>
<AccountId>String</AccountId>
<AccountName>String</AccountName>
<AnsweredById>String</AnsweredById>
<AnsweredByName>String</AnsweredByName>
<CallSid>String</CallSid>
<CallState>Disconnected</CallState>
<CallbackNumber>String</CallbackNumber>
<Channel>Voice</Channel>
<ConferenceSid>String</ConferenceSid>
<ConsoleData>String</ConsoleData>
<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>
</CustomerBreadcrumb>
<CustomerId>String</CustomerId>
<CustomerName>String</CustomerName>
<DateCompleted>String</DateCompleted>
<Destination>String</Destination>
<DialState>None</DialState>
<Direction>Incoming</Direction>
<DisplayName>String</DisplayName>
<Ended>false</Ended>
<EndpointId>String</EndpointId>
<EndpointName>String</EndpointName>
<FromAddress>String</FromAddress>
<FromName>String</FromName>
<FromPhoneNumber>String</FromPhoneNumber>
<HeldByUserId>String</HeldByUserId>
<HoldQueueName>String</HoldQueueName>
<HoldReason>None</HoldReason>
<Log>
<SessionLogInfo>
<Date>String</Date>
<Message>String</Message>
</SessionLogInfo>
</Log>
<Members>
<SessionMemberInfo>
<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>
</ApplicationData>
<AvatarUrl>String</AvatarUrl>
<CallSid>String</CallSid>
<CallState>None</CallState>
<DisplayName>String</DisplayName>
<EndpointId>String</EndpointId>
<Identity>String</Identity>
<IsOriginalMember>false</IsOriginalMember>
<Muted>false</Muted>
<Role>None</Role>
</SessionMemberInfo>
</Members>
<MostRecentParticipantCallSid>String</MostRecentParticipantCallSid>
<Outcome>String</Outcome>
<QueueMemberId>String</QueueMemberId>
<QueueState>None</QueueState>
<RingQueueId>String</RingQueueId>
<ToAddress>String</ToAddress>
<WasMissed>false</WasMissed>
</SessionInfo>
</Sessions>
</GetActiveSessionsResponse>