| Requires any of the roles: | SystemAdministrator, Manager, Customer |
| GET | /flows |
|---|
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*
/**
* Lists all the flows
*/
@Api(Description="Lists all the flows")
open class ListFlows : ListRequest<FlowInfo>()
{
/**
* Filter by accounts
*/
@ApiMember(Description="Filter by accounts")
open var accountIds:ArrayList<String>? = null
/**
* The IDs of the customers whose flows you want to retrieve
*/
@ApiMember(Description="The IDs of the customers whose flows you want to retrieve")
open var customerIds:ArrayList<String>? = null
/**
* Filter by name
*/
@ApiMember(Description="Filter by name")
open var nameFilter:String? = null
/**
* The list of tag IDs to filter by (must contain all)
*/
@ApiMember(Description="The list of tag IDs to filter by (must contain all)")
open var tagIds:ArrayList<String>? = null
/**
* List flows by specific role
*/
@ApiMember(Description="List flows by specific role")
open var role:FlowRoles? = null
/**
* Exclude nodes
*/
@ApiMember(Description="Exclude nodes")
open var includeNodes:Boolean? = null
/**
* Node Type Filter
*/
@ApiMember(Description="Node Type Filter")
open var nodeTypeFilter:String? = null
}
open class ListRequest<T> : IGet
{
/**
* The page of data to retrieve
*/
@ApiMember(Description="The page of data to retrieve")
open var page:Int? = null
/**
* If you want all objects to be returned. This should be used with care
*/
@ApiMember(Description="If you want all objects to be returned. This should be used with care")
open var all:Boolean? = null
/**
* The number per page to retrieve
*/
@ApiMember(Description="The number per page to retrieve")
open var countPerPage:Int? = null
/**
* Specific IDs
*/
@ApiMember(Description="Specific IDs")
open var specificIds:ArrayList<String>? = null
/**
* Specify a sort field
*/
@ApiMember(Description="Specify a sort field")
open var sortField:String? = null
/**
* Specify a sort order
*/
@ApiMember(Description="Specify a sort order")
open var sortOrder:SortOrders? = null
/**
* Disables total / page counts - improves performance. Returns only data. If there is no more data, Items will be empty array
*/
@ApiMember(Description="Disables total / page counts - improves performance. Returns only data. If there is no more data, Items will be empty array")
open var simplifiedPaging:Boolean? = null
}
enum class SortOrders
{
Ascend,
Descend,
}
open class FlowInfo : EntityInfo()
{
/**
* The name of this flow
*/
@ApiMember(Description="The name of this flow")
open var name:String? = null
/**
* The roles that this flow has
*/
@ApiMember(Description="The roles that this flow has")
open var roles:ArrayList<FlowRoles>? = null
/**
* What this flow does
*/
@ApiMember(Description="What this flow does")
open var description:String? = null
/**
* Any notes for this flow
*/
@ApiMember(Description="Any notes for this flow")
open var notes:String? = null
/**
* The ID of the account associated with the flow
*/
@ApiMember(Description="The ID of the account associated with the flow")
open var accountId:String? = null
/**
* The name of the account associated with the flow
*/
@ApiMember(Description="The name of the account associated with the flow")
open var accountName:String? = null
/**
* The ID of the customer this flow is associated with
*/
@ApiMember(Description="The ID of the customer this flow is associated with")
open var customerId:String? = null
/**
* The name of the customer this flow is associated with
*/
@ApiMember(Description="The name of the customer this flow is associated with")
open var customerName:String? = null
/**
* The breadcrumb to the flow for this endpoint
*/
@ApiMember(Description="The breadcrumb to the flow for this endpoint")
open var customerBreadcrumb:ArrayList<CustomerBreadcrumb>? = null
/**
* The nodes in this flow
*/
@ApiMember(Description="The nodes in this flow")
open var nodes:ArrayList<FlowNode>? = null
/**
* The flow's parameters
*/
@ApiMember(Description="The flow's parameters")
open var parameters:ArrayList<FlowParameter>? = null
/**
* The flow's exits
*/
@ApiMember(Description="The flow's exits")
open var exits:ArrayList<FlowExit>? = null
/**
* The UI data for the flow
*/
@ApiMember(Description="The UI data for the flow")
open var ui:FlowUI? = null
/**
* The list of tags for this flow
*/
@ApiMember(Description="The list of tags for this flow")
open var tags:ArrayList<Tag>? = null
/**
* The number of nodes in this flow
*/
@ApiMember(Description="The number of nodes in this flow")
open var nodeCount:Int? = null
}
open class EntityInfo
{
/**
* The ID of the object
*/
@ApiMember(Description="The ID of the object")
open var id:String? = null
/**
* The date the object was created
*/
@ApiMember(Description="The date the object was created")
open var dateCreated:String? = null
/**
* The date the object was last modified
*/
@ApiMember(Description="The date the object was last modified")
open var dateLastModified:String? = null
/**
* The user that created this object
*/
@ApiMember(Description="The user that created this object")
open var createdBy:String? = null
/**
* The user that last modified this object
*/
@ApiMember(Description="The user that last modified this object")
open var lastModifiedBy:String? = null
}
enum class FlowRoles
{
Ui,
Reference,
PhoneNumberRouting,
UserDialOut,
FaxNumberRouting,
}
open class CustomerBreadcrumb
{
open var id:String? = null
open var name:String? = null
}
open class FlowNode
{
/**
* The ID of this node. Must be unique within the flow but can be anything
*/
@ApiMember(Description="The ID of this node. Must be unique within the flow but can be anything")
open var id:String? = null
/**
* Is this the starting node for the flow. Only one node can have this set
*/
@ApiMember(Description="Is this the starting node for the flow. Only one node can have this set")
open var isStartNode:Boolean? = null
/**
* The name of the node, descriptive to be used as a reminder in the GUI
*/
@ApiMember(Description="The name of the node, descriptive to be used as a reminder in the GUI")
open var name:String? = null
/**
* The specification for the node
*/
@ApiMember(Description="The specification for the node")
open var spec:FlowNodeSpec? = null
/**
* The UI data for the node
*/
@ApiMember(Description="The UI data for the node")
open var ui:FlowNodeUI? = null
/**
* The data for this node. These will be POST'd to the endpoint when it is called.
*/
@ApiMember(Description="The data for this node. These will be POST'd to the endpoint when it is called.")
open var parameters:NodeParameterMap? = null
}
open class FlowNodeSpec
{
/**
* The name of this node
*/
@ApiMember(Description="The name of this node")
open var name:String? = null
/**
* A description of this node
*/
@ApiMember(Description="A description of this node")
open var description:String? = null
/**
* Icon class for this node (FontAwesome)
*/
@ApiMember(Description="Icon class for this node (FontAwesome)")
open var iconClass:String? = null
/**
* The type name for this node
*/
@ApiMember(Description="The type name for this node")
open var typeName:String? = null
/**
* The category this node should be grouped under
*/
@ApiMember(Description="The category this node should be grouped under")
open var category:FlowNodeCategories? = null
/**
* The URL where this node is located
*/
@ApiMember(Description="The URL where this node is located")
open var url:String? = null
/**
* The data type for this node
*/
@ApiMember(Description="The data type for this node")
open var dataType:DataType? = null
/**
* URL for documentation for this node
*/
@ApiMember(Description="URL for documentation for this node")
open var documentationUrl:String? = null
/**
* The channels that this node is restricted to
*/
@ApiMember(Description="The channels that this node is restricted to")
open var restrictToChannels:ArrayList<FlowChannels>? = null
}
enum class FlowNodeCategories
{
General,
Voice,
Logic,
DateAndTime,
Audio,
Messaging,
Assistant,
Flows,
Fax,
Network,
Cookies,
CallCenter,
Intelligence,
}
open class DataType
{
open var typeName:String? = null
open var fields:ArrayList<DataField>? = null
}
open class DataField
{
open var id:String? = null
open var name:String? = null
@SerializedName("type") open var Type:ValueTypes? = null
open var uiHint:UIHints? = null
open var uiTab:String? = null
open var isAsync:Boolean? = null
open var disableBinding:Boolean? = null
open var structType:DataType? = null
open var listType:DataType? = null
open var description:String? = null
open var possibleValues:ArrayList<String>? = null
open var isOutput:Boolean? = null
open var customFieldValuesUrl:String? = null
open var defaultValue:Value? = null
open var transitionNameFormat:String? = null
open var uniqueness:DataFieldUniqueness? = null
open var voiceOnly:Boolean? = null
open var conditionalVisibilityField:String? = null
open var conditionalVisibilityValue:String? = null
open var noEvalTemplate:Boolean? = null
open var userMode:UserDataFieldModes? = null
open var anyValueType:Boolean? = null
}
enum class ValueTypes
{
NotSpecified,
String,
Boolean,
Number,
List,
Struct,
Transition,
Custom,
Date,
AudioFile,
TimeZoneId,
PhoneNumber,
User,
Endpoint,
Time,
File,
FaxNumber,
EmailAccount,
Customer,
Flow,
Team,
FlowReference,
Integration,
Assistant,
}
enum class UIHints
{
None,
LargeText,
InlineForm,
Password,
InlineStruct,
}
open class Value
{
open var boolValue:Boolean? = null
open var stringValue:String? = null
open var numberValue:Double? = null
open var listValue:ArrayList<Struct>? = null
open var structValue:Struct? = null
}
open class Struct : HashMap<String,Value>()
{
}
enum class DataFieldUniqueness
{
NotUnique,
Unique,
UniqueToCustomer,
}
enum class UserDataFieldModes
{
Hidden,
ReadOnly,
ReadWrite,
}
enum class FlowChannels
{
Voice,
Chat,
Fax,
}
open class FlowNodeUI
{
/**
* The X position of the node
*/
@ApiMember(Description="The X position of the node")
open var x:Double? = null
/**
* The Y position of the node
*/
@ApiMember(Description="The Y position of the node")
open var y:Double? = null
/**
* Notes for this node
*/
@ApiMember(Description="Notes for this node")
open var notes:String? = null
}
open class NodeParameterMap : HashMap<String,NodeParameter>()
{
}
open class NodeParameter
{
open var id:String? = null
@SerializedName("type") open var Type:ValueTypes? = null
open var source:ValueSources? = null
open var isAsync:Boolean? = null
open var referenceId:String? = null
open var value:Value? = null
open var noEvalTemplate:Boolean? = null
open var listParameters:ArrayList<NodeParameterMap>? = null
open var structParameters:NodeParameterMap? = null
open var isOutput:Boolean? = null
open var expression:String? = null
open var listType:DataType? = null
}
enum class ValueSources
{
Value,
Flow,
System,
Customer,
Session,
Endpoint,
Expression,
User,
}
open class FlowParameter : DataField()
{
open var isPublic:Boolean? = null
open var isKnob:Boolean? = null
}
open class FlowExit
{
/**
* The unique ID for this exit
*/
@ApiMember(Description="The unique ID for this exit")
open var id:String? = null
/**
* The name of this exit
*/
@ApiMember(Description="The name of this exit")
open var name:String? = null
/**
* The UI for the exit
*/
@ApiMember(Description="The UI for the exit")
open var ui:FlowNodeUI? = null
}
open class FlowUI
{
open var selectedNode:String? = null
open var canvasX:Double? = null
open var canvasY:Double? = null
open var canvasZoom:Double? = null
}
open class Tag
{
open var id:String? = null
open var name:String? = null
open var color:TagColors? = null
}
enum class TagColors
{
Magenta,
Red,
Volcano,
Orange,
Gold,
Lime,
Green,
Cyan,
Blue,
GeekBlue,
Purple,
}
open class ListResponse<T>
{
/**
* The items
*/
@ApiMember(Description="The items")
open var items:ArrayList<AccountInfo>? = null
/**
* The total number of items
*/
@ApiMember(Description="The total number of items")
open var totalCount:Int? = null
/**
* The total number of pages
*/
@ApiMember(Description="The total number of pages")
open var totalPages:Int? = null
/**
* Are there more pages of items? Used with simplified paging
*/
@ApiMember(Description="Are there more pages of items? Used with simplified paging")
open var hasMorePages:Boolean? = null
}
open class AccountInfo : EntityInfo()
{
/**
* The name of this account
*/
@ApiMember(Description="The name of this account")
open var name:String? = null
/**
* The ID of this account's parent
*/
@ApiMember(Description="The ID of this account's parent")
open var parentAccountId:String? = null
/**
* The twilio account SID
*/
@ApiMember(Description="The twilio account SID")
open var twilioAccountSid:String? = null
/**
* The ancestors of this account. Useful for breadcrumbs
*/
@ApiMember(Description="The ancestors of this account. Useful for breadcrumbs")
open var ancestorIds:ArrayList<String>? = null
/**
* The max number of phone numbers this account can have
*/
@ApiMember(Description="The max number of phone numbers this account can have")
open var maxPhoneNumbers:Int? = null
/**
* This account is BYOA
*/
@ApiMember(Description="This account is BYOA")
open var isBYOA:Boolean? = null
/**
* TrustHub Profile Sid
*/
@ApiMember(Description="TrustHub Profile Sid")
open var trustHubProfileSid:String? = null
/**
* The ID of the logo file
*/
@ApiMember(Description="The ID of the logo file")
open var logoId:String? = null
/**
* The URI of the logo file
*/
@ApiMember(Description="The URI of the logo file")
open var logoUri:String? = null
/**
* The billing settings for this account
*/
@ApiMember(Description="The billing settings for this account")
open var billingSettings:BillingSettings? = null
}
open class BillingSettings
{
open var base:BillingItem? = null
open var localNumbers:BillingItem? = null
open var tollFreeNumbers:BillingItem? = null
open var inboundVoiceCalls:BillingItem? = null
open var outboundVoiceCalls:BillingItem? = null
open var inboundFaxes:BillingItem? = null
open var outboundFaxes:BillingItem? = null
open var inboundSmsMessages:BillingItem? = null
open var outboundSmsMessages:BillingItem? = null
open var aiInsights:BillingItem? = null
open var aiLiveMinutes:BillingItem? = null
}
open class BillingItem
{
open var baseCost:Double? = null
open var rawUnitMultiplier:Double? = null
open var unitCost:Double? = null
open var allowance:Int? = null
}
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.
GET /flows HTTP/1.1 Host: team.evovoice.io Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<ListResponseOfFlowInfoM153aFo_P xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Voice.Api">
<HasMorePages>false</HasMorePages>
<Items xmlns:d2p1="http://schemas.datacontract.org/2004/07/Voice.Api.Flows">
<d2p1:FlowInfo>
<CreatedBy>String</CreatedBy>
<DateCreated>String</DateCreated>
<DateLastModified>String</DateLastModified>
<Id>String</Id>
<LastModifiedBy>String</LastModifiedBy>
<d2p1:AccountId>String</d2p1:AccountId>
<d2p1:AccountName>String</d2p1:AccountName>
<d2p1:CustomerBreadcrumb xmlns:d4p1="http://schemas.datacontract.org/2004/07/Voice.Api.Customers">
<d4p1:CustomerBreadcrumb>
<d4p1:Id>String</d4p1:Id>
<d4p1:Name>String</d4p1:Name>
</d4p1:CustomerBreadcrumb>
</d2p1:CustomerBreadcrumb>
<d2p1:CustomerId>String</d2p1:CustomerId>
<d2p1:CustomerName>String</d2p1:CustomerName>
<d2p1:Description>String</d2p1:Description>
<d2p1:Exits>
<d2p1:FlowExit>
<d2p1:Id>String</d2p1:Id>
<d2p1:Name>String</d2p1:Name>
<d2p1:UI>
<d2p1:Notes>String</d2p1:Notes>
<d2p1:X>0</d2p1:X>
<d2p1:Y>0</d2p1:Y>
</d2p1:UI>
</d2p1:FlowExit>
</d2p1:Exits>
<d2p1:Name>String</d2p1:Name>
<d2p1:NodeCount>0</d2p1:NodeCount>
<d2p1:Nodes>
<d2p1:FlowNode>
<d2p1:Id>String</d2p1:Id>
<d2p1:IsStartNode>false</d2p1:IsStartNode>
<d2p1:Name>String</d2p1:Name>
<d2p1:Parameters xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d6p1:KeyValueOfstringNodeParameteripFhVFNS>
<d6p1:Key>String</d6p1:Key>
<d6p1:Value i:nil="true" />
</d6p1:KeyValueOfstringNodeParameteripFhVFNS>
</d2p1:Parameters>
<d2p1:Spec>
<d2p1:Category>General</d2p1:Category>
<d2p1:DataType xmlns:d7p1="http://schemas.datacontract.org/2004/07/Voice.Api.Flows.Data" i:nil="true" />
<d2p1:Description>String</d2p1:Description>
<d2p1:DocumentationUrl>String</d2p1:DocumentationUrl>
<d2p1:IconClass>String</d2p1:IconClass>
<d2p1:Name>String</d2p1:Name>
<d2p1:RestrictToChannels>
<d2p1:FlowChannels>Voice</d2p1:FlowChannels>
</d2p1:RestrictToChannels>
<d2p1:TypeName>String</d2p1:TypeName>
<d2p1:Url>String</d2p1:Url>
</d2p1:Spec>
<d2p1:UI>
<d2p1:Notes>String</d2p1:Notes>
<d2p1:X>0</d2p1:X>
<d2p1:Y>0</d2p1:Y>
</d2p1:UI>
</d2p1:FlowNode>
</d2p1:Nodes>
<d2p1:Notes>String</d2p1:Notes>
<d2p1:Parameters>
<d2p1: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:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d7p1:ArrayOfKeyValueOfstringValue8Ahp2kgT i:nil="true" />
</ListValue>
<NumberValue>0</NumberValue>
<StringValue>String</StringValue>
<StructValue xmlns:d7p1="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:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Flows.Data">
<d6p1:string>String</d6p1: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>
<d2p1:IsKnob>false</d2p1:IsKnob>
<d2p1:IsPublic>false</d2p1:IsPublic>
</d2p1:FlowParameter>
</d2p1:Parameters>
<d2p1:Roles>
<d2p1:FlowRoles>UI</d2p1:FlowRoles>
</d2p1:Roles>
<d2p1:Tags xmlns:d4p1="http://schemas.datacontract.org/2004/07/Voice.Api.Settings">
<d4p1:Tag>
<d4p1:Color>Magenta</d4p1:Color>
<d4p1:Id>String</d4p1:Id>
<d4p1:Name>String</d4p1:Name>
</d4p1:Tag>
</d2p1:Tags>
<d2p1:UI>
<d2p1:CanvasX>0</d2p1:CanvasX>
<d2p1:CanvasY>0</d2p1:CanvasY>
<d2p1:CanvasZoom>0</d2p1:CanvasZoom>
<d2p1:SelectedNode>String</d2p1:SelectedNode>
</d2p1:UI>
</d2p1:FlowInfo>
</Items>
<TotalCount>0</TotalCount>
<TotalPages>0</TotalPages>
</ListResponseOfFlowInfoM153aFo_P>