Evo Voice

<back to all web services

CopyFlow

Make a copy of the flow

Requires Authentication
Requires any of the roles:SystemAdministrator, Manager, Customer
The following routes are available for this service:
POST/flows/{flowId}/copy
CopyFlow Parameters:
NameParameterData TypeRequiredDescription
FlowIdpathstringNoThe ID of the flow to copy
FlowInfo Parameters:
NameParameterData TypeRequiredDescription
NameformstringNoThe name of this flow
RolesformList<FlowRoles>NoThe roles that this flow has
DescriptionformstringNoWhat this flow does
NotesformstringNoAny notes for this flow
AccountIdformstringNoThe ID of the account associated with the flow
AccountNameformstringNoThe name of the account associated with the flow
CustomerIdformstringNoThe ID of the customer this flow is associated with
CustomerNameformstringNoThe name of the customer this flow is associated with
CustomerBreadcrumbformList<CustomerBreadcrumb>NoThe breadcrumb to the flow for this endpoint
NodesformList<FlowNode>NoThe nodes in this flow
ParametersformList<FlowParameter>NoThe flow's parameters
ExitsformList<FlowExit>NoThe flow's exits
UIformFlowUINoThe UI data for the flow
TagsformList<Tag>NoThe list of tags for this flow
NodeCountformintNoThe number of nodes in this flow
EntityInfo Parameters:
NameParameterData TypeRequiredDescription
IdformstringNoThe ID of the object
DateCreatedformstringNoThe date the object was created
DateLastModifiedformstringNoThe date the object was last modified
CreatedByformstringNoThe user that created this object
LastModifiedByformstringNoThe user that last modified this object
FlowRoles Enum:
UI
Reference
PhoneNumberRouting
UserDialOut
FaxNumberRouting
CustomerBreadcrumb Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
NameformstringNo
FlowNode Parameters:
NameParameterData TypeRequiredDescription
IdformstringNoThe ID of this node. Must be unique within the flow but can be anything
IsStartNodeformboolNoIs this the starting node for the flow. Only one node can have this set
NameformstringNoThe name of the node, descriptive to be used as a reminder in the GUI
SpecformFlowNodeSpecNoThe specification for the node
UIformFlowNodeUINoThe UI data for the node
ParametersformNodeParameterMapNoThe data for this node. These will be POST'd to the endpoint when it is called.
FlowNodeSpec Parameters:
NameParameterData TypeRequiredDescription
NameformstringNoThe name of this node
DescriptionformstringNoA description of this node
IconClassformstringNoIcon class for this node (FontAwesome)
TypeNameformstringNoThe type name for this node
CategoryformFlowNodeCategoriesNoThe category this node should be grouped under
UrlformstringNoThe URL where this node is located
DataTypeformDataTypeNoThe data type for this node
DocumentationUrlformstringNoURL for documentation for this node
RestrictToChannelsformList<FlowChannels>NoThe channels that this node is restricted to
FlowNodeCategories Enum:
General
Voice
Logic
DateAndTime
Audio
Messaging
Assistant
Flows
Fax
Network
Cookies
CallCenter
Intelligence
DataType Parameters:
NameParameterData TypeRequiredDescription
TypeNameformstringNo
FieldsformList<DataField>No
DataField Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
NameformstringNo
TypeformValueTypesNo
UIHintformUIHintsNo
UITabformstringNo
IsAsyncformboolNo
DisableBindingformboolNo
StructTypeformDataTypeNo
ListTypeformDataTypeNo
DescriptionformstringNo
PossibleValuesformList<string>No
IsOutputformboolNo
CustomFieldValuesUrlformstringNo
DefaultValueformValueNo
TransitionNameFormatformstringNo
UniquenessformDataFieldUniquenessNo
VoiceOnlyformboolNo
ConditionalVisibilityFieldformstringNo
ConditionalVisibilityValueformstringNo
NoEvalTemplateformboolNo
UserModeformUserDataFieldModesNo
AnyValueTypeformboolNo
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:
NameParameterData TypeRequiredDescription
BoolValueformbool?No
StringValueformstringNo
NumberValueformdouble?No
ListValueformList<Struct>No
StructValueformStructNo
DataFieldUniqueness Enum:
NotUnique
Unique
UniqueToCustomer
UserDataFieldModes Enum:
Hidden
ReadOnly
ReadWrite
FlowChannels Enum:
Voice
Chat
Fax
FlowNodeUI Parameters:
NameParameterData TypeRequiredDescription
XformdoubleNoThe X position of the node
YformdoubleNoThe Y position of the node
NotesformstringNoNotes for this node
NodeParameter Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
TypeformValueTypesNo
SourceformValueSourcesNo
IsAsyncformboolNo
ReferenceIdformstringNo
ValueformValueNo
NoEvalTemplateformboolNo
ListParametersformList<NodeParameterMap>No
StructParametersformNodeParameterMapNo
IsOutputformboolNo
ExpressionformstringNo
ListTypeformDataTypeNo
ValueSources Enum:
Value
Flow
System
Customer
Session
Endpoint
Expression
User
FlowParameter Parameters:
NameParameterData TypeRequiredDescription
IsPublicformboolNo
IsKnobformboolNo
FlowExit Parameters:
NameParameterData TypeRequiredDescription
IdformstringNoThe unique ID for this exit
NameformstringNoThe name of this exit
UIformFlowNodeUINoThe UI for the exit
FlowUI Parameters:
NameParameterData TypeRequiredDescription
SelectedNodeformstringNo
CanvasXformdoubleNo
CanvasYformdoubleNo
CanvasZoomformdoubleNo
Tag Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
NameformstringNo
ColorformTagColorsNo
TagColors Enum:
Magenta
Red
Volcano
Orange
Gold
Lime
Green
Cyan
Blue
GeekBlue
Purple

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /flows/{flowId}/copy HTTP/1.1 
Host: team.evovoice.io 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"flowId":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"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"}