Evo Voice

<back to all web services

ListAutoCompleteValues

"use strict";
export class AutoCompleteValue {
    /** @param {{displayName?:string,value?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Display name */
    displayName;
    /**
     * @type {string}
     * @description Value */
    value;
}
export class ListAutoCompleteValuesResponse {
    /** @param {{values?:AutoCompleteValue[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {AutoCompleteValue[]} */
    values;
}
/** @typedef {'NotSpecified'|'String'|'Boolean'|'Number'|'List'|'Struct'|'Transition'|'Custom'|'Date'|'AudioFile'|'TimeZoneId'|'PhoneNumber'|'User'|'Endpoint'|'Time'|'File'|'FaxNumber'|'EmailAccount'|'Customer'|'Flow'|'Team'|'FlowReference'|'Integration'|'Assistant'} */
export var ValueTypes;
(function (ValueTypes) {
    ValueTypes["NotSpecified"] = "NotSpecified"
    ValueTypes["String"] = "String"
    ValueTypes["Boolean"] = "Boolean"
    ValueTypes["Number"] = "Number"
    ValueTypes["List"] = "List"
    ValueTypes["Struct"] = "Struct"
    ValueTypes["Transition"] = "Transition"
    ValueTypes["Custom"] = "Custom"
    ValueTypes["Date"] = "Date"
    ValueTypes["AudioFile"] = "AudioFile"
    ValueTypes["TimeZoneId"] = "TimeZoneId"
    ValueTypes["PhoneNumber"] = "PhoneNumber"
    ValueTypes["User"] = "User"
    ValueTypes["Endpoint"] = "Endpoint"
    ValueTypes["Time"] = "Time"
    ValueTypes["File"] = "File"
    ValueTypes["FaxNumber"] = "FaxNumber"
    ValueTypes["EmailAccount"] = "EmailAccount"
    ValueTypes["Customer"] = "Customer"
    ValueTypes["Flow"] = "Flow"
    ValueTypes["Team"] = "Team"
    ValueTypes["FlowReference"] = "FlowReference"
    ValueTypes["Integration"] = "Integration"
    ValueTypes["Assistant"] = "Assistant"
})(ValueTypes || (ValueTypes = {}));
export class ListAutoCompleteValues {
    /** @param {{accountId?:string,customerId?:string,type?:ValueTypes,query?:string,typeSpecificFilter?:string,value?:string,plainText?:boolean,fullInfo?:boolean,all?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Account ID */
    accountId;
    /**
     * @type {string}
     * @description Filter by customer ID */
    customerId;
    /**
     * @type {ValueTypes}
     * @description The type of value */
    type;
    /**
     * @type {string}
     * @description The query text to search for */
    query;
    /**
     * @type {string}
     * @description Type specific filter */
    typeSpecificFilter;
    /**
     * @type {string}
     * @description The value to search for (will only return one result) */
    value;
    /**
     * @type {boolean}
     * @description Should the results be sent back in plain text or with embedded HTML? */
    plainText;
    /**
     * @type {boolean}
     * @description Include full info? */
    fullInfo;
    /**
     * @type {boolean}
     * @description List all values, only use for small lists. */
    all;
}

JavaScript ListAutoCompleteValues DTOs

POST /ui/autocomplete/values HTTP/1.1 
Host: team.evovoice.io 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ListAutoCompleteValues xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.UI">
  <AccountId>String</AccountId>
  <All>false</All>
  <CustomerId>String</CustomerId>
  <FullInfo>false</FullInfo>
  <PlainText>false</PlainText>
  <Query>String</Query>
  <Type>NotSpecified</Type>
  <TypeSpecificFilter>String</TypeSpecificFilter>
  <Value>String</Value>
</ListAutoCompleteValues>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ListAutoCompleteValuesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.UI">
  <Values>
    <AutoCompleteValue>
      <DisplayName>String</DisplayName>
      <Value>String</Value>
    </AutoCompleteValue>
  </Values>
</ListAutoCompleteValuesResponse>