Evo Voice

AppGetFlows

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

**AppGetFlows** Parameters:
Name	Parameter	Data Type	Required
AccountId	query	string	No
CustomerId	query	string	No
NameFilter	query	string	No
Role	query	FlowRoles?	No

**ListRequest<T>** Parameters:
Name	Parameter	Data Type	Required	Description
Page	form	int	No	The page of data to retrieve
All	form	bool	No	If you want all objects to be returned. This should be used with care
CountPerPage	form	int	No	The number per page to retrieve
SpecificIds	form	List<string>	No	Specific IDs
SortField	form	string	No	Specify a sort field
SortOrder	form	SortOrders	No	Specify a sort order
SimplifiedPaging	form	bool	No	Disables total / page counts - improves performance. Returns only data. If there is no more data, Items will be empty array

**SortOrders** Enum:
Ascend
Descend

**FlowInfo** Parameters:
Name	Parameter	Data Type	Required	Description
Name	form	string	No	The name of this flow
Roles	form	List<FlowRoles>	No	The roles that this flow has
Description	form	string	No	What this flow does
Notes	form	string	No	Any notes for this flow
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 flow
CustomerId	form	string	No	The ID of the customer this flow is associated with
CustomerName	form	string	No	The name of the customer this flow is associated with
CustomerBreadcrumb	form	List<CustomerBreadcrumb>	No	The breadcrumb to the flow for this endpoint
Nodes	form	List<FlowNode>	No	The nodes in this flow
Parameters	form	List<FlowParameter>	No	The flow's parameters
Exits	form	List<FlowExit>	No	The flow's exits
UI	form	FlowUI	No	The UI data for the flow
Tags	form	List<Tag>	No	The list of tags for this flow
NodeCount	form	int	No	The number of nodes in this flow

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

**FlowRoles** Enum:
UI
Reference
PhoneNumberRouting
UserDialOut
FaxNumberRouting

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

**FlowNode** Parameters:
Name	Parameter	Data Type	Required	Description
Id	form	string	No	The ID of this node. Must be unique within the flow but can be anything
IsStartNode	form	bool	No	Is this the starting node for the flow. Only one node can have this set
Name	form	string	No	The name of the node, descriptive to be used as a reminder in the GUI
Spec	form	FlowNodeSpec	No	The specification for the node
UI	form	FlowNodeUI	No	The UI data for the node
Parameters	form	NodeParameterMap	No	The data for this node. These will be POST'd to the endpoint when it is called.

**FlowNodeSpec** Parameters:
Name	Parameter	Data Type	Required	Description
Name	form	string	No	The name of this node
Description	form	string	No	A description of this node
IconClass	form	string	No	Icon class for this node (FontAwesome)
TypeName	form	string	No	The type name for this node
Category	form	FlowNodeCategories	No	The category this node should be grouped under
Url	form	string	No	The URL where this node is located
DataType	form	DataType	No	The data type for this node
DocumentationUrl	form	string	No	URL for documentation for this node
RestrictToChannels	form	List<FlowChannels>	No	The channels that this node is restricted to

**FlowNodeCategories** Enum:
General
Voice
Logic
DateAndTime
Audio
Messaging
Assistant
Flows
Fax
Network
Cookies
CallCenter
Intelligence

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

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

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

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

**DataFieldUniqueness** Enum:
NotUnique
Unique
UniqueToCustomer

**UserDataFieldModes** Enum:
Hidden
ReadOnly
ReadWrite

**FlowChannels** Enum:
Voice
Chat
Fax

**FlowNodeUI** Parameters:
Name	Parameter	Data Type	Required	Description
X	form	double	No	The X position of the node
Y	form	double	No	The Y position of the node
Notes	form	string	No	Notes for this node

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

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

**FlowParameter** Parameters:
Name	Parameter	Data Type	Required	Description
IsPublic	form	bool	No
IsKnob	form	bool	No

**FlowExit** Parameters:
Name	Parameter	Data Type	Required	Description
Id	form	string	No	The unique ID for this exit
Name	form	string	No	The name of this exit
UI	form	FlowNodeUI	No	The UI for the exit

**FlowUI** Parameters:
Name	Parameter	Data Type	Required
SelectedNode	form	string	No
CanvasX	form	double	No
CanvasY	form	double	No
CanvasZoom	form	double	No

**Tag** Parameters:
Name	Parameter	Data Type	Required
Id	form	string	No
Name	form	string	No
Color	form	TagColors	No

**TagColors** Enum:
Magenta
Red
Volcano
Orange
Gold
Lime
Green
Cyan
Blue
GeekBlue
Purple

**ListResponse<T>** Parameters:
Name	Parameter	Data Type	Required	Description
Items	form	List<AccountInfo>	No	The items
TotalCount	form	int	No	The total number of items
TotalPages	form	int	No	The total number of pages
HasMorePages	form	bool	No	Are there more pages of items? Used with simplified paging

**AccountInfo** Parameters:
Name	Parameter	Data Type	Required	Description
Name	form	string	No	The name of this account
ParentAccountId	form	string	No	The ID of this account's parent
TwilioAccountSid	form	string	No	The twilio account SID
AncestorIds	form	List<string>	No	The ancestors of this account. Useful for breadcrumbs
MaxPhoneNumbers	form	int	No	The max number of phone numbers this account can have
IsBYOA	form	bool	No	This account is BYOA
TrustHubProfileSid	form	string	No	TrustHub Profile Sid
LogoId	form	string	No	The ID of the logo file
LogoUri	form	string	No	The URI of the logo file
BillingSettings	form	BillingSettings	No	The billing settings for this account

**BillingSettings** Parameters:
Name	Parameter	Data Type	Required
Base	form	BillingItem	No
LocalNumbers	form	BillingItem	No
TollFreeNumbers	form	BillingItem	No
InboundVoiceCalls	form	BillingItem	No
OutboundVoiceCalls	form	BillingItem	No
InboundFaxes	form	BillingItem	No
OutboundFaxes	form	BillingItem	No
InboundSmsMessages	form	BillingItem	No
OutboundSmsMessages	form	BillingItem	No
AIInsights	form	BillingItem	No
AILiveMinutes	form	BillingItem	No
AIMessages	form	BillingItem	No

**BillingItem** Parameters:
Name	Parameter	Data Type	Required
BaseCost	form	double	No
RawUnitMultiplier	form	double	No
UnitCost	form	double	No
Allowance	form	int	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/flows HTTP/1.1 
Host: evovoice.io 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	items: 
	[
		{
			name: String,
			roles: 
			[
				UI
			],
			description: String,
			notes: String,
			accountId: String,
			accountName: String,
			customerId: String,
			customerName: String,
			customerBreadcrumb: 
			[
				{
					id: String,
					name: String
				}
			],
			nodes: 
			[
				{
					id: String,
					isStartNode: False,
					name: String,
					spec: 
					{
						name: String,
						description: String,
						iconClass: String,
						typeName: String,
						category: General,
						url: String,
						documentationUrl: String,
						restrictToChannels: 
						[
							Voice
						]
					},
					ui: 
					{
						x: 0,
						y: 0,
						notes: String
					},
					parameters: {}
				}
			],
			parameters: 
			[
				{
					isPublic: False,
					isKnob: False,
					id: String,
					name: String,
					type: NotSpecified,
					uiHint: None,
					uiTab: String,
					isAsync: False,
					disableBinding: False,
					description: String,
					possibleValues: 
					[
						String
					],
					isOutput: False,
					customFieldValuesUrl: String,
					defaultValue: 
					{
						boolValue: False,
						stringValue: String,
						numberValue: 0,
						listValue: 
						[
							null
						]
					},
					transitionNameFormat: String,
					uniqueness: NotUnique,
					voiceOnly: False,
					conditionalVisibilityField: String,
					conditionalVisibilityValue: String,
					noEvalTemplate: False,
					userMode: Hidden,
					anyValueType: False
				}
			],
			exits: 
			[
				{
					id: String,
					name: String,
					ui: 
					{
						x: 0,
						y: 0,
						notes: String
					}
				}
			],
			ui: 
			{
				selectedNode: String,
				canvasX: 0,
				canvasY: 0,
				canvasZoom: 0
			},
			tags: 
			[
				{
					id: String,
					name: String,
					color: Magenta
				}
			],
			nodeCount: 0,
			id: String,
			dateCreated: String,
			dateLastModified: String,
			createdBy: String,
			lastModifiedBy: String
		}
	],
	totalCount: 0,
	totalPages: 0,
	hasMorePages: False
}