Requires any of the roles: | SystemAdministrator, Manager, Customer |
GET | /flows/parameters |
---|
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Voice.Api.Flows
Imports Voice.Api.Flows.Data
Imports Voice.Api.Endpoints
Namespace Global
Namespace Voice.Api.Endpoints
Public Enum UserDataFieldModes
Hidden
[ReadOnly]
ReadWrite
End Enum
End Namespace
Namespace Voice.Api.Flows
Public Partial Class GetParameterField
Public Overridable Property FieldName As String
Public Overridable Property ValueType As ValueTypes
Public Overridable Property Field As DataField
End Class
'''<Summary>
'''Gets the possible field names for a specified value source
'''</Summary>
<Api(Description:="Gets the possible field names for a specified value source")>
Public Partial Class GetParameterFieldNames
Implements IGet
'''<Summary>
'''The account ID associated with the flow
'''</Summary>
<ApiMember(Description:="The account ID associated with the flow")>
Public Overridable Property AccountId As String
'''<Summary>
'''Exclude built in fields like customer name
'''</Summary>
<ApiMember(Description:="Exclude built in fields like customer name")>
Public Overridable Property ExcludeBuiltInFields As Boolean
End Class
Public Partial Class GetParameterFieldNamesResponse
Public Overridable Property Customer As List(Of GetParameterField)
Public Overridable Property System As List(Of GetParameterField)
Public Overridable Property Session As List(Of GetParameterField)
Public Overridable Property Endpoint As List(Of GetParameterField)
Public Overridable Property User As List(Of GetParameterField)
End Class
End Namespace
Namespace Voice.Api.Flows.Data
Public Partial Class DataField
Public Overridable Property Id As String
Public Overridable Property Name As String
Public Overridable Property Type As ValueTypes
Public Overridable Property UIHint As UIHints
Public Overridable Property UITab As String
Public Overridable Property IsAsync As Boolean
Public Overridable Property DisableBinding As Boolean
Public Overridable Property StructType As DataType
Public Overridable Property ListType As DataType
Public Overridable Property Description As String
Public Overridable Property PossibleValues As List(Of String)
Public Overridable Property IsOutput As Boolean
Public Overridable Property CustomFieldValuesUrl As String
Public Overridable Property DefaultValue As Value
Public Overridable Property TransitionNameFormat As String
Public Overridable Property Uniqueness As DataFieldUniqueness
Public Overridable Property VoiceOnly As Boolean
Public Overridable Property ConditionalVisibilityField As String
Public Overridable Property ConditionalVisibilityValue As String
Public Overridable Property NoEvalTemplate As Boolean
Public Overridable Property UserMode As UserDataFieldModes
Public Overridable Property AnyValueType As Boolean
End Class
Public Enum DataFieldUniqueness
NotUnique
Unique
UniqueToCustomer
End Enum
Public Partial Class DataType
Public Overridable Property TypeName As String
Public Overridable Property Fields As List(Of DataField)
End Class
Public Partial Class Struct
Inherits Dictionary(Of String, Value)
End Class
Public Enum UIHints
None
LargeText
InlineForm
Password
InlineStruct
End Enum
Public Partial Class Value
Public Overridable Property BoolValue As Boolean?
Public Overridable Property StringValue As String
Public Overridable Property NumberValue As Double?
Public Overridable Property ListValue As List(Of Struct)
Public Overridable Property StructValue As Struct
End Class
Public Enum 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
End Enum
End Namespace
End Namespace
VB.NET GetParameterFieldNames DTOs
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/parameters HTTP/1.1 Host: team.evovoice.io Accept: application/xml
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <GetParameterFieldNamesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Flows"> <Customer> <GetParameterField> <Field xmlns:d4p1="http://schemas.datacontract.org/2004/07/Voice.Api.Flows.Data" i:nil="true" /> <FieldName>String</FieldName> <ValueType>NotSpecified</ValueType> </GetParameterField> </Customer> <Endpoint> <GetParameterField> <Field xmlns:d4p1="http://schemas.datacontract.org/2004/07/Voice.Api.Flows.Data" i:nil="true" /> <FieldName>String</FieldName> <ValueType>NotSpecified</ValueType> </GetParameterField> </Endpoint> <Session> <GetParameterField> <Field xmlns:d4p1="http://schemas.datacontract.org/2004/07/Voice.Api.Flows.Data" i:nil="true" /> <FieldName>String</FieldName> <ValueType>NotSpecified</ValueType> </GetParameterField> </Session> <System> <GetParameterField> <Field xmlns:d4p1="http://schemas.datacontract.org/2004/07/Voice.Api.Flows.Data" i:nil="true" /> <FieldName>String</FieldName> <ValueType>NotSpecified</ValueType> </GetParameterField> </System> <User> <GetParameterField> <Field xmlns:d4p1="http://schemas.datacontract.org/2004/07/Voice.Api.Flows.Data" i:nil="true" /> <FieldName>String</FieldName> <ValueType>NotSpecified</ValueType> </GetParameterField> </User> </GetParameterFieldNamesResponse>