Evo Voice

<back to all web services

GetParameterFieldNames

Gets the possible field names for a specified value source

using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Voice.Api.Flows;
using Voice.Api.Flows.Data;
using Voice.Api.Endpoints;

namespace Voice.Api.Endpoints
{
    public enum UserDataFieldModes
    {
        Hidden,
        ReadOnly,
        ReadWrite,
    }

}

namespace Voice.Api.Flows
{
    public partial class GetParameterField
    {
        public virtual string FieldName { get; set; }
        public virtual ValueTypes ValueType { get; set; }
        public virtual DataField Field { get; set; }
    }

    ///<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
        : IGet
    {
        ///<summary>
        ///The account ID associated with the flow
        ///</summary>
        [ApiMember(Description="The account ID associated with the flow")]
        public virtual string AccountId { get; set; }

        ///<summary>
        ///Exclude built in fields like customer name
        ///</summary>
        [ApiMember(Description="Exclude built in fields like customer name")]
        public virtual bool ExcludeBuiltInFields { get; set; }
    }

    public partial class GetParameterFieldNamesResponse
    {
        public virtual List<GetParameterField> Customer { get; set; }
        public virtual List<GetParameterField> System { get; set; }
        public virtual List<GetParameterField> Session { get; set; }
        public virtual List<GetParameterField> Endpoint { get; set; }
        public virtual List<GetParameterField> User { get; set; }
    }

}

namespace Voice.Api.Flows.Data
{
    public partial class DataField
    {
        public virtual string Id { get; set; }
        public virtual string Name { get; set; }
        public virtual ValueTypes Type { get; set; }
        public virtual UIHints UIHint { get; set; }
        public virtual string UITab { get; set; }
        public virtual bool IsAsync { get; set; }
        public virtual bool DisableBinding { get; set; }
        public virtual DataType StructType { get; set; }
        public virtual DataType ListType { get; set; }
        public virtual string Description { get; set; }
        public virtual List<string> PossibleValues { get; set; }
        public virtual bool IsOutput { get; set; }
        public virtual string CustomFieldValuesUrl { get; set; }
        public virtual Value DefaultValue { get; set; }
        public virtual string TransitionNameFormat { get; set; }
        public virtual DataFieldUniqueness Uniqueness { get; set; }
        public virtual bool VoiceOnly { get; set; }
        public virtual string ConditionalVisibilityField { get; set; }
        public virtual string ConditionalVisibilityValue { get; set; }
        public virtual bool NoEvalTemplate { get; set; }
        public virtual UserDataFieldModes UserMode { get; set; }
        public virtual bool AnyValueType { get; set; }
    }

    public enum DataFieldUniqueness
    {
        NotUnique,
        Unique,
        UniqueToCustomer,
    }

    public partial class DataType
    {
        public virtual string TypeName { get; set; }
        public virtual List<DataField> Fields { get; set; }
    }

    public partial class Struct
        : Dictionary<string, Value>
    {
    }

    public enum UIHints
    {
        None,
        LargeText,
        InlineForm,
        Password,
        InlineStruct,
    }

    public partial class Value
    {
        public virtual bool? BoolValue { get; set; }
        public virtual string StringValue { get; set; }
        public virtual double? NumberValue { get; set; }
        public virtual List<Struct> ListValue { get; set; }
        public virtual Struct StructValue { get; set; }
    }

    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,
    }

}

C# GetParameterFieldNames DTOs

GET /flows/parameters HTTP/1.1 
Host: team.evovoice.io 
Accept: application/json

HTTP/1.1 200 OK
Content-Type: application/json
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"}]}