Evo Voice

<back to all web services

AppGetHomeInformation

Requires Authentication
The following routes are available for this service:
GET/portal/home
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class AppGetHomeInformation
    {
        public String accountId = null;
        public String customerId = null;
        public String fromDate = null;
        
        public String getAccountId() { return accountId; }
        public AppGetHomeInformation setAccountId(String value) { this.accountId = value; return this; }
        public String getCustomerId() { return customerId; }
        public AppGetHomeInformation setCustomerId(String value) { this.customerId = value; return this; }
        public String getFromDate() { return fromDate; }
        public AppGetHomeInformation setFromDate(String value) { this.fromDate = value; return this; }
    }

    public static class AppHomeInformation
    {
        public Boolean isHostedSuiteCustomer = null;
        public ArrayList<ConversationInfo> conversations = null;
        public ArrayList<SessionInfo> calls = null;
        public ArrayList<AppHomeCallMetric> callMetrics = null;
        public ArrayList<FileInfo> voicemail = null;
        public ArrayList<HostedSuiteCompletedForm> forms = null;
        
        public Boolean getIsHostedSuiteCustomer() { return isHostedSuiteCustomer; }
        public AppHomeInformation setIsHostedSuiteCustomer(Boolean value) { this.isHostedSuiteCustomer = value; return this; }
        public ArrayList<ConversationInfo> getConversations() { return conversations; }
        public AppHomeInformation setConversations(ArrayList<ConversationInfo> value) { this.conversations = value; return this; }
        public ArrayList<SessionInfo> getCalls() { return calls; }
        public AppHomeInformation setCalls(ArrayList<SessionInfo> value) { this.calls = value; return this; }
        public ArrayList<AppHomeCallMetric> getCallMetrics() { return callMetrics; }
        public AppHomeInformation setCallMetrics(ArrayList<AppHomeCallMetric> value) { this.callMetrics = value; return this; }
        public ArrayList<FileInfo> getVoicemail() { return voicemail; }
        public AppHomeInformation setVoicemail(ArrayList<FileInfo> value) { this.voicemail = value; return this; }
        public ArrayList<HostedSuiteCompletedForm> getForms() { return forms; }
        public AppHomeInformation setForms(ArrayList<HostedSuiteCompletedForm> value) { this.forms = value; return this; }
    }

    public static class ConversationInfo
    {
        public String id = null;
        public String endpointId = null;
        public String otherAddress = null;
        public MessageInfo mostRecentMessage = null;
        
        public String getId() { return id; }
        public ConversationInfo setId(String value) { this.id = value; return this; }
        public String getEndpointId() { return endpointId; }
        public ConversationInfo setEndpointId(String value) { this.endpointId = value; return this; }
        public String getOtherAddress() { return otherAddress; }
        public ConversationInfo setOtherAddress(String value) { this.otherAddress = value; return this; }
        public MessageInfo getMostRecentMessage() { return mostRecentMessage; }
        public ConversationInfo setMostRecentMessage(MessageInfo value) { this.mostRecentMessage = value; return this; }
    }

    public static class MessageInfo
    {
        public String id = null;
        public String accountId = null;
        public String customerId = null;
        public String endpointId = null;
        public String endpointDisplayName = null;
        public String date = null;
        public MessageDirections direction = null;
        public String otherAddress = null;
        public String sender = null;
        public String text = null;
        public Boolean isUnread = null;
        
        public String getId() { return id; }
        public MessageInfo setId(String value) { this.id = value; return this; }
        public String getAccountId() { return accountId; }
        public MessageInfo setAccountId(String value) { this.accountId = value; return this; }
        public String getCustomerId() { return customerId; }
        public MessageInfo setCustomerId(String value) { this.customerId = value; return this; }
        public String getEndpointId() { return endpointId; }
        public MessageInfo setEndpointId(String value) { this.endpointId = value; return this; }
        public String getEndpointDisplayName() { return endpointDisplayName; }
        public MessageInfo setEndpointDisplayName(String value) { this.endpointDisplayName = value; return this; }
        public String getDate() { return date; }
        public MessageInfo setDate(String value) { this.date = value; return this; }
        public MessageDirections getDirection() { return direction; }
        public MessageInfo setDirection(MessageDirections value) { this.direction = value; return this; }
        public String getOtherAddress() { return otherAddress; }
        public MessageInfo setOtherAddress(String value) { this.otherAddress = value; return this; }
        public String getSender() { return sender; }
        public MessageInfo setSender(String value) { this.sender = value; return this; }
        public String getText() { return text; }
        public MessageInfo setText(String value) { this.text = value; return this; }
        public Boolean getIsUnread() { return isUnread; }
        public MessageInfo setIsUnread(Boolean value) { this.isUnread = value; return this; }
    }

    public static enum MessageDirections
    {
        Incoming,
        Outgoing;
    }

    public static class SessionInfo extends EntityInfo
    {
        /**
        * The state of the session
        */
        @ApiMember(Description="The state of the session")
        public SessionDialState dialState = null;

        /**
        * The call state of the session
        */
        @ApiMember(Description="The call state of the session")
        public SessionCallState callState = null;

        /**
        * The queue state of the session
        */
        @ApiMember(Description="The queue state of the session")
        public SessionQueueStates queueState = null;

        /**
        * The ID of the account associated with the flow
        */
        @ApiMember(Description="The ID of the account associated with the flow")
        public String accountId = null;

        /**
        * The name of the account associated with the session
        */
        @ApiMember(Description="The name of the account associated with the session")
        public String accountName = null;

        /**
        * The ID of the customer this session is associated with
        */
        @ApiMember(Description="The ID of the customer this session is associated with")
        public String customerId = null;

        /**
        * The customer breadcrumb this session is associated with
        */
        @ApiMember(Description="The customer breadcrumb this session is associated with")
        public ArrayList<CustomerBreadcrumb> customerBreadcrumb = null;

        /**
        * The name of the customer this session is associated with
        */
        @ApiMember(Description="The name of the customer this session is associated with")
        public String customerName = null;

        /**
        * The ID of the endpoint associated with this session
        */
        @ApiMember(Description="The ID of the endpoint associated with this session")
        public String endpointId = null;

        /**
        * The name of the endpoint associated with this session
        */
        @ApiMember(Description="The name of the endpoint associated with this session")
        public String endpointName = null;

        /**
        * The date the call completed
        */
        @ApiMember(Description="The date the call completed")
        public String dateCompleted = 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)")
        public String destination = null;

        /**
        * The to address if any
        */
        @ApiMember(Description="The to address if any")
        public String toAddress = null;

        /**
        * The from address if any
        */
        @ApiMember(Description="The from address if any")
        public String fromAddress = null;

        /**
        * The from name if any
        */
        @ApiMember(Description="The from name if any")
        public String fromName = null;

        /**
        * Answered by name (if any)
        */
        @ApiMember(Description="Answered by name (if any)")
        public String answeredByName = null;

        /**
        * The ID of the queue member assigned to this call
        */
        @ApiMember(Description="The ID of the queue member assigned to this call")
        public String queueMemberId = null;

        /**
        * The flow channel
        */
        @ApiMember(Description="The flow channel")
        public FlowChannels channel = null;

        /**
        * Has the session ended
        */
        @ApiMember(Description="Has the session ended")
        public Boolean ended = null;

        /**
        * The outcome of the call
        */
        @ApiMember(Description="The outcome of the call")
        public String outcome = null;

        /**
        * The twilio Call SID of this session
        */
        @ApiMember(Description="The twilio Call SID of this session")
        public String callSid = null;

        /**
        * Any console data for this session
        */
        @ApiMember(Description="Any console data for this session")
        public String consoleData = null;

        /**
        * The name of the hold queue for this call
        */
        @ApiMember(Description="The name of the hold queue for this call")
        public String holdQueueName = null;

        /**
        * The user ID who put this call on hold
        */
        @ApiMember(Description="The user ID who put this call on hold")
        public String heldByUserId = null;

        /**
        * The reason for the hold
        */
        @ApiMember(Description="The reason for the hold")
        public SessionHoldReasons holdReason = null;

        /**
        * The SID of the conference if in a conference call
        */
        @ApiMember(Description="The SID of the conference if in a conference call")
        public String conferenceSid = null;

        /**
        * The display name for this session
        */
        @ApiMember(Description="The display name for this session")
        public String displayName = null;

        /**
        * The log entries for this session
        */
        @ApiMember(Description="The log entries for this session")
        public ArrayList<SessionLogInfo> log = null;

        /**
        * The members of this session
        */
        @ApiMember(Description="The members of this session")
        public ArrayList<SessionMemberInfo> members = null;

        /**
        * The callback number (typically used for SIP to User calls)
        */
        @ApiMember(Description="The callback number (typically used for SIP to User calls)")
        public String callbackNumber = null;

        /**
        * The ID of the endpoint that answered
        */
        @ApiMember(Description="The ID of the endpoint that answered")
        public String answeredById = null;

        /**
        * Is this session incoming or outgoing?
        */
        @ApiMember(Description="Is this session incoming or outgoing?")
        public SessionDirections direction = 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)")
        public String fromPhoneNumber = null;

        /**
        * The Call SID of the most recently added conference participant
        */
        @ApiMember(Description="The Call SID of the most recently added conference participant")
        public String mostRecentParticipantCallSid = null;

        /**
        * Was this session missed?
        */
        @ApiMember(Description="Was this session missed?")
        public Boolean wasMissed = null;

        /**
        * The ring queue that the call is currently in
        */
        @ApiMember(Description="The ring queue that the call is currently in")
        public String ringQueueId = null;
        
        public SessionDialState getDialState() { return dialState; }
        public SessionInfo setDialState(SessionDialState value) { this.dialState = value; return this; }
        public SessionCallState getCallState() { return callState; }
        public SessionInfo setCallState(SessionCallState value) { this.callState = value; return this; }
        public SessionQueueStates getQueueState() { return queueState; }
        public SessionInfo setQueueState(SessionQueueStates value) { this.queueState = value; return this; }
        public String getAccountId() { return accountId; }
        public SessionInfo setAccountId(String value) { this.accountId = value; return this; }
        public String getAccountName() { return accountName; }
        public SessionInfo setAccountName(String value) { this.accountName = value; return this; }
        public String getCustomerId() { return customerId; }
        public SessionInfo setCustomerId(String value) { this.customerId = value; return this; }
        public ArrayList<CustomerBreadcrumb> getCustomerBreadcrumb() { return customerBreadcrumb; }
        public SessionInfo setCustomerBreadcrumb(ArrayList<CustomerBreadcrumb> value) { this.customerBreadcrumb = value; return this; }
        public String getCustomerName() { return customerName; }
        public SessionInfo setCustomerName(String value) { this.customerName = value; return this; }
        public String getEndpointId() { return endpointId; }
        public SessionInfo setEndpointId(String value) { this.endpointId = value; return this; }
        public String getEndpointName() { return endpointName; }
        public SessionInfo setEndpointName(String value) { this.endpointName = value; return this; }
        public String getDateCompleted() { return dateCompleted; }
        public SessionInfo setDateCompleted(String value) { this.dateCompleted = value; return this; }
        public String getDestination() { return destination; }
        public SessionInfo setDestination(String value) { this.destination = value; return this; }
        public String getToAddress() { return toAddress; }
        public SessionInfo setToAddress(String value) { this.toAddress = value; return this; }
        public String getFromAddress() { return fromAddress; }
        public SessionInfo setFromAddress(String value) { this.fromAddress = value; return this; }
        public String getFromName() { return fromName; }
        public SessionInfo setFromName(String value) { this.fromName = value; return this; }
        public String getAnsweredByName() { return answeredByName; }
        public SessionInfo setAnsweredByName(String value) { this.answeredByName = value; return this; }
        public String getQueueMemberId() { return queueMemberId; }
        public SessionInfo setQueueMemberId(String value) { this.queueMemberId = value; return this; }
        public FlowChannels getChannel() { return channel; }
        public SessionInfo setChannel(FlowChannels value) { this.channel = value; return this; }
        public Boolean isEnded() { return ended; }
        public SessionInfo setEnded(Boolean value) { this.ended = value; return this; }
        public String getOutcome() { return outcome; }
        public SessionInfo setOutcome(String value) { this.outcome = value; return this; }
        public String getCallSid() { return callSid; }
        public SessionInfo setCallSid(String value) { this.callSid = value; return this; }
        public String getConsoleData() { return consoleData; }
        public SessionInfo setConsoleData(String value) { this.consoleData = value; return this; }
        public String getHoldQueueName() { return holdQueueName; }
        public SessionInfo setHoldQueueName(String value) { this.holdQueueName = value; return this; }
        public String getHeldByUserId() { return heldByUserId; }
        public SessionInfo setHeldByUserId(String value) { this.heldByUserId = value; return this; }
        public SessionHoldReasons getHoldReason() { return holdReason; }
        public SessionInfo setHoldReason(SessionHoldReasons value) { this.holdReason = value; return this; }
        public String getConferenceSid() { return conferenceSid; }
        public SessionInfo setConferenceSid(String value) { this.conferenceSid = value; return this; }
        public String getDisplayName() { return displayName; }
        public SessionInfo setDisplayName(String value) { this.displayName = value; return this; }
        public ArrayList<SessionLogInfo> getLog() { return log; }
        public SessionInfo setLog(ArrayList<SessionLogInfo> value) { this.log = value; return this; }
        public ArrayList<SessionMemberInfo> getMembers() { return members; }
        public SessionInfo setMembers(ArrayList<SessionMemberInfo> value) { this.members = value; return this; }
        public String getCallbackNumber() { return callbackNumber; }
        public SessionInfo setCallbackNumber(String value) { this.callbackNumber = value; return this; }
        public String getAnsweredById() { return answeredById; }
        public SessionInfo setAnsweredById(String value) { this.answeredById = value; return this; }
        public SessionDirections getDirection() { return direction; }
        public SessionInfo setDirection(SessionDirections value) { this.direction = value; return this; }
        public String getFromPhoneNumber() { return fromPhoneNumber; }
        public SessionInfo setFromPhoneNumber(String value) { this.fromPhoneNumber = value; return this; }
        public String getMostRecentParticipantCallSid() { return mostRecentParticipantCallSid; }
        public SessionInfo setMostRecentParticipantCallSid(String value) { this.mostRecentParticipantCallSid = value; return this; }
        public Boolean isWasMissed() { return wasMissed; }
        public SessionInfo setWasMissed(Boolean value) { this.wasMissed = value; return this; }
        public String getRingQueueId() { return ringQueueId; }
        public SessionInfo setRingQueueId(String value) { this.ringQueueId = value; return this; }
    }

    public static class EntityInfo
    {
        /**
        * The ID of the object
        */
        @ApiMember(Description="The ID of the object")
        public String id = null;

        /**
        * The date the object was created
        */
        @ApiMember(Description="The date the object was created")
        public String dateCreated = null;

        /**
        * The date the object was last modified
        */
        @ApiMember(Description="The date the object was last modified")
        public String dateLastModified = null;

        /**
        * The user that created this object
        */
        @ApiMember(Description="The user that created this object")
        public String createdBy = null;

        /**
        * The user that last modified this object
        */
        @ApiMember(Description="The user that last modified this object")
        public String lastModifiedBy = null;
        
        public String getId() { return id; }
        public EntityInfo setId(String value) { this.id = value; return this; }
        public String getDateCreated() { return dateCreated; }
        public EntityInfo setDateCreated(String value) { this.dateCreated = value; return this; }
        public String getDateLastModified() { return dateLastModified; }
        public EntityInfo setDateLastModified(String value) { this.dateLastModified = value; return this; }
        public String getCreatedBy() { return createdBy; }
        public EntityInfo setCreatedBy(String value) { this.createdBy = value; return this; }
        public String getLastModifiedBy() { return lastModifiedBy; }
        public EntityInfo setLastModifiedBy(String value) { this.lastModifiedBy = value; return this; }
    }

    public static enum SessionDialState
    {
        None,
        Active;
    }

    public static enum SessionCallState
    {
        Disconnected,
        Ringing,
        Connected,
        Hold,
        Passive;
    }

    public static enum SessionQueueStates
    {
        None,
        Queued,
        Ringing,
        Connected,
        Hold,
        Disconnected;
    }

    public static class CustomerBreadcrumb
    {
        public String id = null;
        public String name = null;
        
        public String getId() { return id; }
        public CustomerBreadcrumb setId(String value) { this.id = value; return this; }
        public String getName() { return name; }
        public CustomerBreadcrumb setName(String value) { this.name = value; return this; }
    }

    public static enum FlowChannels
    {
        Voice,
        Chat,
        Fax;
    }

    public static enum SessionHoldReasons
    {
        None,
        Transferring;
    }

    public static class SessionLogInfo
    {
        public String date = null;
        public String message = null;
        
        public String getDate() { return date; }
        public SessionLogInfo setDate(String value) { this.date = value; return this; }
        public String getMessage() { return message; }
        public SessionLogInfo setMessage(String value) { this.message = value; return this; }
    }

    public static class SessionMemberInfo
    {
        public String identity = null;
        public String endpointId = null;
        public String displayName = null;
        public Boolean isOriginalMember = null;
        public String avatarUrl = null;
        public HashMap<String,String> applicationData = null;
        public SessionMemberCallState callState = null;
        public SessionMemberRoles role = null;
        public String callSid = null;
        public Boolean muted = null;
        
        public String getIdentity() { return identity; }
        public SessionMemberInfo setIdentity(String value) { this.identity = value; return this; }
        public String getEndpointId() { return endpointId; }
        public SessionMemberInfo setEndpointId(String value) { this.endpointId = value; return this; }
        public String getDisplayName() { return displayName; }
        public SessionMemberInfo setDisplayName(String value) { this.displayName = value; return this; }
        public Boolean getIsOriginalMember() { return isOriginalMember; }
        public SessionMemberInfo setIsOriginalMember(Boolean value) { this.isOriginalMember = value; return this; }
        public String getAvatarUrl() { return avatarUrl; }
        public SessionMemberInfo setAvatarUrl(String value) { this.avatarUrl = value; return this; }
        public HashMap<String,String> getApplicationData() { return applicationData; }
        public SessionMemberInfo setApplicationData(HashMap<String,String> value) { this.applicationData = value; return this; }
        public SessionMemberCallState getCallState() { return callState; }
        public SessionMemberInfo setCallState(SessionMemberCallState value) { this.callState = value; return this; }
        public SessionMemberRoles getRole() { return role; }
        public SessionMemberInfo setRole(SessionMemberRoles value) { this.role = value; return this; }
        public String getCallSid() { return callSid; }
        public SessionMemberInfo setCallSid(String value) { this.callSid = value; return this; }
        public Boolean isMuted() { return muted; }
        public SessionMemberInfo setMuted(Boolean value) { this.muted = value; return this; }
    }

    public static enum SessionMemberCallState
    {
        None,
        Ringing,
        Connected,
        Hold;
    }

    public static enum SessionMemberRoles
    {
        None,
        Caller,
        Agent,
        Transfer;
    }

    public static enum SessionDirections
    {
        Incoming,
        Outgoing;
    }

    public static class AppHomeCallMetric
    {
        public String metricKey = null;
        public Double total = null;
        public Double average = null;
        
        public String getMetricKey() { return metricKey; }
        public AppHomeCallMetric setMetricKey(String value) { this.metricKey = value; return this; }
        public Double getTotal() { return total; }
        public AppHomeCallMetric setTotal(Double value) { this.total = value; return this; }
        public Double getAverage() { return average; }
        public AppHomeCallMetric setAverage(Double value) { this.average = value; return this; }
    }

    public static class FileInfo extends EntityInfo
    {
        /**
        * The type of file this is
        */
        @ApiMember(Description="The type of file this is")
        public FileTypes type = null;

        /**
        * The account ID this file is associated with
        */
        @ApiMember(Description="The account ID this file is associated with")
        public String accountId = null;

        /**
        * The name of the account this file is associated with
        */
        @ApiMember(Description="The name of the account this file is associated with")
        public String accountName = null;

        /**
        * The ID of the customer this file is associated with
        */
        @ApiMember(Description="The ID of the customer this file is associated with")
        public String customerId = null;

        /**
        * The name of the customer this file is associated with
        */
        @ApiMember(Description="The name of the customer this file is associated with")
        public String customerName = null;

        /**
        * The breadcrumb to the customer for this file
        */
        @ApiMember(Description="The breadcrumb to the customer for this file")
        public ArrayList<CustomerBreadcrumb> customerBreadcrumb = null;

        /**
        * The ID of the user this file is assocaited with
        */
        @ApiMember(Description="The ID of the user this file is assocaited with")
        public String userId = null;

        /**
        * The name of the user this file is associated with
        */
        @ApiMember(Description="The name of the user this file is associated with")
        public String userName = null;

        /**
        * The original file name for the file
        */
        @ApiMember(Description="The original file name for the file")
        public String fileName = null;

        /**
        * The URI of the file
        */
        @ApiMember(Description="The URI of the file")
        public String uri = null;

        /**
        * The Content type of the file
        */
        @ApiMember(Description="The Content type of the file")
        public String contentType = null;

        /**
        * The size of the file
        */
        @ApiMember(Description="The size of the file")
        public Long contentLength = null;

        /**
        * The Twilio ID of the recording
        */
        @ApiMember(Description="The Twilio ID of the recording")
        public String recordingSid = null;

        /**
        * The duration of the recording in seconds
        */
        @ApiMember(Description="The duration of the recording in seconds")
        public Integer recordingDuration = null;

        /**
        * Who is the recording from?
        */
        @ApiMember(Description="Who is the recording from?")
        public String recordingFrom = null;

        /**
        * Transcription (if available)
        */
        @ApiMember(Description="Transcription (if available)")
        public String transcription = null;

        /**
        * From Address (e.g. caller ID) for incoming calls
        */
        @ApiMember(Description="From Address (e.g. caller ID) for incoming calls")
        public String fromAddress = null;

        /**
        * To Address (e.g. dialed number) for outgoing calls
        */
        @ApiMember(Description="To Address (e.g. dialed number) for outgoing calls")
        public String toAddress = null;
        
        public FileTypes getType() { return type; }
        public FileInfo setType(FileTypes value) { this.type = value; return this; }
        public String getAccountId() { return accountId; }
        public FileInfo setAccountId(String value) { this.accountId = value; return this; }
        public String getAccountName() { return accountName; }
        public FileInfo setAccountName(String value) { this.accountName = value; return this; }
        public String getCustomerId() { return customerId; }
        public FileInfo setCustomerId(String value) { this.customerId = value; return this; }
        public String getCustomerName() { return customerName; }
        public FileInfo setCustomerName(String value) { this.customerName = value; return this; }
        public ArrayList<CustomerBreadcrumb> getCustomerBreadcrumb() { return customerBreadcrumb; }
        public FileInfo setCustomerBreadcrumb(ArrayList<CustomerBreadcrumb> value) { this.customerBreadcrumb = value; return this; }
        public String getUserId() { return userId; }
        public FileInfo setUserId(String value) { this.userId = value; return this; }
        public String getUserName() { return userName; }
        public FileInfo setUserName(String value) { this.userName = value; return this; }
        public String getFileName() { return fileName; }
        public FileInfo setFileName(String value) { this.fileName = value; return this; }
        public String getUri() { return uri; }
        public FileInfo setUri(String value) { this.uri = value; return this; }
        public String getContentType() { return contentType; }
        public FileInfo setContentType(String value) { this.contentType = value; return this; }
        public Long getContentLength() { return contentLength; }
        public FileInfo setContentLength(Long value) { this.contentLength = value; return this; }
        public String getRecordingSid() { return recordingSid; }
        public FileInfo setRecordingSid(String value) { this.recordingSid = value; return this; }
        public Integer getRecordingDuration() { return recordingDuration; }
        public FileInfo setRecordingDuration(Integer value) { this.recordingDuration = value; return this; }
        public String getRecordingFrom() { return recordingFrom; }
        public FileInfo setRecordingFrom(String value) { this.recordingFrom = value; return this; }
        public String getTranscription() { return transcription; }
        public FileInfo setTranscription(String value) { this.transcription = value; return this; }
        public String getFromAddress() { return fromAddress; }
        public FileInfo setFromAddress(String value) { this.fromAddress = value; return this; }
        public String getToAddress() { return toAddress; }
        public FileInfo setToAddress(String value) { this.toAddress = value; return this; }
    }

    public static enum FileTypes
    {
        Upload,
        VoiceMessage,
        CallRecording,
        Fax,
        Attachment,
        FaxOutgoing;
    }

    public static class HostedSuiteCompletedForm
    {
        public String id = null;
        public String name = null;
        public String dateCreated = null;
        public String dateCompleted = null;
        public String formId = null;
        public String formName = null;
        public String clientId = null;
        public String clientName = null;
        public String contactId = null;
        public String contactName = null;
        public ArrayList<String> contactsIds = null;
        public ArrayList<String> contactsNames = null;
        public String emailSubject = null;
        public String callerNumber = null;
        public ArrayList<HostedSuiteCompletedFormField> fields = null;
        
        public String getId() { return id; }
        public HostedSuiteCompletedForm setId(String value) { this.id = value; return this; }
        public String getName() { return name; }
        public HostedSuiteCompletedForm setName(String value) { this.name = value; return this; }
        public String getDateCreated() { return dateCreated; }
        public HostedSuiteCompletedForm setDateCreated(String value) { this.dateCreated = value; return this; }
        public String getDateCompleted() { return dateCompleted; }
        public HostedSuiteCompletedForm setDateCompleted(String value) { this.dateCompleted = value; return this; }
        public String getFormId() { return formId; }
        public HostedSuiteCompletedForm setFormId(String value) { this.formId = value; return this; }
        public String getFormName() { return formName; }
        public HostedSuiteCompletedForm setFormName(String value) { this.formName = value; return this; }
        public String getClientId() { return clientId; }
        public HostedSuiteCompletedForm setClientId(String value) { this.clientId = value; return this; }
        public String getClientName() { return clientName; }
        public HostedSuiteCompletedForm setClientName(String value) { this.clientName = value; return this; }
        public String getContactId() { return contactId; }
        public HostedSuiteCompletedForm setContactId(String value) { this.contactId = value; return this; }
        public String getContactName() { return contactName; }
        public HostedSuiteCompletedForm setContactName(String value) { this.contactName = value; return this; }
        public ArrayList<String> getContactsIds() { return contactsIds; }
        public HostedSuiteCompletedForm setContactsIds(ArrayList<String> value) { this.contactsIds = value; return this; }
        public ArrayList<String> getContactsNames() { return contactsNames; }
        public HostedSuiteCompletedForm setContactsNames(ArrayList<String> value) { this.contactsNames = value; return this; }
        public String getEmailSubject() { return emailSubject; }
        public HostedSuiteCompletedForm setEmailSubject(String value) { this.emailSubject = value; return this; }
        public String getCallerNumber() { return callerNumber; }
        public HostedSuiteCompletedForm setCallerNumber(String value) { this.callerNumber = value; return this; }
        public ArrayList<HostedSuiteCompletedFormField> getFields() { return fields; }
        public HostedSuiteCompletedForm setFields(ArrayList<HostedSuiteCompletedFormField> value) { this.fields = value; return this; }
    }

    public static class HostedSuiteCompletedFormField
    {
        public String name = null;
        public ArrayList<String> values = null;
        
        public String getName() { return name; }
        public HostedSuiteCompletedFormField setName(String value) { this.name = value; return this; }
        public ArrayList<String> getValues() { return values; }
        public HostedSuiteCompletedFormField setValues(ArrayList<String> value) { this.values = value; return this; }
    }

}

Java AppGetHomeInformation DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

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: evovoice.io 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AppHomeInformation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Portal">
  <CallMetrics>
    <AppHomeCallMetric>
      <Average>0</Average>
      <MetricKey>String</MetricKey>
      <Total>0</Total>
    </AppHomeCallMetric>
  </CallMetrics>
  <Calls xmlns:d2p1="http://schemas.datacontract.org/2004/07/Voice.Api.Sessions">
    <d2p1: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>
      <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>
  </Calls>
  <Conversations xmlns:d2p1="http://schemas.datacontract.org/2004/07/Voice.Api.Messaging">
    <d2p1:ConversationInfo>
      <d2p1:EndpointId>String</d2p1:EndpointId>
      <d2p1:Id>String</d2p1:Id>
      <d2p1:MostRecentMessage>
        <d2p1:AccountId>String</d2p1:AccountId>
        <d2p1:CustomerId>String</d2p1:CustomerId>
        <d2p1:Date>String</d2p1:Date>
        <d2p1:Direction>Incoming</d2p1:Direction>
        <d2p1:EndpointDisplayName>String</d2p1:EndpointDisplayName>
        <d2p1:EndpointId>String</d2p1:EndpointId>
        <d2p1:Id>String</d2p1:Id>
        <d2p1:IsUnread>false</d2p1:IsUnread>
        <d2p1:OtherAddress>String</d2p1:OtherAddress>
        <d2p1:Sender>String</d2p1:Sender>
        <d2p1:Text>String</d2p1:Text>
      </d2p1:MostRecentMessage>
      <d2p1:OtherAddress>String</d2p1:OtherAddress>
    </d2p1:ConversationInfo>
  </Conversations>
  <Forms>
    <HostedSuiteCompletedForm>
      <CallerNumber>String</CallerNumber>
      <ClientId>String</ClientId>
      <ClientName>String</ClientName>
      <ContactId>String</ContactId>
      <ContactName>String</ContactName>
      <ContactsIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </ContactsIds>
      <ContactsNames xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </ContactsNames>
      <DateCompleted>String</DateCompleted>
      <DateCreated>String</DateCreated>
      <EmailSubject>String</EmailSubject>
      <Fields>
        <HostedSuiteCompletedFormField>
          <Name>String</Name>
          <Values xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>String</d6p1:string>
          </Values>
        </HostedSuiteCompletedFormField>
      </Fields>
      <FormId>String</FormId>
      <FormName>String</FormName>
      <Id>String</Id>
      <Name>String</Name>
    </HostedSuiteCompletedForm>
  </Forms>
  <IsHostedSuiteCustomer>false</IsHostedSuiteCustomer>
  <Voicemail xmlns:d2p1="http://schemas.datacontract.org/2004/07/Voice.Api.Files">
    <d2p1:FileInfo>
      <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>
      <d2p1:AccountId>String</d2p1:AccountId>
      <d2p1:AccountName>String</d2p1:AccountName>
      <d2p1:ContentLength>0</d2p1:ContentLength>
      <d2p1:ContentType>String</d2p1:ContentType>
      <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:FileName>String</d2p1:FileName>
      <d2p1:FromAddress>String</d2p1:FromAddress>
      <d2p1:RecordingDuration>0</d2p1:RecordingDuration>
      <d2p1:RecordingFrom>String</d2p1:RecordingFrom>
      <d2p1:RecordingSid>String</d2p1:RecordingSid>
      <d2p1:ToAddress>String</d2p1:ToAddress>
      <d2p1:Transcription>String</d2p1:Transcription>
      <d2p1:Type>Upload</d2p1:Type>
      <d2p1:Uri>String</d2p1:Uri>
      <d2p1:UserId>String</d2p1:UserId>
      <d2p1:UserName>String</d2p1:UserName>
    </d2p1:FileInfo>
  </Voicemail>
</AppHomeInformation>