Evo Voice

AppGetHomeInformation

The following routes are available for this service:
GET	/portal/home

**AppGetHomeInformation** Parameters:
Name	Parameter	Data Type	Required
AccountId	query	string	No
CustomerId	query	string	No
FromDate	query	string	No

**AppHomeInformation** Parameters:
Name	Parameter	Data Type	Required
IsHostedSuiteCustomer	form	bool	No
Conversations	form	List<ConversationInfo>	No
Calls	form	List<SessionInfo>	No
CallMetrics	form	List<AppHomeCallMetric>	No
Voicemail	form	List<FileInfo>	No
Forms	form	List<HostedSuiteCompletedForm>	No

**ConversationInfo** Parameters:
Name	Parameter	Data Type	Required
Id	form	string	No
EndpointId	form	string	No
OtherAddress	form	string	No
MostRecentMessage	form	MessageInfo	No

**MessageInfo** Parameters:
Name	Parameter	Data Type	Required
Id	form	string	No
AccountId	form	string	No
CustomerId	form	string	No
EndpointId	form	string	No
EndpointDisplayName	form	string	No
Date	form	string	No
Direction	form	MessageDirections	No
OtherAddress	form	string	No
Sender	form	string	No
Text	form	string	No
IsUnread	form	bool	No

**MessageDirections** Enum:
Incoming
Outgoing

**SessionInfo** Parameters:
Name	Parameter	Data Type	Required	Description
DialState	form	SessionDialState	No	The state of the session
CallState	form	SessionCallState	No	The call state of the session
QueueState	form	SessionQueueStates	No	The queue state of the session
AccountId	form	string	No	The ID of the account associated with the flow
AccountName	form	string	No	The name of the account associated with the session
CustomerId	form	string	No	The ID of the customer this session is associated with
CustomerBreadcrumb	form	List<CustomerBreadcrumb>	No	The customer breadcrumb this session is associated with
CustomerName	form	string	No	The name of the customer this session is associated with
EndpointId	form	string	No	The ID of the endpoint associated with this session
EndpointName	form	string	No	The name of the endpoint associated with this session
DateCompleted	form	string	No	The date the call completed
Destination	form	string	No	The destination of the session (e.g. what was entered into the Dial box)
ToAddress	form	string	No	The to address if any
FromAddress	form	string	No	The from address if any
FromName	form	string	No	The from name if any
AnsweredByName	form	string	No	Answered by name (if any)
QueueMemberId	form	string	No	The ID of the queue member assigned to this call
Channel	form	FlowChannels	No	The flow channel
Ended	form	bool	No	Has the session ended
Outcome	form	string	No	The outcome of the call
CallSid	form	string	No	The twilio Call SID of this session
ConsoleData	form	string	No	Any console data for this session
HoldQueueName	form	string	No	The name of the hold queue for this call
HeldByUserId	form	string	No	The user ID who put this call on hold
HoldReason	form	SessionHoldReasons	No	The reason for the hold
ConferenceSid	form	string	No	The SID of the conference if in a conference call
DisplayName	form	string	No	The display name for this session
Log	form	List<SessionLogInfo>	No	The log entries for this session
Members	form	List<SessionMemberInfo>	No	The members of this session
CallbackNumber	form	string	No	The callback number (typically used for SIP to User calls)
AnsweredById	form	string	No	The ID of the endpoint that answered
Direction	form	SessionDirections	No	Is this session incoming or outgoing?
FromPhoneNumber	form	string	No	The phone number that this session is coming from (used with SMS chats)
MostRecentParticipantCallSid	form	string	No	The Call SID of the most recently added conference participant
WasMissed	form	bool	No	Was this session missed?
RingQueueId	form	string	No	The ring queue that the call is currently in

**EntityInfo** Parameters:
Name	Parameter	Data Type	Required	Description
Id	form	string	No	The ID of the object
DateCreated	form	string	No	The date the object was created
DateLastModified	form	string	No	The date the object was last modified
CreatedBy	form	string	No	The user that created this object
LastModifiedBy	form	string	No	The user that last modified this object

**SessionDialState** Enum:
None
Active

**SessionCallState** Enum:
Disconnected
Ringing
Connected
Hold
Passive

**SessionQueueStates** Enum:
None
Queued
Ringing
Connected
Hold
Disconnected

**CustomerBreadcrumb** Parameters:
Name	Parameter	Data Type	Required	Description
Id	form	string	No
Name	form	string	No

**FlowChannels** Enum:
Voice
Chat
Fax

**SessionHoldReasons** Enum:
None
Transferring

**SessionLogInfo** Parameters:
Name	Parameter	Data Type	Required	Description
Date	form	string	No
Message	form	string	No

**SessionMemberInfo** Parameters:
Name	Parameter	Data Type	Required
Identity	form	string	No
EndpointId	form	string	No
DisplayName	form	string	No
IsOriginalMember	form	bool	No
AvatarUrl	form	string	No
ApplicationData	form	Dictionary<string, string>	No
CallState	form	SessionMemberCallState	No
Role	form	SessionMemberRoles	No
CallSid	form	string	No
Muted	form	bool	No

**SessionMemberCallState** Enum:
None
Ringing
Connected
Hold

**SessionMemberRoles** Enum:
None
Caller
Agent
Transfer

**SessionDirections** Enum:
Incoming
Outgoing

**AppHomeCallMetric** Parameters:
Name	Parameter	Data Type	Required
MetricKey	form	string	No
Total	form	double	No
Average	form	double	No

**FileInfo** Parameters:
Name	Parameter	Data Type	Required	Description
Type	form	FileTypes	No	The type of file this is
AccountId	form	string	No	The account ID this file is associated with
AccountName	form	string	No	The name of the account this file is associated with
CustomerId	form	string	No	The ID of the customer this file is associated with
CustomerName	form	string	No	The name of the customer this file is associated with
CustomerBreadcrumb	form	List<CustomerBreadcrumb>	No	The breadcrumb to the customer for this file
UserId	form	string	No	The ID of the user this file is assocaited with
UserName	form	string	No	The name of the user this file is associated with
FileName	form	string	No	The original file name for the file
Uri	form	string	No	The URI of the file
ContentType	form	string	No	The Content type of the file
ContentLength	form	long	No	The size of the file
RecordingSid	form	string	No	The Twilio ID of the recording
RecordingDuration	form	int	No	The duration of the recording in seconds
RecordingFrom	form	string	No	Who is the recording from?
Transcription	form	string	No	Transcription (if available)
FromAddress	form	string	No	From Address (e.g. caller ID) for incoming calls
ToAddress	form	string	No	To Address (e.g. dialed number) for outgoing calls
AITranscription	form	string	No	The AI transcription for this call

**FileTypes** Enum:
Upload
VoiceMessage
CallRecording
Fax
Attachment
FaxOutgoing

**HostedSuiteCompletedForm** Parameters:
Name	Parameter	Data Type	Required
Id	form	string	No
Name	form	string	No
DateCreated	form	string	No
DateCompleted	form	string	No
FormId	form	string	No
FormName	form	string	No
ClientId	form	string	No
ClientName	form	string	No
ContactId	form	string	No
ContactName	form	string	No
ContactsIds	form	List<string>	No
ContactsNames	form	List<string>	No
EmailSubject	form	string	No
CallerNumber	form	string	No
Fields	form	List<HostedSuiteCompletedFormField>	No

**HostedSuiteCompletedFormField** Parameters:
Name	Parameter	Data Type	Required	Description
Name	form	string	No
Values	form	List<string>	No

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

HTTP + 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: 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
					]
				}
			]
		}
	]
}