Requires any of the roles: | SystemAdministrator, Manager, Customer |
GET | /flows/parameters |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
AccountId | query | string | No | The account ID associated with the flow |
ExcludeBuiltInFields | query | bool | No | Exclude built in fields like customer name |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Customer | form | List<GetParameterField> | No | |
System | form | List<GetParameterField> | No | |
Session | form | List<GetParameterField> | No | |
Endpoint | form | List<GetParameterField> | No | |
User | form | List<GetParameterField> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
FieldName | form | string | No | |
ValueType | form | ValueTypes | No | |
Field | form | DataField | 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 |
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 |
None | |
LargeText | |
InlineForm | |
Password | |
InlineStruct |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
TypeName | form | string | No | |
Fields | form | List<DataField> | No |
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 |
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
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/jsonl
HTTP/1.1 200 OK Content-Type: text/jsonl 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"}]}