| GET | /portal/home |
|---|
"use strict";
/** @typedef {'Incoming'|'Outgoing'} */
export var MessageDirections;
(function (MessageDirections) {
MessageDirections["Incoming"] = "Incoming"
MessageDirections["Outgoing"] = "Outgoing"
})(MessageDirections || (MessageDirections = {}));
export class MessageInfo {
/** @param {{id?:string,accountId?:string,customerId?:string,endpointId?:string,endpointDisplayName?:string,date?:string,direction?:MessageDirections,otherAddress?:string,sender?:string,text?:string,isUnread?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
id;
/** @type {string} */
accountId;
/** @type {string} */
customerId;
/** @type {string} */
endpointId;
/** @type {string} */
endpointDisplayName;
/** @type {string} */
date;
/** @type {MessageDirections} */
direction;
/** @type {string} */
otherAddress;
/** @type {string} */
sender;
/** @type {string} */
text;
/** @type {boolean} */
isUnread;
}
export class ConversationInfo {
/** @param {{id?:string,endpointId?:string,otherAddress?:string,mostRecentMessage?:MessageInfo}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
id;
/** @type {string} */
endpointId;
/** @type {string} */
otherAddress;
/** @type {MessageInfo} */
mostRecentMessage;
}
export class EntityInfo {
/** @param {{id?:string,dateCreated?:string,dateLastModified?:string,createdBy?:string,lastModifiedBy?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description The ID of the object */
id;
/**
* @type {string}
* @description The date the object was created */
dateCreated;
/**
* @type {string}
* @description The date the object was last modified */
dateLastModified;
/**
* @type {string}
* @description The user that created this object */
createdBy;
/**
* @type {string}
* @description The user that last modified this object */
lastModifiedBy;
}
/** @typedef {'None'|'Active'} */
export var SessionDialState;
(function (SessionDialState) {
SessionDialState["None"] = "None"
SessionDialState["Active"] = "Active"
})(SessionDialState || (SessionDialState = {}));
/** @typedef {'Disconnected'|'Ringing'|'Connected'|'Hold'|'Passive'} */
export var SessionCallState;
(function (SessionCallState) {
SessionCallState["Disconnected"] = "Disconnected"
SessionCallState["Ringing"] = "Ringing"
SessionCallState["Connected"] = "Connected"
SessionCallState["Hold"] = "Hold"
SessionCallState["Passive"] = "Passive"
})(SessionCallState || (SessionCallState = {}));
/** @typedef {'None'|'Queued'|'Ringing'|'Connected'|'Hold'|'Disconnected'} */
export var SessionQueueStates;
(function (SessionQueueStates) {
SessionQueueStates["None"] = "None"
SessionQueueStates["Queued"] = "Queued"
SessionQueueStates["Ringing"] = "Ringing"
SessionQueueStates["Connected"] = "Connected"
SessionQueueStates["Hold"] = "Hold"
SessionQueueStates["Disconnected"] = "Disconnected"
})(SessionQueueStates || (SessionQueueStates = {}));
export class CustomerBreadcrumb {
/** @param {{id?:string,name?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
id;
/** @type {string} */
name;
}
/** @typedef {'Voice'|'Chat'|'Fax'} */
export var FlowChannels;
(function (FlowChannels) {
FlowChannels["Voice"] = "Voice"
FlowChannels["Chat"] = "Chat"
FlowChannels["Fax"] = "Fax"
})(FlowChannels || (FlowChannels = {}));
/** @typedef {'None'|'Transferring'} */
export var SessionHoldReasons;
(function (SessionHoldReasons) {
SessionHoldReasons["None"] = "None"
SessionHoldReasons["Transferring"] = "Transferring"
})(SessionHoldReasons || (SessionHoldReasons = {}));
export class SessionLogInfo {
/** @param {{date?:string,message?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
date;
/** @type {string} */
message;
}
/** @typedef {'None'|'Ringing'|'Connected'|'Hold'} */
export var SessionMemberCallState;
(function (SessionMemberCallState) {
SessionMemberCallState["None"] = "None"
SessionMemberCallState["Ringing"] = "Ringing"
SessionMemberCallState["Connected"] = "Connected"
SessionMemberCallState["Hold"] = "Hold"
})(SessionMemberCallState || (SessionMemberCallState = {}));
/** @typedef {'None'|'Caller'|'Agent'|'Transfer'} */
export var SessionMemberRoles;
(function (SessionMemberRoles) {
SessionMemberRoles["None"] = "None"
SessionMemberRoles["Caller"] = "Caller"
SessionMemberRoles["Agent"] = "Agent"
SessionMemberRoles["Transfer"] = "Transfer"
})(SessionMemberRoles || (SessionMemberRoles = {}));
export class SessionMemberInfo {
/** @param {{identity?:string,endpointId?:string,displayName?:string,isOriginalMember?:boolean,avatarUrl?:string,applicationData?:{ [index:string]: string; },callState?:SessionMemberCallState,role?:SessionMemberRoles,callSid?:string,muted?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
identity;
/** @type {string} */
endpointId;
/** @type {string} */
displayName;
/** @type {boolean} */
isOriginalMember;
/** @type {string} */
avatarUrl;
/** @type {{ [index:string]: string; }} */
applicationData;
/** @type {SessionMemberCallState} */
callState;
/** @type {SessionMemberRoles} */
role;
/** @type {string} */
callSid;
/** @type {boolean} */
muted;
}
/** @typedef {'Incoming'|'Outgoing'} */
export var SessionDirections;
(function (SessionDirections) {
SessionDirections["Incoming"] = "Incoming"
SessionDirections["Outgoing"] = "Outgoing"
})(SessionDirections || (SessionDirections = {}));
export class SessionInfo extends EntityInfo {
/** @param {{dialState?:SessionDialState,callState?:SessionCallState,queueState?:SessionQueueStates,accountId?:string,accountName?:string,customerId?:string,customerBreadcrumb?:CustomerBreadcrumb[],customerName?:string,endpointId?:string,endpointName?:string,dateCompleted?:string,destination?:string,toAddress?:string,fromAddress?:string,fromName?:string,answeredByName?:string,queueMemberId?:string,channel?:FlowChannels,ended?:boolean,outcome?:string,callSid?:string,consoleData?:string,holdQueueName?:string,heldByUserId?:string,holdReason?:SessionHoldReasons,conferenceSid?:string,displayName?:string,log?:SessionLogInfo[],members?:SessionMemberInfo[],callbackNumber?:string,answeredById?:string,direction?:SessionDirections,fromPhoneNumber?:string,mostRecentParticipantCallSid?:string,wasMissed?:boolean,ringQueueId?:string,id?:string,dateCreated?:string,dateLastModified?:string,createdBy?:string,lastModifiedBy?:string}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/**
* @type {SessionDialState}
* @description The state of the session */
dialState;
/**
* @type {SessionCallState}
* @description The call state of the session */
callState;
/**
* @type {SessionQueueStates}
* @description The queue state of the session */
queueState;
/**
* @type {string}
* @description The ID of the account associated with the flow */
accountId;
/**
* @type {string}
* @description The name of the account associated with the session */
accountName;
/**
* @type {string}
* @description The ID of the customer this session is associated with */
customerId;
/**
* @type {CustomerBreadcrumb[]}
* @description The customer breadcrumb this session is associated with */
customerBreadcrumb;
/**
* @type {string}
* @description The name of the customer this session is associated with */
customerName;
/**
* @type {string}
* @description The ID of the endpoint associated with this session */
endpointId;
/**
* @type {string}
* @description The name of the endpoint associated with this session */
endpointName;
/**
* @type {string}
* @description The date the call completed */
dateCompleted;
/**
* @type {string}
* @description The destination of the session (e.g. what was entered into the Dial box) */
destination;
/**
* @type {string}
* @description The to address if any */
toAddress;
/**
* @type {string}
* @description The from address if any */
fromAddress;
/**
* @type {string}
* @description The from name if any */
fromName;
/**
* @type {string}
* @description Answered by name (if any) */
answeredByName;
/**
* @type {string}
* @description The ID of the queue member assigned to this call */
queueMemberId;
/**
* @type {FlowChannels}
* @description The flow channel */
channel;
/**
* @type {boolean}
* @description Has the session ended */
ended;
/**
* @type {string}
* @description The outcome of the call */
outcome;
/**
* @type {string}
* @description The twilio Call SID of this session */
callSid;
/**
* @type {string}
* @description Any console data for this session */
consoleData;
/**
* @type {string}
* @description The name of the hold queue for this call */
holdQueueName;
/**
* @type {string}
* @description The user ID who put this call on hold */
heldByUserId;
/**
* @type {SessionHoldReasons}
* @description The reason for the hold */
holdReason;
/**
* @type {string}
* @description The SID of the conference if in a conference call */
conferenceSid;
/**
* @type {string}
* @description The display name for this session */
displayName;
/**
* @type {SessionLogInfo[]}
* @description The log entries for this session */
log;
/**
* @type {SessionMemberInfo[]}
* @description The members of this session */
members;
/**
* @type {string}
* @description The callback number (typically used for SIP to User calls) */
callbackNumber;
/**
* @type {string}
* @description The ID of the endpoint that answered */
answeredById;
/**
* @type {SessionDirections}
* @description Is this session incoming or outgoing? */
direction;
/**
* @type {string}
* @description The phone number that this session is coming from (used with SMS chats) */
fromPhoneNumber;
/**
* @type {string}
* @description The Call SID of the most recently added conference participant */
mostRecentParticipantCallSid;
/**
* @type {boolean}
* @description Was this session missed? */
wasMissed;
/**
* @type {string}
* @description The ring queue that the call is currently in */
ringQueueId;
}
export class AppHomeCallMetric {
/** @param {{metricKey?:string,total?:number,average?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
metricKey;
/** @type {number} */
total;
/** @type {number} */
average;
}
/** @typedef {'Upload'|'VoiceMessage'|'CallRecording'|'Fax'|'Attachment'|'FaxOutgoing'} */
export var FileTypes;
(function (FileTypes) {
FileTypes["Upload"] = "Upload"
FileTypes["VoiceMessage"] = "VoiceMessage"
FileTypes["CallRecording"] = "CallRecording"
FileTypes["Fax"] = "Fax"
FileTypes["Attachment"] = "Attachment"
FileTypes["FaxOutgoing"] = "FaxOutgoing"
})(FileTypes || (FileTypes = {}));
export class FileInfo extends EntityInfo {
/** @param {{type?:FileTypes,accountId?:string,accountName?:string,customerId?:string,customerName?:string,customerBreadcrumb?:CustomerBreadcrumb[],userId?:string,userName?:string,fileName?:string,uri?:string,contentType?:string,contentLength?:number,recordingSid?:string,recordingDuration?:number,recordingFrom?:string,transcription?:string,fromAddress?:string,toAddress?:string,aiTranscription?:string,id?:string,dateCreated?:string,dateLastModified?:string,createdBy?:string,lastModifiedBy?:string}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/**
* @type {FileTypes}
* @description The type of file this is */
type;
/**
* @type {string}
* @description The account ID this file is associated with */
accountId;
/**
* @type {string}
* @description The name of the account this file is associated with */
accountName;
/**
* @type {string}
* @description The ID of the customer this file is associated with */
customerId;
/**
* @type {string}
* @description The name of the customer this file is associated with */
customerName;
/**
* @type {CustomerBreadcrumb[]}
* @description The breadcrumb to the customer for this file */
customerBreadcrumb;
/**
* @type {string}
* @description The ID of the user this file is assocaited with */
userId;
/**
* @type {string}
* @description The name of the user this file is associated with */
userName;
/**
* @type {string}
* @description The original file name for the file */
fileName;
/**
* @type {string}
* @description The URI of the file */
uri;
/**
* @type {string}
* @description The Content type of the file */
contentType;
/**
* @type {number}
* @description The size of the file */
contentLength;
/**
* @type {string}
* @description The Twilio ID of the recording */
recordingSid;
/**
* @type {number}
* @description The duration of the recording in seconds */
recordingDuration;
/**
* @type {string}
* @description Who is the recording from? */
recordingFrom;
/**
* @type {string}
* @description Transcription (if available) */
transcription;
/**
* @type {string}
* @description From Address (e.g. caller ID) for incoming calls */
fromAddress;
/**
* @type {string}
* @description To Address (e.g. dialed number) for outgoing calls */
toAddress;
/**
* @type {string}
* @description The AI transcription for this call */
aiTranscription;
}
export class HostedSuiteCompletedFormField {
/** @param {{name?:string,values?:string[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
name;
/** @type {string[]} */
values;
}
export class HostedSuiteCompletedForm {
/** @param {{id?:string,name?:string,dateCreated?:string,dateCompleted?:string,formId?:string,formName?:string,clientId?:string,clientName?:string,contactId?:string,contactName?:string,contactsIds?:string[],contactsNames?:string[],emailSubject?:string,callerNumber?:string,fields?:HostedSuiteCompletedFormField[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
id;
/** @type {string} */
name;
/** @type {string} */
dateCreated;
/** @type {string} */
dateCompleted;
/** @type {string} */
formId;
/** @type {string} */
formName;
/** @type {string} */
clientId;
/** @type {string} */
clientName;
/** @type {string} */
contactId;
/** @type {string} */
contactName;
/** @type {string[]} */
contactsIds;
/** @type {string[]} */
contactsNames;
/** @type {string} */
emailSubject;
/** @type {string} */
callerNumber;
/** @type {HostedSuiteCompletedFormField[]} */
fields;
}
export class AppHomeInformation {
/** @param {{isHostedSuiteCustomer?:boolean,conversations?:ConversationInfo[],calls?:SessionInfo[],callMetrics?:AppHomeCallMetric[],voicemail?:FileInfo[],forms?:HostedSuiteCompletedForm[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {boolean} */
isHostedSuiteCustomer;
/** @type {ConversationInfo[]} */
conversations;
/** @type {SessionInfo[]} */
calls;
/** @type {AppHomeCallMetric[]} */
callMetrics;
/** @type {FileInfo[]} */
voicemail;
/** @type {HostedSuiteCompletedForm[]} */
forms;
}
export class AppGetHomeInformation {
/** @param {{accountId?:string,customerId?:string,fromDate?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
accountId;
/** @type {string} */
customerId;
/** @type {string} */
fromDate;
}
JavaScript AppGetHomeInformation DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /portal/home HTTP/1.1 Host: team.evovoice.io Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
isHostedSuiteCustomer: False,
conversations:
[
{
id: String,
endpointId: String,
otherAddress: String,
mostRecentMessage:
{
id: String,
accountId: String,
customerId: String,
endpointId: String,
endpointDisplayName: String,
date: String,
direction: Incoming,
otherAddress: String,
sender: String,
text: String,
isUnread: False
}
}
],
calls:
[
{
dialState: None,
callState: Disconnected,
queueState: None,
accountId: String,
accountName: String,
customerId: String,
customerBreadcrumb:
[
{
id: String,
name: String
}
],
customerName: String,
endpointId: String,
endpointName: String,
dateCompleted: String,
destination: String,
toAddress: String,
fromAddress: String,
fromName: String,
answeredByName: String,
queueMemberId: String,
channel: Voice,
ended: False,
outcome: String,
callSid: String,
consoleData: String,
holdQueueName: String,
heldByUserId: String,
holdReason: None,
conferenceSid: String,
displayName: String,
log:
[
{
date: String,
message: String
}
],
members:
[
{
identity: String,
endpointId: String,
displayName: String,
isOriginalMember: False,
avatarUrl: String,
applicationData:
{
String: String
},
callState: None,
role: None,
callSid: String,
muted: False
}
],
callbackNumber: String,
answeredById: String,
direction: Incoming,
fromPhoneNumber: String,
mostRecentParticipantCallSid: String,
wasMissed: False,
ringQueueId: String,
id: String,
dateCreated: String,
dateLastModified: String,
createdBy: String,
lastModifiedBy: String
}
],
callMetrics:
[
{
metricKey: String,
total: 0,
average: 0
}
],
voicemail:
[
{
type: Upload,
accountId: String,
accountName: String,
customerId: String,
customerName: String,
customerBreadcrumb:
[
{
id: String,
name: String
}
],
userId: String,
userName: String,
fileName: String,
uri: String,
contentType: String,
contentLength: 0,
recordingSid: String,
recordingDuration: 0,
recordingFrom: String,
transcription: String,
fromAddress: String,
toAddress: String,
aiTranscription: String,
id: String,
dateCreated: String,
dateLastModified: String,
createdBy: String,
lastModifiedBy: String
}
],
forms:
[
{
id: String,
name: String,
dateCreated: String,
dateCompleted: String,
formId: String,
formName: String,
clientId: String,
clientName: String,
contactId: String,
contactName: String,
contactsIds:
[
String
],
contactsNames:
[
String
],
emailSubject: String,
callerNumber: String,
fields:
[
{
name: String,
values:
[
String
]
}
]
}
]
}