| Requires any of the roles: | SystemAdministrator, Manager, Customer |
| POST | /flows/{flowId}/copy |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| FlowId | path | string | No | The ID of the flow to copy |
| 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 |
| 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 |
| UI | |
| Reference | |
| PhoneNumberRouting | |
| UserDialOut | |
| FaxNumberRouting |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | string | No | |
| Name | form | string | No |
| 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. |
| 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 |
| General | |
| Voice | |
| Logic | |
| DateAndTime | |
| Audio | |
| Messaging | |
| Assistant | |
| Flows | |
| Fax | |
| Network | |
| Cookies | |
| CallCenter | |
| Intelligence |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| TypeName | form | string | No | |
| Fields | form | List<DataField> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| 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 |
| NotSpecified | |
| String | |
| Boolean | |
| Number | |
| List | |
| Struct | |
| Transition | |
| Custom | |
| Date | |
| AudioFile | |
| TimeZoneId | |
| PhoneNumber | |
| User | |
| Endpoint | |
| Time | |
| File | |
| FaxNumber | |
| EmailAccount | |
| Customer | |
| Flow | |
| Team | |
| FlowReference | |
| Integration | |
| Assistant |
| None | |
| LargeText | |
| InlineForm | |
| Password | |
| InlineStruct |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| BoolValue | form | bool? | No | |
| StringValue | form | string | No | |
| NumberValue | form | double? | No | |
| ListValue | form | List<Struct> | No | |
| StructValue | form | Struct | No |
| NotUnique | |
| Unique | |
| UniqueToCustomer |
| Hidden | |
| ReadOnly | |
| ReadWrite |
| Voice | |
| Chat | |
| Fax |
| 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 |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| 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 |
| Value | |
| Flow | |
| System | |
| Customer | |
| Session | |
| Endpoint | |
| Expression | |
| User |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| IsPublic | form | bool | No | |
| IsKnob | form | bool | No |
| 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 |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SelectedNode | form | string | No | |
| CanvasX | form | double | No | |
| CanvasY | form | double | No | |
| CanvasZoom | form | double | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | string | No | |
| Name | form | string | No | |
| Color | form | TagColors | No |
| 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 .xml suffix or ?format=xml
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: evovoice.io
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<CopyFlow xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Flows">
<FlowId>String</FlowId>
</CopyFlow>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<FlowInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Flows">
<CreatedBy xmlns="http://schemas.datacontract.org/2004/07/Voice.Api">String</CreatedBy>
<DateCreated xmlns="http://schemas.datacontract.org/2004/07/Voice.Api">String</DateCreated>
<DateLastModified xmlns="http://schemas.datacontract.org/2004/07/Voice.Api">String</DateLastModified>
<Id xmlns="http://schemas.datacontract.org/2004/07/Voice.Api">String</Id>
<LastModifiedBy xmlns="http://schemas.datacontract.org/2004/07/Voice.Api">String</LastModifiedBy>
<AccountId>String</AccountId>
<AccountName>String</AccountName>
<CustomerBreadcrumb xmlns:d2p1="http://schemas.datacontract.org/2004/07/Voice.Api.Customers">
<d2p1:CustomerBreadcrumb>
<d2p1:Id>String</d2p1:Id>
<d2p1:Name>String</d2p1:Name>
</d2p1:CustomerBreadcrumb>
</CustomerBreadcrumb>
<CustomerId>String</CustomerId>
<CustomerName>String</CustomerName>
<Description>String</Description>
<Exits>
<FlowExit>
<Id>String</Id>
<Name>String</Name>
<UI>
<Notes>String</Notes>
<X>0</X>
<Y>0</Y>
</UI>
</FlowExit>
</Exits>
<Name>String</Name>
<NodeCount>0</NodeCount>
<Nodes>
<FlowNode>
<Id>String</Id>
<IsStartNode>false</IsStartNode>
<Name>String</Name>
<Parameters xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:KeyValueOfstringNodeParameteripFhVFNS>
<d4p1:Key>String</d4p1:Key>
<d4p1:Value i:nil="true" />
</d4p1:KeyValueOfstringNodeParameteripFhVFNS>
</Parameters>
<Spec>
<Category>General</Category>
<DataType xmlns:d5p1="http://schemas.datacontract.org/2004/07/Voice.Api.Flows.Data" i:nil="true" />
<Description>String</Description>
<DocumentationUrl>String</DocumentationUrl>
<IconClass>String</IconClass>
<Name>String</Name>
<RestrictToChannels>
<FlowChannels>Voice</FlowChannels>
</RestrictToChannels>
<TypeName>String</TypeName>
<Url>String</Url>
</Spec>
<UI>
<Notes>String</Notes>
<X>0</X>
<Y>0</Y>
</UI>
</FlowNode>
</Nodes>
<Notes>String</Notes>
<Parameters>
<FlowParameter>
<AnyValueType xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Flows.Data">false</AnyValueType>
<ConditionalVisibilityField xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Flows.Data">String</ConditionalVisibilityField>
<ConditionalVisibilityValue xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Flows.Data">String</ConditionalVisibilityValue>
<CustomFieldValuesUrl xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Flows.Data">String</CustomFieldValuesUrl>
<DefaultValue xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Flows.Data">
<BoolValue>false</BoolValue>
<ListValue xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:ArrayOfKeyValueOfstringValue8Ahp2kgT i:nil="true" />
</ListValue>
<NumberValue>0</NumberValue>
<StringValue>String</StringValue>
<StructValue xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
</DefaultValue>
<Description xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Flows.Data">String</Description>
<DisableBinding xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Flows.Data">false</DisableBinding>
<Id xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Flows.Data">String</Id>
<IsAsync xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Flows.Data">false</IsAsync>
<IsOutput xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Flows.Data">false</IsOutput>
<ListType i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Flows.Data" />
<Name xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Flows.Data">String</Name>
<NoEvalTemplate xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Flows.Data">false</NoEvalTemplate>
<PossibleValues xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Flows.Data">
<d4p1:string>String</d4p1:string>
</PossibleValues>
<StructType i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Flows.Data" />
<TransitionNameFormat xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Flows.Data">String</TransitionNameFormat>
<Type xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Flows.Data">NotSpecified</Type>
<UIHint xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Flows.Data">None</UIHint>
<UITab xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Flows.Data">String</UITab>
<Uniqueness xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Flows.Data">NotUnique</Uniqueness>
<UserMode xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Flows.Data">Hidden</UserMode>
<VoiceOnly xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Flows.Data">false</VoiceOnly>
<IsKnob>false</IsKnob>
<IsPublic>false</IsPublic>
</FlowParameter>
</Parameters>
<Roles>
<FlowRoles>UI</FlowRoles>
</Roles>
<Tags xmlns:d2p1="http://schemas.datacontract.org/2004/07/Voice.Api.Settings">
<d2p1:Tag>
<d2p1:Color>Magenta</d2p1:Color>
<d2p1:Id>String</d2p1:Id>
<d2p1:Name>String</d2p1:Name>
</d2p1:Tag>
</Tags>
<UI>
<CanvasX>0</CanvasX>
<CanvasY>0</CanvasY>
<CanvasZoom>0</CanvasZoom>
<SelectedNode>String</SelectedNode>
</UI>
</FlowInfo>