| GET | /portal/home |
|---|
export class NodeParameterMap
{
[key:string] : NodeParameter;
public constructor(init?: Partial<NodeParameterMap>) { (Object as any).assign(this, init); }
}
export enum MessageDirections
{
Incoming = 'Incoming',
Outgoing = 'Outgoing',
}
export class MessageInfo
{
public id?: string;
public accountId?: string;
public customerId?: string;
public endpointId?: string;
public endpointDisplayName?: string;
public date?: string;
public direction?: MessageDirections;
public otherAddress?: string;
public sender?: string;
public text?: string;
public isUnread?: boolean;
public constructor(init?: Partial<MessageInfo>) { (Object as any).assign(this, init); }
}
export class ConversationInfo
{
public id?: string;
public endpointId?: string;
public otherAddress?: string;
public mostRecentMessage?: MessageInfo;
public constructor(init?: Partial<ConversationInfo>) { (Object as any).assign(this, init); }
}
export class EntityInfo
{
/**
* The ID of the object
*/
// @ApiMember(Description="The ID of the object")
public id?: string;
/**
* The date the object was created
*/
// @ApiMember(Description="The date the object was created")
public dateCreated?: string;
/**
* The date the object was last modified
*/
// @ApiMember(Description="The date the object was last modified")
public dateLastModified?: string;
/**
* The user that created this object
*/
// @ApiMember(Description="The user that created this object")
public createdBy?: string;
/**
* The user that last modified this object
*/
// @ApiMember(Description="The user that last modified this object")
public lastModifiedBy?: string;
public constructor(init?: Partial<EntityInfo>) { (Object as any).assign(this, init); }
}
export enum SessionDialState
{
None = 'None',
Active = 'Active',
}
export enum SessionCallState
{
Disconnected = 'Disconnected',
Ringing = 'Ringing',
Connected = 'Connected',
Hold = 'Hold',
Passive = 'Passive',
}
export enum SessionQueueStates
{
None = 'None',
Queued = 'Queued',
Ringing = 'Ringing',
Connected = 'Connected',
Hold = 'Hold',
Disconnected = 'Disconnected',
}
export class CustomerBreadcrumb
{
public id?: string;
public name?: string;
public constructor(init?: Partial<CustomerBreadcrumb>) { (Object as any).assign(this, init); }
}
export enum FlowChannels
{
Voice = 'Voice',
Chat = 'Chat',
Fax = 'Fax',
}
export enum SessionHoldReasons
{
None = 'None',
Transferring = 'Transferring',
}
export class SessionLogInfo
{
public date?: string;
public message?: string;
public constructor(init?: Partial<SessionLogInfo>) { (Object as any).assign(this, init); }
}
export enum SessionMemberCallState
{
None = 'None',
Ringing = 'Ringing',
Connected = 'Connected',
Hold = 'Hold',
}
export enum SessionMemberRoles
{
None = 'None',
Caller = 'Caller',
Agent = 'Agent',
Transfer = 'Transfer',
}
export class SessionMemberInfo
{
public identity?: string;
public endpointId?: string;
public displayName?: string;
public isOriginalMember?: boolean;
public avatarUrl?: string;
public applicationData?: { [index: string]: string; };
public callState?: SessionMemberCallState;
public role?: SessionMemberRoles;
public callSid?: string;
public muted?: boolean;
public constructor(init?: Partial<SessionMemberInfo>) { (Object as any).assign(this, init); }
}
export enum SessionDirections
{
Incoming = 'Incoming',
Outgoing = 'Outgoing',
}
export class SessionInfo extends EntityInfo
{
/**
* The state of the session
*/
// @ApiMember(Description="The state of the session")
public dialState?: SessionDialState;
/**
* The call state of the session
*/
// @ApiMember(Description="The call state of the session")
public callState?: SessionCallState;
/**
* The queue state of the session
*/
// @ApiMember(Description="The queue state of the session")
public queueState?: SessionQueueStates;
/**
* The ID of the account associated with the flow
*/
// @ApiMember(Description="The ID of the account associated with the flow")
public accountId?: string;
/**
* The name of the account associated with the session
*/
// @ApiMember(Description="The name of the account associated with the session")
public accountName?: string;
/**
* The ID of the customer this session is associated with
*/
// @ApiMember(Description="The ID of the customer this session is associated with")
public customerId?: string;
/**
* The customer breadcrumb this session is associated with
*/
// @ApiMember(Description="The customer breadcrumb this session is associated with")
public customerBreadcrumb?: CustomerBreadcrumb[];
/**
* The name of the customer this session is associated with
*/
// @ApiMember(Description="The name of the customer this session is associated with")
public customerName?: string;
/**
* The ID of the endpoint associated with this session
*/
// @ApiMember(Description="The ID of the endpoint associated with this session")
public endpointId?: string;
/**
* The name of the endpoint associated with this session
*/
// @ApiMember(Description="The name of the endpoint associated with this session")
public endpointName?: string;
/**
* The date the call completed
*/
// @ApiMember(Description="The date the call completed")
public dateCompleted?: string;
/**
* 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 destination?: string;
/**
* The to address if any
*/
// @ApiMember(Description="The to address if any")
public toAddress?: string;
/**
* The from address if any
*/
// @ApiMember(Description="The from address if any")
public fromAddress?: string;
/**
* The from name if any
*/
// @ApiMember(Description="The from name if any")
public fromName?: string;
/**
* Answered by name (if any)
*/
// @ApiMember(Description="Answered by name (if any)")
public answeredByName?: string;
/**
* The ID of the queue member assigned to this call
*/
// @ApiMember(Description="The ID of the queue member assigned to this call")
public queueMemberId?: string;
/**
* The flow channel
*/
// @ApiMember(Description="The flow channel")
public channel?: FlowChannels;
/**
* Has the session ended
*/
// @ApiMember(Description="Has the session ended")
public ended?: boolean;
/**
* The outcome of the call
*/
// @ApiMember(Description="The outcome of the call")
public outcome?: string;
/**
* The twilio Call SID of this session
*/
// @ApiMember(Description="The twilio Call SID of this session")
public callSid?: string;
/**
* Any console data for this session
*/
// @ApiMember(Description="Any console data for this session")
public consoleData?: string;
/**
* The name of the hold queue for this call
*/
// @ApiMember(Description="The name of the hold queue for this call")
public holdQueueName?: string;
/**
* The user ID who put this call on hold
*/
// @ApiMember(Description="The user ID who put this call on hold")
public heldByUserId?: string;
/**
* The reason for the hold
*/
// @ApiMember(Description="The reason for the hold")
public holdReason?: SessionHoldReasons;
/**
* The SID of the conference if in a conference call
*/
// @ApiMember(Description="The SID of the conference if in a conference call")
public conferenceSid?: string;
/**
* The display name for this session
*/
// @ApiMember(Description="The display name for this session")
public displayName?: string;
/**
* The log entries for this session
*/
// @ApiMember(Description="The log entries for this session")
public log?: SessionLogInfo[];
/**
* The members of this session
*/
// @ApiMember(Description="The members of this session")
public members?: SessionMemberInfo[];
/**
* The callback number (typically used for SIP to User calls)
*/
// @ApiMember(Description="The callback number (typically used for SIP to User calls)")
public callbackNumber?: string;
/**
* The ID of the endpoint that answered
*/
// @ApiMember(Description="The ID of the endpoint that answered")
public answeredById?: string;
/**
* Is this session incoming or outgoing?
*/
// @ApiMember(Description="Is this session incoming or outgoing?")
public direction?: SessionDirections;
/**
* 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 fromPhoneNumber?: string;
/**
* The Call SID of the most recently added conference participant
*/
// @ApiMember(Description="The Call SID of the most recently added conference participant")
public mostRecentParticipantCallSid?: string;
/**
* Was this session missed?
*/
// @ApiMember(Description="Was this session missed?")
public wasMissed?: boolean;
/**
* The ring queue that the call is currently in
*/
// @ApiMember(Description="The ring queue that the call is currently in")
public ringQueueId?: string;
public constructor(init?: Partial<SessionInfo>) { super(init); (Object as any).assign(this, init); }
}
export class AppHomeCallMetric
{
public metricKey?: string;
public total?: number;
public average?: number;
public constructor(init?: Partial<AppHomeCallMetric>) { (Object as any).assign(this, init); }
}
export enum FileTypes
{
Upload = 'Upload',
VoiceMessage = 'VoiceMessage',
CallRecording = 'CallRecording',
Fax = 'Fax',
Attachment = 'Attachment',
FaxOutgoing = 'FaxOutgoing',
}
export class FileInfo extends EntityInfo
{
/**
* The type of file this is
*/
// @ApiMember(Description="The type of file this is")
public type?: FileTypes;
/**
* The account ID this file is associated with
*/
// @ApiMember(Description="The account ID this file is associated with")
public accountId?: string;
/**
* The name of the account this file is associated with
*/
// @ApiMember(Description="The name of the account this file is associated with")
public accountName?: string;
/**
* The ID of the customer this file is associated with
*/
// @ApiMember(Description="The ID of the customer this file is associated with")
public customerId?: string;
/**
* The name of the customer this file is associated with
*/
// @ApiMember(Description="The name of the customer this file is associated with")
public customerName?: string;
/**
* The breadcrumb to the customer for this file
*/
// @ApiMember(Description="The breadcrumb to the customer for this file")
public customerBreadcrumb?: CustomerBreadcrumb[];
/**
* The ID of the user this file is assocaited with
*/
// @ApiMember(Description="The ID of the user this file is assocaited with")
public userId?: string;
/**
* The name of the user this file is associated with
*/
// @ApiMember(Description="The name of the user this file is associated with")
public userName?: string;
/**
* The original file name for the file
*/
// @ApiMember(Description="The original file name for the file")
public fileName?: string;
/**
* The URI of the file
*/
// @ApiMember(Description="The URI of the file")
public uri?: string;
/**
* The Content type of the file
*/
// @ApiMember(Description="The Content type of the file")
public contentType?: string;
/**
* The size of the file
*/
// @ApiMember(Description="The size of the file")
public contentLength?: number;
/**
* The Twilio ID of the recording
*/
// @ApiMember(Description="The Twilio ID of the recording")
public recordingSid?: string;
/**
* The duration of the recording in seconds
*/
// @ApiMember(Description="The duration of the recording in seconds")
public recordingDuration?: number;
/**
* Who is the recording from?
*/
// @ApiMember(Description="Who is the recording from?")
public recordingFrom?: string;
/**
* Transcription (if available)
*/
// @ApiMember(Description="Transcription (if available)")
public transcription?: string;
/**
* From Address (e.g. caller ID) for incoming calls
*/
// @ApiMember(Description="From Address (e.g. caller ID) for incoming calls")
public fromAddress?: string;
/**
* To Address (e.g. dialed number) for outgoing calls
*/
// @ApiMember(Description="To Address (e.g. dialed number) for outgoing calls")
public toAddress?: string;
public constructor(init?: Partial<FileInfo>) { super(init); (Object as any).assign(this, init); }
}
export class HostedSuiteCompletedFormField
{
public name?: string;
public values?: string[];
public constructor(init?: Partial<HostedSuiteCompletedFormField>) { (Object as any).assign(this, init); }
}
export class HostedSuiteCompletedForm
{
public id?: string;
public name?: string;
public dateCreated?: string;
public dateCompleted?: string;
public formId?: string;
public formName?: string;
public clientId?: string;
public clientName?: string;
public contactId?: string;
public contactName?: string;
public contactsIds?: string[];
public contactsNames?: string[];
public emailSubject?: string;
public callerNumber?: string;
public fields?: HostedSuiteCompletedFormField[];
public constructor(init?: Partial<HostedSuiteCompletedForm>) { (Object as any).assign(this, init); }
}
export class AppHomeInformation
{
public isHostedSuiteCustomer?: boolean;
public conversations?: ConversationInfo[];
public calls?: SessionInfo[];
public callMetrics?: AppHomeCallMetric[];
public voicemail?: FileInfo[];
public forms?: HostedSuiteCompletedForm[];
public constructor(init?: Partial<AppHomeInformation>) { (Object as any).assign(this, init); }
}
export class AppGetHomeInformation
{
public accountId?: string;
public customerId?: string;
public fromDate?: string;
public constructor(init?: Partial<AppGetHomeInformation>) { (Object as any).assign(this, init); }
}
TypeScript 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>