| GET | /portal/home |
|---|
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 AppGetHomeInformation
{
open var accountId:String? = null
open var customerId:String? = null
open var fromDate:String? = null
}
open class AppHomeInformation
{
open var isHostedSuiteCustomer:Boolean? = null
open var conversations:ArrayList<ConversationInfo>? = null
open var calls:ArrayList<SessionInfo>? = null
open var callMetrics:ArrayList<AppHomeCallMetric>? = null
open var voicemail:ArrayList<FileInfo>? = null
open var forms:ArrayList<HostedSuiteCompletedForm>? = null
}
open class ConversationInfo
{
open var id:String? = null
open var endpointId:String? = null
open var otherAddress:String? = null
open var mostRecentMessage:MessageInfo? = null
}
open class MessageInfo
{
open var id:String? = null
open var accountId:String? = null
open var customerId:String? = null
open var endpointId:String? = null
open var endpointDisplayName:String? = null
open var date:String? = null
open var direction:MessageDirections? = null
open var otherAddress:String? = null
open var sender:String? = null
open var text:String? = null
open var isUnread:Boolean? = null
}
enum class MessageDirections
{
Incoming,
Outgoing,
}
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 AppHomeCallMetric
{
open var metricKey:String? = null
open var total:Double? = null
open var average:Double? = null
}
open class FileInfo : EntityInfo()
{
/**
* The type of file this is
*/
@ApiMember(Description="The type of file this is")
@SerializedName("type") open var Type:FileTypes? = null
/**
* The account ID this file is associated with
*/
@ApiMember(Description="The account ID this file is associated with")
open 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")
open 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")
open 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")
open var customerName:String? = null
/**
* The breadcrumb to the customer for this file
*/
@ApiMember(Description="The breadcrumb to the customer for this file")
open var customerBreadcrumb:ArrayList<CustomerBreadcrumb>? = null
/**
* The ID of the user this file is assocaited with
*/
@ApiMember(Description="The ID of the user this file is assocaited with")
open 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")
open var userName:String? = null
/**
* The original file name for the file
*/
@ApiMember(Description="The original file name for the file")
open var fileName:String? = null
/**
* The URI of the file
*/
@ApiMember(Description="The URI of the file")
open var uri:String? = null
/**
* The Content type of the file
*/
@ApiMember(Description="The Content type of the file")
open var contentType:String? = null
/**
* The size of the file
*/
@ApiMember(Description="The size of the file")
open var contentLength:Long? = null
/**
* The Twilio ID of the recording
*/
@ApiMember(Description="The Twilio ID of the recording")
open var recordingSid:String? = null
/**
* The duration of the recording in seconds
*/
@ApiMember(Description="The duration of the recording in seconds")
open var recordingDuration:Int? = null
/**
* Who is the recording from?
*/
@ApiMember(Description="Who is the recording from?")
open var recordingFrom:String? = null
/**
* Transcription (if available)
*/
@ApiMember(Description="Transcription (if available)")
open var transcription:String? = null
/**
* From Address (e.g. caller ID) for incoming calls
*/
@ApiMember(Description="From Address (e.g. caller ID) for incoming calls")
open var fromAddress:String? = null
/**
* To Address (e.g. dialed number) for outgoing calls
*/
@ApiMember(Description="To Address (e.g. dialed number) for outgoing calls")
open var toAddress:String? = null
/**
* The AI transcription for this call
*/
@ApiMember(Description="The AI transcription for this call")
open var aiTranscription:String? = null
}
enum class FileTypes
{
Upload,
VoiceMessage,
CallRecording,
Fax,
Attachment,
FaxOutgoing,
}
open class HostedSuiteCompletedForm
{
open var id:String? = null
open var name:String? = null
open var dateCreated:String? = null
open var dateCompleted:String? = null
open var formId:String? = null
open var formName:String? = null
open var clientId:String? = null
open var clientName:String? = null
open var contactId:String? = null
open var contactName:String? = null
open var contactsIds:ArrayList<String>? = null
open var contactsNames:ArrayList<String>? = null
open var emailSubject:String? = null
open var callerNumber:String? = null
open var fields:ArrayList<HostedSuiteCompletedFormField>? = null
}
open class HostedSuiteCompletedFormField
{
open var name:String? = null
open var values:ArrayList<String>? = null
}
Kotlin AppGetHomeInformation DTOs
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 /portal/home HTTP/1.1 Host: team.evovoice.io Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
isHostedSuiteCustomer: False,
conversations:
[
{
id: String,
endpointId: String,
otherAddress: String,
mostRecentMessage:
{
id: String,
accountId: String,
customerId: String,
endpointId: String,
endpointDisplayName: String,
date: String,
direction: Incoming,
otherAddress: String,
sender: String,
text: String,
isUnread: False
}
}
],
calls:
[
{
dialState: None,
callState: Disconnected,
queueState: None,
accountId: String,
accountName: String,
customerId: String,
customerBreadcrumb:
[
{
id: String,
name: String
}
],
customerName: String,
endpointId: String,
endpointName: String,
dateCompleted: String,
destination: String,
toAddress: String,
fromAddress: String,
fromName: String,
answeredByName: String,
queueMemberId: String,
channel: Voice,
ended: False,
outcome: String,
callSid: String,
consoleData: String,
holdQueueName: String,
heldByUserId: String,
holdReason: None,
conferenceSid: String,
displayName: String,
log:
[
{
date: String,
message: String
}
],
members:
[
{
identity: String,
endpointId: String,
displayName: String,
isOriginalMember: False,
avatarUrl: String,
applicationData:
{
String: String
},
callState: None,
role: None,
callSid: String,
muted: False
}
],
callbackNumber: String,
answeredById: String,
direction: Incoming,
fromPhoneNumber: String,
mostRecentParticipantCallSid: String,
wasMissed: False,
ringQueueId: String,
id: String,
dateCreated: String,
dateLastModified: String,
createdBy: String,
lastModifiedBy: String
}
],
callMetrics:
[
{
metricKey: String,
total: 0,
average: 0
}
],
voicemail:
[
{
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
}
],
forms:
[
{
id: String,
name: String,
dateCreated: String,
dateCompleted: String,
formId: String,
formName: String,
clientId: String,
clientName: String,
contactId: String,
contactName: String,
contactsIds:
[
String
],
contactsNames:
[
String
],
emailSubject: String,
callerNumber: String,
fields:
[
{
name: String,
values:
[
String
]
}
]
}
]
}