| GET | /portal/home |
|---|
namespace Voice.Api
open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
type MessageDirections =
| Incoming = 0
| Outgoing = 1
[<AllowNullLiteral>]
type MessageInfo() =
member val Id:String = null with get,set
member val AccountId:String = null with get,set
member val CustomerId:String = null with get,set
member val EndpointId:String = null with get,set
member val EndpointDisplayName:String = null with get,set
member val Date:String = null with get,set
member val Direction:MessageDirections = new MessageDirections() with get,set
member val OtherAddress:String = null with get,set
member val Sender:String = null with get,set
member val Text:String = null with get,set
member val IsUnread:Boolean = new Boolean() with get,set
[<AllowNullLiteral>]
type ConversationInfo() =
member val Id:String = null with get,set
member val EndpointId:String = null with get,set
member val OtherAddress:String = null with get,set
member val MostRecentMessage:MessageInfo = null with get,set
[<AllowNullLiteral>]
type EntityInfo() =
///<summary>
///The ID of the object
///</summary>
[<ApiMember(Description="The ID of the object")>]
member val Id:String = null with get,set
///<summary>
///The date the object was created
///</summary>
[<ApiMember(Description="The date the object was created")>]
member val DateCreated:String = null with get,set
///<summary>
///The date the object was last modified
///</summary>
[<ApiMember(Description="The date the object was last modified")>]
member val DateLastModified:String = null with get,set
///<summary>
///The user that created this object
///</summary>
[<ApiMember(Description="The user that created this object")>]
member val CreatedBy:String = null with get,set
///<summary>
///The user that last modified this object
///</summary>
[<ApiMember(Description="The user that last modified this object")>]
member val LastModifiedBy:String = null with get,set
type SessionDialState =
| None = 0
| Active = 1
type SessionCallState =
| Disconnected = 0
| Ringing = 1
| Connected = 2
| Hold = 3
| Passive = 4
type SessionQueueStates =
| None = 0
| Queued = 1
| Ringing = 2
| Connected = 3
| Hold = 4
| Disconnected = 5
[<AllowNullLiteral>]
type CustomerBreadcrumb() =
member val Id:String = null with get,set
member val Name:String = null with get,set
type FlowChannels =
| Voice = 0
| Chat = 1
| Fax = 2
type SessionHoldReasons =
| None = 0
| Transferring = 1
[<AllowNullLiteral>]
type SessionLogInfo() =
member val Date:String = null with get,set
member val Message:String = null with get,set
type SessionMemberCallState =
| None = 0
| Ringing = 1
| Connected = 2
| Hold = 3
type SessionMemberRoles =
| None = 0
| Caller = 1
| Agent = 2
| Transfer = 3
[<AllowNullLiteral>]
type SessionMemberInfo() =
member val Identity:String = null with get,set
member val EndpointId:String = null with get,set
member val DisplayName:String = null with get,set
member val IsOriginalMember:Boolean = new Boolean() with get,set
member val AvatarUrl:String = null with get,set
member val ApplicationData:Dictionary<String, String> = null with get,set
member val CallState:SessionMemberCallState = new SessionMemberCallState() with get,set
member val Role:SessionMemberRoles = new SessionMemberRoles() with get,set
member val CallSid:String = null with get,set
member val Muted:Boolean = new Boolean() with get,set
type SessionDirections =
| Incoming = 0
| Outgoing = 1
[<AllowNullLiteral>]
type SessionInfo() =
inherit EntityInfo()
///<summary>
///The state of the session
///</summary>
[<ApiMember(Description="The state of the session")>]
member val DialState:SessionDialState = new SessionDialState() with get,set
///<summary>
///The call state of the session
///</summary>
[<ApiMember(Description="The call state of the session")>]
member val CallState:SessionCallState = new SessionCallState() with get,set
///<summary>
///The queue state of the session
///</summary>
[<ApiMember(Description="The queue state of the session")>]
member val QueueState:SessionQueueStates = new SessionQueueStates() with get,set
///<summary>
///The ID of the account associated with the flow
///</summary>
[<ApiMember(Description="The ID of the account associated with the flow")>]
member val AccountId:String = null with get,set
///<summary>
///The name of the account associated with the session
///</summary>
[<ApiMember(Description="The name of the account associated with the session")>]
member val AccountName:String = null with get,set
///<summary>
///The ID of the customer this session is associated with
///</summary>
[<ApiMember(Description="The ID of the customer this session is associated with")>]
member val CustomerId:String = null with get,set
///<summary>
///The customer breadcrumb this session is associated with
///</summary>
[<ApiMember(Description="The customer breadcrumb this session is associated with")>]
member val CustomerBreadcrumb:ResizeArray<CustomerBreadcrumb> = null with get,set
///<summary>
///The name of the customer this session is associated with
///</summary>
[<ApiMember(Description="The name of the customer this session is associated with")>]
member val CustomerName:String = null with get,set
///<summary>
///The ID of the endpoint associated with this session
///</summary>
[<ApiMember(Description="The ID of the endpoint associated with this session")>]
member val EndpointId:String = null with get,set
///<summary>
///The name of the endpoint associated with this session
///</summary>
[<ApiMember(Description="The name of the endpoint associated with this session")>]
member val EndpointName:String = null with get,set
///<summary>
///The date the call completed
///</summary>
[<ApiMember(Description="The date the call completed")>]
member val DateCompleted:String = null with get,set
///<summary>
///The destination of the session (e.g. what was entered into the Dial box)
///</summary>
[<ApiMember(Description="The destination of the session (e.g. what was entered into the Dial box)")>]
member val Destination:String = null with get,set
///<summary>
///The to address if any
///</summary>
[<ApiMember(Description="The to address if any")>]
member val ToAddress:String = null with get,set
///<summary>
///The from address if any
///</summary>
[<ApiMember(Description="The from address if any")>]
member val FromAddress:String = null with get,set
///<summary>
///The from name if any
///</summary>
[<ApiMember(Description="The from name if any")>]
member val FromName:String = null with get,set
///<summary>
///Answered by name (if any)
///</summary>
[<ApiMember(Description="Answered by name (if any)")>]
member val AnsweredByName:String = null with get,set
///<summary>
///The ID of the queue member assigned to this call
///</summary>
[<ApiMember(Description="The ID of the queue member assigned to this call")>]
member val QueueMemberId:String = null with get,set
///<summary>
///The flow channel
///</summary>
[<ApiMember(Description="The flow channel")>]
member val Channel:FlowChannels = new FlowChannels() with get,set
///<summary>
///Has the session ended
///</summary>
[<ApiMember(Description="Has the session ended")>]
member val Ended:Boolean = new Boolean() with get,set
///<summary>
///The outcome of the call
///</summary>
[<ApiMember(Description="The outcome of the call")>]
member val Outcome:String = null with get,set
///<summary>
///The twilio Call SID of this session
///</summary>
[<ApiMember(Description="The twilio Call SID of this session")>]
member val CallSid:String = null with get,set
///<summary>
///Any console data for this session
///</summary>
[<ApiMember(Description="Any console data for this session")>]
member val ConsoleData:String = null with get,set
///<summary>
///The name of the hold queue for this call
///</summary>
[<ApiMember(Description="The name of the hold queue for this call")>]
member val HoldQueueName:String = null with get,set
///<summary>
///The user ID who put this call on hold
///</summary>
[<ApiMember(Description="The user ID who put this call on hold")>]
member val HeldByUserId:String = null with get,set
///<summary>
///The reason for the hold
///</summary>
[<ApiMember(Description="The reason for the hold")>]
member val HoldReason:SessionHoldReasons = new SessionHoldReasons() with get,set
///<summary>
///The SID of the conference if in a conference call
///</summary>
[<ApiMember(Description="The SID of the conference if in a conference call")>]
member val ConferenceSid:String = null with get,set
///<summary>
///The display name for this session
///</summary>
[<ApiMember(Description="The display name for this session")>]
member val DisplayName:String = null with get,set
///<summary>
///The log entries for this session
///</summary>
[<ApiMember(Description="The log entries for this session")>]
member val Log:ResizeArray<SessionLogInfo> = null with get,set
///<summary>
///The members of this session
///</summary>
[<ApiMember(Description="The members of this session")>]
member val Members:ResizeArray<SessionMemberInfo> = null with get,set
///<summary>
///The callback number (typically used for SIP to User calls)
///</summary>
[<ApiMember(Description="The callback number (typically used for SIP to User calls)")>]
member val CallbackNumber:String = null with get,set
///<summary>
///The ID of the endpoint that answered
///</summary>
[<ApiMember(Description="The ID of the endpoint that answered")>]
member val AnsweredById:String = null with get,set
///<summary>
///Is this session incoming or outgoing?
///</summary>
[<ApiMember(Description="Is this session incoming or outgoing?")>]
member val Direction:SessionDirections = new SessionDirections() with get,set
///<summary>
///The phone number that this session is coming from (used with SMS chats)
///</summary>
[<ApiMember(Description="The phone number that this session is coming from (used with SMS chats)")>]
member val FromPhoneNumber:String = null with get,set
///<summary>
///The Call SID of the most recently added conference participant
///</summary>
[<ApiMember(Description="The Call SID of the most recently added conference participant")>]
member val MostRecentParticipantCallSid:String = null with get,set
///<summary>
///Was this session missed?
///</summary>
[<ApiMember(Description="Was this session missed?")>]
member val WasMissed:Boolean = new Boolean() with get,set
///<summary>
///The ring queue that the call is currently in
///</summary>
[<ApiMember(Description="The ring queue that the call is currently in")>]
member val RingQueueId:String = null with get,set
[<AllowNullLiteral>]
type AppHomeCallMetric() =
member val MetricKey:String = null with get,set
member val Total:Double = new Double() with get,set
member val Average:Double = new Double() with get,set
type FileTypes =
| Upload = 0
| VoiceMessage = 1
| CallRecording = 2
| Fax = 3
| Attachment = 4
| FaxOutgoing = 5
[<AllowNullLiteral>]
type FileInfo() =
inherit EntityInfo()
///<summary>
///The type of file this is
///</summary>
[<ApiMember(Description="The type of file this is")>]
member val Type:FileTypes = new FileTypes() with get,set
///<summary>
///The account ID this file is associated with
///</summary>
[<ApiMember(Description="The account ID this file is associated with")>]
member val AccountId:String = null with get,set
///<summary>
///The name of the account this file is associated with
///</summary>
[<ApiMember(Description="The name of the account this file is associated with")>]
member val AccountName:String = null with get,set
///<summary>
///The ID of the customer this file is associated with
///</summary>
[<ApiMember(Description="The ID of the customer this file is associated with")>]
member val CustomerId:String = null with get,set
///<summary>
///The name of the customer this file is associated with
///</summary>
[<ApiMember(Description="The name of the customer this file is associated with")>]
member val CustomerName:String = null with get,set
///<summary>
///The breadcrumb to the customer for this file
///</summary>
[<ApiMember(Description="The breadcrumb to the customer for this file")>]
member val CustomerBreadcrumb:ResizeArray<CustomerBreadcrumb> = null with get,set
///<summary>
///The ID of the user this file is assocaited with
///</summary>
[<ApiMember(Description="The ID of the user this file is assocaited with")>]
member val UserId:String = null with get,set
///<summary>
///The name of the user this file is associated with
///</summary>
[<ApiMember(Description="The name of the user this file is associated with")>]
member val UserName:String = null with get,set
///<summary>
///The original file name for the file
///</summary>
[<ApiMember(Description="The original file name for the file")>]
member val FileName:String = null with get,set
///<summary>
///The URI of the file
///</summary>
[<ApiMember(Description="The URI of the file")>]
member val Uri:String = null with get,set
///<summary>
///The Content type of the file
///</summary>
[<ApiMember(Description="The Content type of the file")>]
member val ContentType:String = null with get,set
///<summary>
///The size of the file
///</summary>
[<ApiMember(Description="The size of the file")>]
member val ContentLength:Int64 = new Int64() with get,set
///<summary>
///The Twilio ID of the recording
///</summary>
[<ApiMember(Description="The Twilio ID of the recording")>]
member val RecordingSid:String = null with get,set
///<summary>
///The duration of the recording in seconds
///</summary>
[<ApiMember(Description="The duration of the recording in seconds")>]
member val RecordingDuration:Int32 = new Int32() with get,set
///<summary>
///Who is the recording from?
///</summary>
[<ApiMember(Description="Who is the recording from?")>]
member val RecordingFrom:String = null with get,set
///<summary>
///Transcription (if available)
///</summary>
[<ApiMember(Description="Transcription (if available)")>]
member val Transcription:String = null with get,set
///<summary>
///From Address (e.g. caller ID) for incoming calls
///</summary>
[<ApiMember(Description="From Address (e.g. caller ID) for incoming calls")>]
member val FromAddress:String = null with get,set
///<summary>
///To Address (e.g. dialed number) for outgoing calls
///</summary>
[<ApiMember(Description="To Address (e.g. dialed number) for outgoing calls")>]
member val ToAddress:String = null with get,set
///<summary>
///The AI transcription for this call
///</summary>
[<ApiMember(Description="The AI transcription for this call")>]
member val AITranscription:String = null with get,set
[<AllowNullLiteral>]
type HostedSuiteCompletedFormField() =
member val Name:String = null with get,set
member val Values:ResizeArray<String> = null with get,set
[<AllowNullLiteral>]
type HostedSuiteCompletedForm() =
member val Id:String = null with get,set
member val Name:String = null with get,set
member val DateCreated:String = null with get,set
member val DateCompleted:String = null with get,set
member val FormId:String = null with get,set
member val FormName:String = null with get,set
member val ClientId:String = null with get,set
member val ClientName:String = null with get,set
member val ContactId:String = null with get,set
member val ContactName:String = null with get,set
member val ContactsIds:ResizeArray<String> = null with get,set
member val ContactsNames:ResizeArray<String> = null with get,set
member val EmailSubject:String = null with get,set
member val CallerNumber:String = null with get,set
member val Fields:ResizeArray<HostedSuiteCompletedFormField> = null with get,set
[<AllowNullLiteral>]
type AppHomeInformation() =
member val IsHostedSuiteCustomer:Boolean = new Boolean() with get,set
member val Conversations:ResizeArray<ConversationInfo> = null with get,set
member val Calls:ResizeArray<SessionInfo> = null with get,set
member val CallMetrics:ResizeArray<AppHomeCallMetric> = null with get,set
member val Voicemail:ResizeArray<FileInfo> = null with get,set
member val Forms:ResizeArray<HostedSuiteCompletedForm> = null with get,set
[<AllowNullLiteral>]
type AppGetHomeInformation() =
member val AccountId:String = null with get,set
member val CustomerId:String = null with get,set
member val FromDate:String = null with get,set
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: team.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:AITranscription>String</d2p1:AITranscription>
<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>