Evo Voice

<back to all web services

GetParameterFieldNames

Gets the possible field names for a specified value source

Requires Authentication
Requires any of the roles:SystemAdministrator, Manager, Customer
The following routes are available for this service:
GET/flows/parameters
GetParameterFieldNames Parameters:
NameParameterData TypeRequiredDescription
AccountIdquerystringNoThe account ID associated with the flow
ExcludeBuiltInFieldsqueryboolNoExclude built in fields like customer name
GetParameterFieldNamesResponse Parameters:
NameParameterData TypeRequiredDescription
CustomerformList<GetParameterField>No
SystemformList<GetParameterField>No
SessionformList<GetParameterField>No
EndpointformList<GetParameterField>No
UserformList<GetParameterField>No
GetParameterField Parameters:
NameParameterData TypeRequiredDescription
FieldNameformstringNo
ValueTypeformValueTypesNo
FieldformDataFieldNo
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
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
UIHints Enum:
None
LargeText
InlineForm
Password
InlineStruct
DataType Parameters:
NameParameterData TypeRequiredDescription
TypeNameformstringNo
FieldsformList<DataField>No
Value Parameters:
NameParameterData TypeRequiredDescription
BoolValueformbool?No
StringValueformstringNo
NumberValueformdouble?No
ListValueformList<Struct>No
StructValueformStructNo
DataFieldUniqueness Enum:
NotUnique
Unique
UniqueToCustomer
UserDataFieldModes Enum:
Hidden
ReadOnly
ReadWrite

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

HTTP + CSV

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: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"customer":[{"fieldName":"String","valueType":"NotSpecified"}],"system":[{"fieldName":"String","valueType":"NotSpecified"}],"session":[{"fieldName":"String","valueType":"NotSpecified"}],"endpoint":[{"fieldName":"String","valueType":"NotSpecified"}],"user":[{"fieldName":"String","valueType":"NotSpecified"}]}