GET | /portal/home |
---|
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
class MessageDirections(str, Enum):
INCOMING = 'Incoming'
OUTGOING = 'Outgoing'
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class MessageInfo:
id: Optional[str] = None
account_id: Optional[str] = None
customer_id: Optional[str] = None
endpoint_id: Optional[str] = None
endpoint_display_name: Optional[str] = None
date: Optional[str] = None
direction: Optional[MessageDirections] = None
other_address: Optional[str] = None
sender: Optional[str] = None
text: Optional[str] = None
is_unread: Optional[bool] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ConversationInfo:
id: Optional[str] = None
endpoint_id: Optional[str] = None
other_address: Optional[str] = None
most_recent_message: Optional[MessageInfo] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class EntityInfo:
# @ApiMember(Description="The ID of the object")
id: Optional[str] = None
"""
The ID of the object
"""
# @ApiMember(Description="The date the object was created")
date_created: Optional[str] = None
"""
The date the object was created
"""
# @ApiMember(Description="The date the object was last modified")
date_last_modified: Optional[str] = None
"""
The date the object was last modified
"""
# @ApiMember(Description="The user that created this object")
created_by: Optional[str] = None
"""
The user that created this object
"""
# @ApiMember(Description="The user that last modified this object")
last_modified_by: Optional[str] = None
"""
The user that last modified this object
"""
class SessionDialState(str, Enum):
NONE = 'None'
ACTIVE = 'Active'
class SessionCallState(str, Enum):
DISCONNECTED = 'Disconnected'
RINGING = 'Ringing'
CONNECTED = 'Connected'
HOLD = 'Hold'
PASSIVE = 'Passive'
class SessionQueueStates(str, Enum):
NONE = 'None'
QUEUED = 'Queued'
RINGING = 'Ringing'
CONNECTED = 'Connected'
HOLD = 'Hold'
DISCONNECTED = 'Disconnected'
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CustomerBreadcrumb:
id: Optional[str] = None
name: Optional[str] = None
class FlowChannels(str, Enum):
VOICE = 'Voice'
CHAT = 'Chat'
FAX = 'Fax'
class SessionHoldReasons(str, Enum):
NONE = 'None'
TRANSFERRING = 'Transferring'
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SessionLogInfo:
date: Optional[str] = None
message: Optional[str] = None
class SessionMemberCallState(str, Enum):
NONE = 'None'
RINGING = 'Ringing'
CONNECTED = 'Connected'
HOLD = 'Hold'
class SessionMemberRoles(str, Enum):
NONE = 'None'
CALLER = 'Caller'
AGENT = 'Agent'
TRANSFER = 'Transfer'
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SessionMemberInfo:
identity: Optional[str] = None
endpoint_id: Optional[str] = None
display_name: Optional[str] = None
is_original_member: Optional[bool] = None
avatar_url: Optional[str] = None
application_data: Optional[Dict[str, str]] = None
call_state: Optional[SessionMemberCallState] = None
role: Optional[SessionMemberRoles] = None
call_sid: Optional[str] = None
muted: Optional[bool] = None
class SessionDirections(str, Enum):
INCOMING = 'Incoming'
OUTGOING = 'Outgoing'
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SessionInfo(EntityInfo):
# @ApiMember(Description="The state of the session")
dial_state: Optional[SessionDialState] = None
"""
The state of the session
"""
# @ApiMember(Description="The call state of the session")
call_state: Optional[SessionCallState] = None
"""
The call state of the session
"""
# @ApiMember(Description="The queue state of the session")
queue_state: Optional[SessionQueueStates] = None
"""
The queue state of the session
"""
# @ApiMember(Description="The ID of the account associated with the flow")
account_id: Optional[str] = None
"""
The ID of the account associated with the flow
"""
# @ApiMember(Description="The name of the account associated with the session")
account_name: Optional[str] = None
"""
The name of the account associated with the session
"""
# @ApiMember(Description="The ID of the customer this session is associated with")
customer_id: Optional[str] = None
"""
The ID of the customer this session is associated with
"""
# @ApiMember(Description="The customer breadcrumb this session is associated with")
customer_breadcrumb: Optional[List[CustomerBreadcrumb]] = None
"""
The customer breadcrumb this session is associated with
"""
# @ApiMember(Description="The name of the customer this session is associated with")
customer_name: Optional[str] = None
"""
The name of the customer this session is associated with
"""
# @ApiMember(Description="The ID of the endpoint associated with this session")
endpoint_id: Optional[str] = None
"""
The ID of the endpoint associated with this session
"""
# @ApiMember(Description="The name of the endpoint associated with this session")
endpoint_name: Optional[str] = None
"""
The name of the endpoint associated with this session
"""
# @ApiMember(Description="The date the call completed")
date_completed: Optional[str] = None
"""
The date the call completed
"""
# @ApiMember(Description="The destination of the session (e.g. what was entered into the Dial box)")
destination: Optional[str] = None
"""
The destination of the session (e.g. what was entered into the Dial box)
"""
# @ApiMember(Description="The to address if any")
to_address: Optional[str] = None
"""
The to address if any
"""
# @ApiMember(Description="The from address if any")
from_address: Optional[str] = None
"""
The from address if any
"""
# @ApiMember(Description="The from name if any")
from_name: Optional[str] = None
"""
The from name if any
"""
# @ApiMember(Description="Answered by name (if any)")
answered_by_name: Optional[str] = None
"""
Answered by name (if any)
"""
# @ApiMember(Description="The ID of the queue member assigned to this call")
queue_member_id: Optional[str] = None
"""
The ID of the queue member assigned to this call
"""
# @ApiMember(Description="The flow channel")
channel: Optional[FlowChannels] = None
"""
The flow channel
"""
# @ApiMember(Description="Has the session ended")
ended: Optional[bool] = None
"""
Has the session ended
"""
# @ApiMember(Description="The outcome of the call")
outcome: Optional[str] = None
"""
The outcome of the call
"""
# @ApiMember(Description="The twilio Call SID of this session")
call_sid: Optional[str] = None
"""
The twilio Call SID of this session
"""
# @ApiMember(Description="Any console data for this session")
console_data: Optional[str] = None
"""
Any console data for this session
"""
# @ApiMember(Description="The name of the hold queue for this call")
hold_queue_name: Optional[str] = None
"""
The name of the hold queue for this call
"""
# @ApiMember(Description="The user ID who put this call on hold")
held_by_user_id: Optional[str] = None
"""
The user ID who put this call on hold
"""
# @ApiMember(Description="The reason for the hold")
hold_reason: Optional[SessionHoldReasons] = None
"""
The reason for the hold
"""
# @ApiMember(Description="The SID of the conference if in a conference call")
conference_sid: Optional[str] = None
"""
The SID of the conference if in a conference call
"""
# @ApiMember(Description="The display name for this session")
display_name: Optional[str] = None
"""
The display name for this session
"""
# @ApiMember(Description="The log entries for this session")
log: Optional[List[SessionLogInfo]] = None
"""
The log entries for this session
"""
# @ApiMember(Description="The members of this session")
members: Optional[List[SessionMemberInfo]] = None
"""
The members of this session
"""
# @ApiMember(Description="The callback number (typically used for SIP to User calls)")
callback_number: Optional[str] = None
"""
The callback number (typically used for SIP to User calls)
"""
# @ApiMember(Description="The ID of the endpoint that answered")
answered_by_id: Optional[str] = None
"""
The ID of the endpoint that answered
"""
# @ApiMember(Description="Is this session incoming or outgoing?")
direction: Optional[SessionDirections] = None
"""
Is this session incoming or outgoing?
"""
# @ApiMember(Description="The phone number that this session is coming from (used with SMS chats)")
from_phone_number: Optional[str] = None
"""
The phone number that this session is coming from (used with SMS chats)
"""
# @ApiMember(Description="The Call SID of the most recently added conference participant")
most_recent_participant_call_sid: Optional[str] = None
"""
The Call SID of the most recently added conference participant
"""
# @ApiMember(Description="Was this session missed?")
was_missed: Optional[bool] = None
"""
Was this session missed?
"""
# @ApiMember(Description="The ring queue that the call is currently in")
ring_queue_id: Optional[str] = None
"""
The ring queue that the call is currently in
"""
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AppHomeCallMetric:
metric_key: Optional[str] = None
total: Optional[float] = None
average: Optional[float] = None
class FileTypes(str, Enum):
UPLOAD = 'Upload'
VOICE_MESSAGE = 'VoiceMessage'
CALL_RECORDING = 'CallRecording'
FAX = 'Fax'
ATTACHMENT = 'Attachment'
FAX_OUTGOING = 'FaxOutgoing'
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FileInfo(EntityInfo):
# @ApiMember(Description="The type of file this is")
type: Optional[FileTypes] = None
"""
The type of file this is
"""
# @ApiMember(Description="The account ID this file is associated with")
account_id: Optional[str] = None
"""
The account ID this file is associated with
"""
# @ApiMember(Description="The name of the account this file is associated with")
account_name: Optional[str] = None
"""
The name of the account this file is associated with
"""
# @ApiMember(Description="The ID of the customer this file is associated with")
customer_id: Optional[str] = None
"""
The ID of the customer this file is associated with
"""
# @ApiMember(Description="The name of the customer this file is associated with")
customer_name: Optional[str] = None
"""
The name of the customer this file is associated with
"""
# @ApiMember(Description="The breadcrumb to the customer for this file")
customer_breadcrumb: Optional[List[CustomerBreadcrumb]] = None
"""
The breadcrumb to the customer for this file
"""
# @ApiMember(Description="The ID of the user this file is assocaited with")
user_id: Optional[str] = None
"""
The ID of the user this file is assocaited with
"""
# @ApiMember(Description="The name of the user this file is associated with")
user_name: Optional[str] = None
"""
The name of the user this file is associated with
"""
# @ApiMember(Description="The original file name for the file")
file_name: Optional[str] = None
"""
The original file name for the file
"""
# @ApiMember(Description="The URI of the file")
uri: Optional[str] = None
"""
The URI of the file
"""
# @ApiMember(Description="The Content type of the file")
content_type: Optional[str] = None
"""
The Content type of the file
"""
# @ApiMember(Description="The size of the file")
content_length: Optional[int] = None
"""
The size of the file
"""
# @ApiMember(Description="The Twilio ID of the recording")
recording_sid: Optional[str] = None
"""
The Twilio ID of the recording
"""
# @ApiMember(Description="The duration of the recording in seconds")
recording_duration: Optional[int] = None
"""
The duration of the recording in seconds
"""
# @ApiMember(Description="Who is the recording from?")
recording_from: Optional[str] = None
"""
Who is the recording from?
"""
# @ApiMember(Description="Transcription (if available)")
transcription: Optional[str] = None
"""
Transcription (if available)
"""
# @ApiMember(Description="From Address (e.g. caller ID) for incoming calls")
from_address: Optional[str] = None
"""
From Address (e.g. caller ID) for incoming calls
"""
# @ApiMember(Description="To Address (e.g. dialed number) for outgoing calls")
to_address: Optional[str] = None
"""
To Address (e.g. dialed number) for outgoing calls
"""
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class HostedSuiteCompletedFormField:
name: Optional[str] = None
values: Optional[List[str]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class HostedSuiteCompletedForm:
id: Optional[str] = None
name: Optional[str] = None
date_created: Optional[str] = None
date_completed: Optional[str] = None
form_id: Optional[str] = None
form_name: Optional[str] = None
client_id: Optional[str] = None
client_name: Optional[str] = None
contact_id: Optional[str] = None
contact_name: Optional[str] = None
contacts_ids: Optional[List[str]] = None
contacts_names: Optional[List[str]] = None
email_subject: Optional[str] = None
caller_number: Optional[str] = None
fields: Optional[List[HostedSuiteCompletedFormField]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AppHomeInformation:
is_hosted_suite_customer: Optional[bool] = None
conversations: Optional[List[ConversationInfo]] = None
calls: Optional[List[SessionInfo]] = None
call_metrics: Optional[List[AppHomeCallMetric]] = None
voicemail: Optional[List[FileInfo]] = None
forms: Optional[List[HostedSuiteCompletedForm]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AppGetHomeInformation:
account_id: Optional[str] = None
customer_id: Optional[str] = None
from_date: Optional[str] = None
Python AppGetHomeInformation DTOs
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/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>