Evo Voice

NotUsedRequest

The following routes are available for this service:
All Verbs	/not-used

**NotUsedRequest** Parameters:
Name	Parameter	Data Type	Required
PushNotification	query	PushNotification	No
Notifications	query	List<NotificationInfo>	No
NodeParameter	query	NodeParameter	No

**PushNotification** Parameters:
Name	Parameter	Data Type	Required
Type	form	PushNotificationTypes	No
Channel	form	FlowChannels	No
EndpointId	form	string	No
EndpointUserName	form	string	No
SessionId	form	string	No
Sender	form	string	No
Title	form	string	No
Body	form	string	No
Badge	form	int?	No
AttachmentUri	form	string	No
AttachmentContentType	form	string	No
AgentState	form	AgentStates	No
AgentStateReason	form	AgentStateReasons	No

**PushNotificationTypes** Enum:
SessionDisconnected
SessionInvite
ChatMessage
SessionInactivated
AgentStateChanged
SessionHeld
SessionAnswered
ActiveSessionsChanged
Ping
SessionScreenChanged
Toast
SessionInfoChanged
MessageReceived
SessionHolding

**FlowChannels** Enum:
Voice
Chat
Fax

**AgentStates** Enum:
Unknown
Ready
NotReady
LoggedOut
WrapUp
Outgoing
Other

**AgentStateReasons** Enum:
Unknown
SetByUser
MissedCall
SetBySystem

**NotificationInfo** Parameters:
Name	Parameter	Data Type	Required	Description
AccountId	form	string	No	The account ID this endpoint is associated with
AccountName	form	string	No	The name of the account this endpoint is associated with
CustomerId	form	string	No	The ID of the customer this endpoint is associated with
CustomerName	form	string	No	The name of the customer this endpoint is associated with
CustomerBreadcrumb	form	List<CustomerBreadcrumb>	No	The breadcrumb to the customer for this endpoint
Type	form	NotificationTypes	No	The type of notification
Subject	form	string	No	The subject of the notification
Body	form	string	No	The body of the notification
Recipients	form	List<NotificationRecipientInfo>	No	The recipients of this notification
Attachments	form	List<FileInfo>	No	The list of attachments
From	form	string	No	The original from for the session
To	form	string	No	The original To for the session
Error	form	bool	No	Was there an error?
ErrorMessage	form	string	No	The error message

**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

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

**NotificationTypes** Enum:
Email
Sms
Push
IncomingCall
OutgoingCall

**NotificationRecipientInfo** Parameters:
Name	Parameter	Data Type	Required	Description
Address	form	string	No	The address of the recipient
Extra	form	string	No	Extra info about the recipient e.g. CC, BCC
Name	form	string	No	The name of the recipient

**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

**NodeParameter** Parameters:
Name	Parameter	Data Type	Required
Id	form	string	No
Type	form	ValueTypes	No
Source	form	ValueSources	No
IsAsync	form	bool	No
ReferenceId	form	string	No
Value	form	Value	No
NoEvalTemplate	form	bool	No
ListParameters	form	List<NodeParameterMap>	No
StructParameters	form	NodeParameterMap	No
IsOutput	form	bool	No
Expression	form	string	No
ListType	form	DataType	No

**ValueTypes** Enum:
NotSpecified
String
Boolean
Number
List
Struct
Transition
Custom
Date
AudioFile
TimeZoneId
PhoneNumber
User
Endpoint
Time
File
FaxNumber
EmailAccount
Customer
Flow
Team
FlowReference
Integration
Assistant

**ValueSources** Enum:
Value
Flow
System
Customer
Session
Endpoint
Expression
User

**Value** Parameters:
Name	Parameter	Data Type	Required
BoolValue	form	bool?	No
StringValue	form	string	No
NumberValue	form	double?	No
ListValue	form	List<Struct>	No
StructValue	form	Struct	No

**DataType** Parameters:
Name	Parameter	Data Type	Required	Description
TypeName	form	string	No
Fields	form	List<DataField>	No

**DataField** Parameters:
Name	Parameter	Data Type	Required
Id	form	string	No
Name	form	string	No
Type	form	ValueTypes	No
UIHint	form	UIHints	No
UITab	form	string	No
IsAsync	form	bool	No
DisableBinding	form	bool	No
StructType	form	DataType	No
ListType	form	DataType	No
Description	form	string	No
PossibleValues	form	List<string>	No
IsOutput	form	bool	No
CustomFieldValuesUrl	form	string	No
DefaultValue	form	Value	No
TransitionNameFormat	form	string	No
Uniqueness	form	DataFieldUniqueness	No
VoiceOnly	form	bool	No
ConditionalVisibilityField	form	string	No
ConditionalVisibilityValue	form	string	No
NoEvalTemplate	form	bool	No
UserMode	form	UserDataFieldModes	No
AnyValueType	form	bool	No

**UIHints** Enum:
None
LargeText
InlineForm
Password
InlineStruct

**DataFieldUniqueness** Enum:
NotUnique
Unique
UniqueToCustomer

**UserDataFieldModes** Enum:
Hidden
ReadOnly
ReadWrite

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.

POST /not-used HTTP/1.1 
Host: team.evovoice.io 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	pushNotification: 
	{
		type: SessionDisconnected,
		channel: Voice,
		endpointId: String,
		endpointUserName: String,
		sessionId: String,
		sender: String,
		title: String,
		body: String,
		badge: 0,
		attachmentUri: String,
		attachmentContentType: String,
		agentState: Unknown,
		agentStateReason: Unknown
	},
	notifications: 
	[
		{
			accountId: String,
			accountName: String,
			customerId: String,
			customerName: String,
			customerBreadcrumb: 
			[
				{
					id: String,
					name: String
				}
			],
			type: Email,
			subject: String,
			body: String,
			recipients: 
			[
				{
					address: String,
					extra: String,
					name: String
				}
			],
			attachments: 
			[
				{
					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
				}
			],
			from: String,
			to: String,
			error: False,
			errorMessage: String,
			id: String,
			dateCreated: String,
			dateLastModified: String,
			createdBy: String,
			lastModifiedBy: String
		}
	]
}