Evo Voice

<back to all web services

AppGetSystemSettings

Requires Authentication
The following routes are available for this service:
All Verbs/portal/system-settings
AppGetSystemSettings Parameters:
NameParameterData TypeRequiredDescription
AccountIdquerystringNo
CustomerIdquerystringNo
AppSystemSettingsInfo Parameters:
NameParameterData TypeRequiredDescription
EndpointFieldsformList<EndpointDataField>No
IsHostedSuiteCustomerformboolNoIs this customer a HostedSuite customer?
CustomerTimeZoneIdformstringNoThe customer's time zone
EndpointDataField Parameters:
NameParameterData TypeRequiredDescription
ShowInSearchformboolNo
ShowInListsformboolNo
EndpointTypeformEndpointTypes?No
IsCallerIdformboolNo
IsKnobformboolNo
DataField Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
NameformstringNo
TypeformValueTypesNo
UIHintformUIHintsNo
UITabformstringNo
IsAsyncformboolNo
DisableBindingformboolNo
StructTypeformDataTypeNo
ListTypeformDataTypeNo
DescriptionformstringNo
PossibleValuesformList<string>No
IsOutputformboolNo
CustomFieldValuesUrlformstringNo
DefaultValueformValueNo
TransitionNameFormatformstringNo
UniquenessformDataFieldUniquenessNo
VoiceOnlyformboolNo
ConditionalVisibilityFieldformstringNo
ConditionalVisibilityValueformstringNo
NoEvalTemplateformboolNo
UserModeformUserDataFieldModesNo
AnyValueTypeformboolNo
ValueTypes Enum:
NotSpecified
String
Boolean
Number
List
Struct
Transition
Custom
Date
AudioFile
TimeZoneId
PhoneNumber
User
Endpoint
Time
File
FaxNumber
EmailAccount
Customer
Flow
Team
FlowReference
Integration
Assistant
UIHints Enum:
None
LargeText
InlineForm
Password
InlineStruct
DataType Parameters:
NameParameterData TypeRequiredDescription
TypeNameformstringNo
FieldsformList<DataField>No
Value Parameters:
NameParameterData TypeRequiredDescription
BoolValueformbool?No
StringValueformstringNo
NumberValueformdouble?No
ListValueformList<Struct>No
StructValueformStructNo
DataFieldUniqueness Enum:
NotUnique
Unique
UniqueToCustomer
UserDataFieldModes Enum:
Hidden
ReadOnly
ReadWrite
EndpointTypes Enum:
PhoneNumber
User
FaxNumber
EmailAddress
Unused_1
Unused_2
Unused_3
Unused_4
Unused_5
Team
Assistant

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

HTTP + JSV

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/jsv
Content-Type: text/jsv
Content-Length: length

{
	accountId: String,
	customerId: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
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
}