All Verbs | /ui/autocomplete/values |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
AccountId | query | string | No | Account ID |
CustomerId | query | string | No | Filter by customer ID |
Type | query | ValueTypes | No | The type of value |
Query | query | string | No | The query text to search for |
TypeSpecificFilter | query | string | No | Type specific filter |
Value | query | string | No | The value to search for (will only return one result) |
PlainText | query | bool | No | Should the results be sent back in plain text or with embedded HTML? |
FullInfo | query | bool | No | Include full info? |
All | query | bool | No | List all values, only use for small lists. |
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 |
---|---|---|---|---|
Values | form | List<AutoCompleteValue> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
DisplayName | form | string | No | Display name |
Value | form | string | No | Value |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /ui/autocomplete/values HTTP/1.1
Host: team.evovoice.io
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"accountId":"String","customerId":"String","type":"NotSpecified","query":"String","typeSpecificFilter":"String","value":"String","plainText":false,"fullInfo":false,"all":false}
HTTP/1.1 200 OK Content-Type: text/csv Content-Length: length {"values":[{"displayName":"String","value":"String"}]}