Evo Voice

<back to all web services

AppGetSystemSettings

Requires Authentication
The following routes are available for this service:
All Verbs/portal/system-settings
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


open class AppGetSystemSettings
{
    open var accountId:String? = null
    open var customerId:String? = null
}

open class AppSystemSettingsInfo
{
    open var endpointFields:ArrayList<EndpointDataField>? = null
    /**
    * Is this customer a HostedSuite customer?
    */
    @ApiMember(Description="Is this customer a HostedSuite customer?")
    open var isHostedSuiteCustomer:Boolean? = null

    /**
    * The customer's time zone
    */
    @ApiMember(Description="The customer's time zone")
    open var customerTimeZoneId:String? = null
}

open class EndpointDataField : DataField()
{
    open var showInSearch:Boolean? = null
    open var showInLists:Boolean? = null
    open var endpointType:EndpointTypes? = null
    open var isCallerId:Boolean? = null
    open var isKnob:Boolean? = null
}

open class DataField
{
    open var id:String? = null
    open var name:String? = null
    @SerializedName("type") open var Type:ValueTypes? = null
    open var uiHint:UIHints? = null
    open var uiTab:String? = null
    open var isAsync:Boolean? = null
    open var disableBinding:Boolean? = null
    open var structType:DataType? = null
    open var listType:DataType? = null
    open var description:String? = null
    open var possibleValues:ArrayList<String>? = null
    open var isOutput:Boolean? = null
    open var customFieldValuesUrl:String? = null
    open var defaultValue:Value? = null
    open var transitionNameFormat:String? = null
    open var uniqueness:DataFieldUniqueness? = null
    open var voiceOnly:Boolean? = null
    open var conditionalVisibilityField:String? = null
    open var conditionalVisibilityValue:String? = null
    open var noEvalTemplate:Boolean? = null
    open var userMode:UserDataFieldModes? = null
    open var anyValueType:Boolean? = null
}

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

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

open class DataType
{
    open var typeName:String? = null
    open var fields:ArrayList<DataField>? = null
}

open class Value
{
    open var boolValue:Boolean? = null
    open var stringValue:String? = null
    open var numberValue:Double? = null
    open var listValue:ArrayList<Struct>? = null
    open var structValue:Struct? = null
}

open class Struct : HashMap<String,Value>()
{
}

enum class DataFieldUniqueness
{
    NotUnique,
    Unique,
    UniqueToCustomer,
}

enum class UserDataFieldModes
{
    Hidden,
    ReadOnly,
    ReadWrite,
}

enum class EndpointTypes
{
    PhoneNumber,
    User,
    FaxNumber,
    EmailAddress,
    Unused1,
    Unused2,
    Unused3,
    Unused4,
    Unused5,
    Team,
    Assistant,
}

Kotlin AppGetSystemSettings DTOs

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

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /portal/system-settings HTTP/1.1 
Host: team.evovoice.io 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"accountId":"String","customerId":"String"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"endpointFields":[{"showInSearch":false,"showInLists":false,"endpointType":"PhoneNumber","isCallerId":false,"isKnob":false,"id":"String","name":"String","type":"NotSpecified","uiHint":"None","uiTab":"String","isAsync":false,"disableBinding":false,"description":"String","possibleValues":["String"],"isOutput":false,"customFieldValuesUrl":"String","defaultValue":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[null]},"transitionNameFormat":"String","uniqueness":"NotUnique","voiceOnly":false,"conditionalVisibilityField":"String","conditionalVisibilityValue":"String","noEvalTemplate":false,"userMode":"Hidden","anyValueType":false}],"isHostedSuiteCustomer":false,"customerTimeZoneId":"String"}