Jump to: navigation, search

Domain

Nomenclature

Some types are marked as (K) for Key, (S) for Shallow, or (D) for Deep. Shallow items populate only select fields. To convert a key or a shallow object into a deep object (an object with all its fields populated) you invoke show<Type> on the object.

All domain objects are either Entity objects or State objects. Entity objects have a single external key, a single internal key, or both an external key and an internal key. External keys are identified as externalId, internal Keys are identified as internalId. If both an internal key and an external key are provided then the internal key will be used and the external key will be ignored.

Attributes

Domain objects consist of core attributes and an additional set of attributes that may be added to over time as the API evolves. The core attributes have a type managed by the XML schema and will generally be mapped to a language-specific type. The additional attributes are stored as an array of Attribute type. Each additional attribute may appear at most once in this array. This type consists of a name-value pair represented as strings. The contents of the value will follow the rules of the indicated type. For example, the additional attribute "size" on the list domain object is an integer represented as a string. All type to string transformations adhere to the rules outlined in the W3C XML Schema language.

Primitive Types

Primitive Data Types are as defined in the W3C XML Schema Language.

Integer

An integer between -2147483648 and 2147483647 inclusive; equivalent to Java's int primitive data type. This is in effect a nullable xsd:int.

Double

The double datatype is patterned after the IEEE double-precision 64-bit floating point type [IEEE 754-1985].

string (See xsd:string)

The schema equivalent of #PCDATA, any string of Unicode characters that may appear in an XML document.

Boolean

true, false, 1, 0.

This is in effect a nullable xsd:Boolean.

dateTime (See xsd:dateTime)

A particular moment of time on a particular day up to an arbitrary fraction of a second in the ISO 8601 format: CCYY-MM-DDThh:mm:ss. This can be suffixed with a Z to indicate coordinated universal time (UTC) or an offset from UTC. For example, Neil Armstrong set foot on the moon at 1969-07-20T21:28:00-06:00 by the clock in Houston mission control which is also known as 1969-07-21T02:28:00Z

date (See xsd:date)

A "date object" is an object with year, month, and day properties just like those of dateTime objects, plus an optional timezone-valued timezone property.

shortDuration

Number of milliseconds represented as an Integer.

Enumerated Types (See xsd:enumeration)

agentBridgeCriteria

Possible value: None, LiveParty, LivePartyAndAnsweringMachine, AllCalls

<simpleType name="agentBridgeCriteria" base="xsd:string">
	<xsd:enumeration value=" None "/>
	<xsd:enumeration value=" LiveParty"/>
	<xsd:enumeration value=" LivePartyAndAnsweringMachine"/>
	<xsd:enumeration value=" AllCalls"/>
</simpleType>

agentGroupStates

Possible value: Closed, Open, Unknown

<simpleType name="agentGroupStates" base="xsd:string">
	<xsd:enumeration value="Closed"/>
	<xsd:enumeration value="Open"/>
	<xsd:enumeration value="Unknown"/>
</simpleType>

agentGroupType

Possible value: Enhanced, Standard

<simpleType name="agentGroupType" base="xsd:string">
	<xsd:enumeration value="Enhanced"/>
	<xsd:enumeration value="Standard"/>
</simpleType>

agentWorkStates

Possible value: AfterContactWork, Available, AvailableUnassigned, Barging, Break, Busy, Coaching, Conference, FollowUp, Launching, Monitoring, PendingTransferOut, Previewing, Ringing, Skipping, TransferIn, TransferOut, Unavailable, Whisperr

<simpleType name="agentWorkStates" base="xsd:string">
<xsd:enumeration value="AfterContactWork"/>
	<xsd:enumeration value="Available"/>
	<xsd:enumeration value="AvailableUnassigned"/>
	<xsd:enumeration value="Barging"/>
	<xsd:enumeration value="Break"/>
	<xsd:enumeration value="Busy"/>
	<xsd:enumeration value="Coaching"/>
	<xsd:enumeration value="Conference"/>
	<xsd:enumeration value="FollowUp"/>
	<xsd:enumeration value="Launching"/>
	<xsd:enumeration value="Monitoring"/>
	<xsd:enumeration value="PendingTransferOut"/>
	<xsd:enumeration value="Previewing"/>
        <xsd:enumeration value="Ringing"/>
	<xsd:enumeration value="Skipping"/>
	<xsd:enumeration value="TransferIn"/>
	<xsd:enumeration value="TransferOut"/>
        <xsd:enumeration value="Unavailable"/>
        <xsd:enumeration value="Whisper"/>
</simpleType>

Application Types

Possible values:AgentVoicePortal, AgentTextPortal, Clicker

<simpleType name="ApplicationTypes" base="xsd:string">
	<xsd:enumeration value="AgentVoicePortal"/>
	<xsd:enumeration value="AgentTextPortal"/>
	<xsd:enumeration value="Clicker"/>
</simpleType>

attemptDetailType

Possible value: DirectConnect, Text, TextAgent, VoiceAgent

<simpleType name="attemptDetailType" base="xsd:string">
	<xsd:enumeration value="DirectConnect"/>
	<xsd:enumeration value="TextAgent"/>
	<xsd:enumeration value="Text"/>
	<xsd:enumeration value="VoiceAgent"/>
</simpleType>

callStates

Possible value: AnsweringMachine, BadNumber, Busy, Connected, Expired, NoAnswer, NotAttempted, NotConnected, Ringing, Skipped

<simpleType name="callStates" base="xsd:string">
	<xsd:enumeration value="AnsweringMachine"/>
	<xsd:enumeration value="BadNumber"/>
	<xsd:enumeration value="Busy"/>
	<xsd:enumeration value="Connected"/>
	<xsd:enumeration value="Expired"/>
	<xsd:enumeration value="NoAnswer"/>
	<xsd:enumeration value="NotAttempted"/>
	<xsd:enumeration value="NotConnected"/>
	<xsd:enumeration value="Ringing"/>
	<xsd:enumeration value="Skipped"/>
</simpleType>

categoryType

Possible value: ContactAttempt, Contact, Custom, ContactDevice

<simpleType name="categoryType" base="xsd:string">
	<xsd:enumeration value="ContactAttempt"/>
	<xsd:enumeration value="Contact"/>
	<xsd:enumeration value="Custom"/>
	<xsd:enumeration value="ContactDevice"/>
</simpleType>

ruleSetType

Possible value: Sequence, Filter

<simpleType name="ruleSetType" base="xsd:string">
	<xsd:enumeration value="Sequence"/>
	<xsd:enumeration value="Filter"/>
</simpleType>

ruleSetGroupType

Possible value: Sequence, Filter

<simpleType name="ruleSetGroupType" base="xsd:string">
	<xsd:enumeration value="Sequence"/>
	<xsd:enumeration value="Filter"/>
</simpleType>

channelType

Possible value: Dialer, Email, Manual, Preview, Text, Voice, Web

<simpleType name="channelType" base="xsd:string">
	<xsd:enumeration value="Dialer"/>
	<xsd:enumeration value="Email"/>
	<xsd:enumeration value="Manual"/>
	<xsd:enumeration value="Preview"/>
	<xsd:enumeration value="Text"/>
	<xsd:enumeration value="Voice"/>
	<xsd:enumeration value="Web"/>
	<xsd:enumeration value="Chat"/>
	<xsd:enumeration value="Social"/>
</simpleType>

completionStatus

Possible value: BadDevice, Busy, DeliveredMachine, DeliveredPerson, Failed, HangupOnMachine, NoAnswer, NotAttempted, NotAttemptedSkipped, NotConnected, Success, UndeliveredMachine

<simpleType name="completionStatus" base="xsd:string">
	<xsd:enumeration value="BadDevice"/>
	<xsd:enumeration value="Busy"/>
	<xsd:enumeration value="DeliveredMachine"/>
	<xsd:enumeration value="DeliveredPerson"/>
	<xsd:enumeration value="DeliveredWithoutSuccess"/>
	<xsd:enumeration value="Failed"/>
	<xsd:enumeration value="HangupOnMachine"/>
	<xsd:enumeration value="NoAnswer"/>
	<xsd:enumeration value="NotAttempted"/>
	<xsd:enumeration value="NotAttemptedSkipped"/>
	<xsd:enumeration value="NotConnected"/>
	<xsd:enumeration value="Success"/>
	<xsd:enumeration value="UndeliveredMachine"/>
</simpleType>

complianceRuleType

Possible value: AreaCode, Date, PostalCode, Region

<simpleType name="complianceRuleType" base="xsd:string">
	<xsd:enumeration value="AreaCode"/>
	<xsd:enumeration value="Date"/>
	<xsd:enumeration value="PostalCode"/>
	<xsd:enumeration value="Region"/>
</simpleType>

contactBatchSourceTypes

Possible value: Agent

<simpleType name="contactBatchSourceTypes" base="xsd:string">
	<xsd:enumeration value="Agent"/>
</simpleType>

contactBatchStates

Possible value: Cancelled, Done, Running, Scheduled

<simpleType name="contactBatchStates" base="xsd:string">
	<xsd:enumeration value="Cancelled"/>
	<xsd:enumeration value="Done"/>
	<xsd:enumeration value="Running"/>
	<xsd:enumeration value="Scheduled"/>
</simpleType>

contactModes

Possible value: Dialer, Inbound, Manual, Outbound, Preview

<simpleType name="contactModes" base="xsd:string">
	<xsd:enumeration value="Dialer"/>
	<xsd:enumeration value="Inbound"/>
	<xsd:enumeration value="Manual"/>
	<xsd:enumeration value="Outbound"/>
	<xsd:enumeration value="Preview"/>
</simpleType>

Note: Outbound is synonymous with Automated Voice Message.

costDataInformation

Possible value: Account, AccountAndEnterprise, Enterprise, None

<simpleType name="costDataInformation" base="xsd:string">
	<xsd:enumeration value="Account"/>
	<xsd:enumeration value="AccountAndEnterprise"/>
	<xsd:enumeration value="Enterprise"/>
	<xsd:enumeration value="None"/>
</simpleType>

dayOfWeek

Possible value: 1, 2, 3, 4, 5, 6, 7 (Monday = 1 as per ISO 8601)

<simpleType name="dayOfWeek" base="xsd:positiveInteger">
	<xsd:enumeration value="1"/>
	<xsd:enumeration value="2"/>
	<xsd:enumeration value="3"/>
	<xsd:enumeration value="4"/>
	<xsd:enumeration value="5"/>
	<xsd:enumeration value="6"/>
	<xsd:enumeration value="7"/>
</simpleType>

detectionStatus

Possible value: Machine, Person

<simpleType name="detectionStatus" base="xsd:string">
	<xsd:enumeration value="Machine"/>
	<xsd:enumeration value="Person"/>
	<xsd:enumeration value="SIT"/>
</simpleType>

deviceEscalationType

Possible value: ContactBased, PassBased

<simpleType name="deviceEscalationType" base="xsd:string">
	<xsd:enumeration value="ContactBased"/>
	<xsd:enumeration value="None"/>
	<xsd:enumeration value="PassBased"/>
</simpleType>

deviceSources

Possible value: FreeFormEntry, Inbound, List, Unknown

<simpleType simpleType name="deviceSources" base="xsd:string">
	<xsd:enumeration value="FreeFormEntry"/>
	<xsd:enumeration value="Inbound"/>
	<xsd:enumeration value="List"/>
	<xsd:enumeration value="Unknown"/>
</simpleType>

directConnectStates

Possible value: CallCenterBusy, CallCenterHangupDuringHold, CallCenterNoAnswer, ClientExceededMaxHoldTime, ClientHangupDuringHold, ClientHangupDuringTransfer, ContactAborted, CTIFailed, Failed, NoLinesAvailable, Success

<simpleType name="directConnectStates" base="xsd:string">
	<xsd:enumeration value="CallCenterBusy"/>
	<xsd:enumeration value="CallCenterHangupDuringHold"/>
	<xsd:enumeration value="CallCenterNoAnswer"/>
	<xsd:enumeration value="ClientExceededMaxHoldTime"/>
	<xsd:enumeration value="ClientHangupDuringHold"/>
	<xsd:enumeration value="ClientHangupDuringTransfer"/>
	<xsd:enumeration value="ContactAborted"/>
	<xsd:enumeration value="CTIFailed"/>
	<xsd:enumeration value="Failed"/>
	<xsd:enumeration value="NoLinesAvailable"/>
	<xsd:enumeration value="Success"/>
</simpleType>

entryLookBack

Possible value: AllPasses, PreviousPass

<simpleType name="entryLookback" base="xsd:string">
	<xsd:enumeration value="AllPasses"/>
	<xsd:enumeration value="PreviousPass"/>
</simpleType>

hangupMode

Possible value: Always, Never, WhenNoWork

<simpleType name="hangupMode" base="xsd:string">
	<xsd:enumeration value="Always"/>
	<xsd:enumeration value="Never"/>
	<xsd:enumeration value="WhenNoWork"/>
</simpleType>

importState

Possible value: Aborted, Cancelled, Completed, Error, Queued, Running

<simpleType name="UploadState" base="xsd:string">
	<xsd:enumeration value="Aborted"/>
	<xsd:enumeration value="Cancelled"/>
	<xsd:enumeration value="Completed"/>
	<xsd:enumeration value="Error"/>
	<xsd:enumeration value="Queued"/>
	<xsd:enumeration value="Running"/>
</simpleType>

inboundDeviceTypes

Possible value: PhoneNumber, ShortCode, Url

<simpleType name="inboundDeviceTypes" base="xsd:string">
	<xsd:enumeration value="PhoneNumber"/>
	<xsd:enumeration value="ShortCode"/>
	<xsd:enumeration value="Url"/>
        <xsd:enumeration value="AgentRegistrationNumber"/>
	<xsd:enumeration value="LocalTouch"/>
</simpleType>

initialWorkStates

Possible value: Break, Available

<simpleType name="initialWorkStates" base="xsd:string">
	<xsd:enumeration value="Break"/>
	<xsd:enumeration value="Available"/>
</simpleType>

jobStates

Possible value: Cancelled, Done, Failed, Pending, Running, Stopping

<simpleType name="jobStates" base="xsd:string">
	<xsd:enumeration value="Cancelled"/>
	<xsd:enumeration value="Done"/>
	<xsd:enumeration value="Failed"/>
	<xsd:enumeration value="Pending"/>
	<xsd:enumeration value="Running"/>
	<xsd:enumeration value="Stopping"/>
</simpleType>

listSources

Possible value: Import, System

<simpleType simpleType name="listSources" base="xsd:string">
	<xsd:enumeration value="Import"/>
	<xsd:enumeration value="System"/>
</simpleType>

listType

Possible value: Suppression, Standard

<simpleType name="listType" base="xsd:string">
	<xsd:enumeration value="Suppression"/>
	<xsd:enumeration value="Standard"/>
</simpleType>

notificationType

Possible value: Alert, News, Survey

<simpleType name="notificationType" base="xsd:string">
	<xsd:enumeration value="Alert"/>
	<xsd:enumeration value="News"/>
	<xsd:enumeration value="Survey"/>
</simpleType>

optInLevels

Possible value: Double, Single

<simpleType name="optInLevels" base="xsd:string">
	<xsd:enumeration value="Double"/>
	<xsd:enumeration value="Single"/>
</simpleType>

orgType

Possible value: Account, Enterprise, SuperEnterprise

<simpleType name="orgType" base="xsd:string">
	<xsd:enumeration value="Account"/>
	<xsd:enumeration value="Enterprise"/>
	<xsd:enumeration value="SuperEnterprise"/>
<xsd:enumeration value="System"/>
</simpleType>

outreachStrategyType

Possible value: OnDemand, Standard

<simpleType name="outreachStrategyType" base="xsd:string">
	<xsd:enumeration value="OnDemand"/>
	<xsd:enumeration value="Standard"/>
</simpleType>

pacingModel

Possible value: Agent, Auto, Fixed

<simpleType name="pacingModel" base="xsd:string">
	<xsd:enumeration value="Agent"/>
	<xsd:enumeration value="Auto"/>
	<xsd:enumeration value="Fixed"/>
        <xsd:enumeration value="LinesPerAgent"/>
</simpleType>

passExecutionOrder

Possible value: Parallel, Sequential

<simpleType name="passExecutionOrder" base="xsd:string">
	<xsd:enumeration value="Parallel"/>
	<xsd:enumeration value="Sequential"/>
</simpleType>

passStates

Possible value: Awaiting, Done, Loading, Paused, Pending, Running, Stopping, SystemPaused

<simpleType name="passStates" base="xsd:string">
	<xsd:enumeration value="Awaiting"/>
	<xsd:enumeration value="Done"/>
	<xsd:enumeration value="Loading"/>
	<xsd:enumeration value="Paused"/>
	<xsd:enumeration value="Pending"/>
	<xsd:enumeration value="Running"/>
	<xsd:enumeration value="Stopping"/>
	<xsd:enumeration value="SystemPaused"/>
</simpleType>

recordingFileFormat

Possible value: WAV

<simpleType name="recordingFileFormat" base="xsd:string">
	<xsd:enumeration value="WAV"/>
</simpleType>

recordingEncodingFormat

Possible value: MULAW

<simpleType name="recordingEncodingFormat" base="xsd:string">
	<xsd:enumeration value="MULAW"/>
</simpleType>

recordingStates

Possible value: Active, Deleted, Discarded, Expired, Paused, PendingDeletion, PendingExpiration, PendingStorageAndDeletion, PendingStorage, Stored

<simpleType name="recordingStates" base="xsd:string">
	<xsd:enumeration value="Active"/>
	<xsd:enumeration value="Deleted"/>
	<xsd:enumeration value="Discarded"/>
	<xsd:enumeration value="Expired"/>
	<xsd:enumeration value="Paused"/>
	<xsd:enumeration value="PendingDeletion"/>
	<xsd:enumeration value="PendingExpiration"/>
	<xsd:enumeration value="PendingStorageAndDeletion"/>
	<xsd:enumeration value="PendingStorage"/>
	<xsd:enumeration value="Stored"/>
</simpleType>

recordingType

Possible value: Agent, Diagnostic, Script

<simpleType name="recordingType" base="xsd:string">
	<xsd:enumeration value="Agent"/>
	<xsd:enumeration value="Diagnostic"/>
	<xsd:enumeration value="Script"/>
</simpleType>

registrationMethods

Possible value: InboundTollFree, InboundToll, Outbound

<simpleType name="reportTimeFrame" base="xsd:string">
	<xsd:enumeration value="InboundTollFree"/>
	<xsd:enumeration value="InboundToll"/>
	<xsd:enumeration value="Outbound"/>
</simpleType>

requestedAction

Possible value: CancelFollowUp, CancelTransfer, CompleteTransfer, DeleteRecording, InitiateTransfer, LaunchManual, LaunchPreview, RefreshPIN, ResetAgentState, ScheduleMessage, SkipPreview, StartRecording, StartTransferConference, StopRecording

<simpleType name="requestedAction" base="xsd:string">
	<xsd:enumeration value="CancelFollowUp"/>
	<xsd:enumeration value="CancelTransfer"/>
	<xsd:enumeration value="CompleteTransfer"/>
	<xsd:enumeration value="DeleteRecording"/>
	<xsd:enumeration value="InitiateTransfer"/>
	<xsd:enumeration value="LaunchManual"/>
	<xsd:enumeration value="LaunchPreview"/>
	<xsd:enumeration value="RefreshPIN"/>
	<xsd:enumeration value="ResetAgentState"/>
	<xsd:enumeration value="ScheduleMessage"/>
        <xsd:enumeration value="SkipPreview"/>
	<xsd:enumeration value="StartBarge"/>
	<xsd:enumeration value="StartCoach"/>
	<xsd:enumeration value="StartMonitor"/>
	<xsd:enumeration value="StartRecording"/>
	<xsd:enumeration value="StartTransferConference"/>
	<xsd:enumeration value="StopBarge"/>
	<xsd:enumeration value="StopCoach"/>
	<xsd:enumeration value="StopMonitor"/>
	<xsd:enumeration value="StopRecording"/>
</simpleType>

requestedRecordingAction

Possible value: AddedToStorage, Complete, Delete, Pause, Resume, RemovedFromStorage

<simpleType name="requestedRecordingAction" base="xsd:string">
	<xsd:enumeration value="AddedToStorage"/>
	<xsd:enumeration value="Complete"/>
	<xsd:enumeration value="Delete"/>
	<xsd:enumeration value="Discard"/>
	<xsd:enumeration value="Pause"/>
	<xsd:enumeration value="Resume"/>
	<xsd:enumeration value="RemovedFromStorage"/>
</simpleType>

reportTimeFrame

Possible value: ExplicitDates, Incremental, Last7Days, LastMonth, LastNDays, MonthToDate, None, Today, Yesterday

<simpleType name="reportTimeFrame" base="xsd:string">
	<xsd:enumeration value="ExplicitDates"/>
	<xsd:enumeration value="Incremental"/>
        <xsd:enumeration value="Last7Days"/>
	<xsd:enumeration value="LastMonth"/>
	<xsd:enumeration value="LastNDays"/>
	<xsd:enumeration value="MonthToDate"/>
	<xsd:enumeration value="None"/>
	<xsd:enumeration value="Today"/>
	<xsd:enumeration value="Yesterday"/>
</simpleType>

requestType

Possible value: ListUpload, Report

<simpleType name="requestType" base="xsd:string">
	<xsd:enumeration value="Report"/>
	<xsd:enumeration value="ListUpload"/>
</simpleType>

ruleDefinitionType

Possible value: Java, Drools, JavaScript

<simpleType name="ruleDefinitionType" base="xsd:string">
	<xsd:enumeration value="Java"/>
	<xsd:enumeration alue="Drools"/>
	<xsd:enumeration value="JavaScript"/>
</simpleType>

scheduleUnits

Possible value: Once, Hour, Day, Week, Month, Quarter, Year

<simpleType name="scheduleUnits" base="xsd:string">
	<xsd:enumeration value="Once"/>
	<xsd:enumeration value="Hour"/>
	<xsd:enumeration value="Day"/>
	<xsd:enumeration value="Week"/>
	<xsd:enumeration value="Month"/>
	<xsd:enumeration value="Quarter"/>
	<xsd:enumeration value="Year"/>
</simpleType>

severity

Possible value: Information, Note, Severe, Warning

<simpleType name="severity" base="xsd:string">
        <xsd:enumeration value="Information"/>
        <xsd:enumeration value="Note"/>
        <xsd:enumeration value="Severe"/>
        <xsd:enumeration value="Warning"/>
</simpleType>

subCampaignStates

Possible value: Active, All, Awaiting, Cancelled, Completed, Completing, Done, Loading, Paused, Pending, Running, Stopping, SystemPaused

<simpleType name="subCampaignStates" base="xsd:string">
	<xsd:enumeration value="Active"/>
	<xsd:enumeration value="All"/>
	<xsd:enumeration value="Awaiting"/>
	<xsd:enumeration value="Cancelled"/>
	<xsd:enumeration value="Completing"/>
	<xsd:enumeration value="Completed"/>
	<xsd:enumeration value="Done"/>
	<xsd:enumeration value="Loading"/>
	<xsd:enumeration value="Paused"/>
	<xsd:enumeration value="Pending"/>
	<xsd:enumeration value="Running"/>
	<xsd:enumeration value="Stopping"/>
	<xsd:enumeration value="SystemPaused"/>
</simpleType>

subCampaignType

Possible value: Inbound, EventBased, Outbound

<simpleType name="subCampaignType" base="xsd:string">
	<xsd:enumeration value="Inbound"/>
	<xsd:enumeration value="EventBased"/>
	<xsd:enumeration value="Outbound"/>
</simpleType>

subscriptionStates

Possible value: Deactivated, Opted-In, Opted-Out, Pending, Unknown

<simpleType name="subscriptionStates" base="xsd:string">
	<xsd:enumeration value="Deactivated"/>
	<xsd:enumeration value="Opted-In"/>
	<xsd:enumeration value="Opted-Out"/>
	<xsd:enumeration value="Pending"/>
	<xsd:enumeration value="Unknown"/>
</simpleType>

systemEventCategory

Possible value: Application, Security

<simpleType name="systemEventCategory" base="xsd:string">
	<xsd:enumeration value="Application"/>
	<xsd:enumeration value="Security"/>
	<xsd:enumeration value="Interaction"/>
</simpleType>

targetAgentMode

Possible value: AgentOnly, AgentTheGroup, GroupOnly

<simpleType name="targetAgentMode" base="xsd:string">
	<xsd:enumeration value="AgentOnly"/>
	<xsd:enumeration value="AgentThenGroup"/>
        <xsd:enumeration value="GroupOnly"/>
</simpleType>

transferResult

Possible value: ContactExceededMaxHoldTime, ContactHungup, ContactHungupOnHold, InternalError, SourceAgentCancelled, SourceAgentHungup, Success, TargetAgentHungup, TargetBadNumber, TargetBusy, TargetNoAnswer, TargetNotConnected

<simpleType name="transferResult" base="xsd:string">
	<xsd:enumeration value="ContactExceededMaxHoldTime"/>
	<xsd:enumeration value="ContactHungup"/>
	<xsd:enumeration value="ContactHungupOnHold"/>
	<xsd:enumeration value="InternalError"/>
	<xsd:enumeration value="SourceAgentCancelled"/>
	<xsd:enumeration value="SourceAgentHungup"/>
	<xsd:enumeration value="Success"/>
	<xsd:enumeration value="TargetAgentHungup"/>
	<xsd:enumeration value="TargetBadNumber"/>
	<xsd:enumeration value="TargetBusy"/>
	<xsd:enumeration value="TargetNoAnswer"/>
	<xsd:enumeration value="TargetNotConnected"/>
</simpleType>

transferType

Possible value: Supervised, Unsupervised

<simpleType name="transferType" base="xsd:string">
	<xsd:enumeration value="Supervised"/>
	<xsd:enumeration value="Unsupervised"/>
</simpleType>

timeZoneSource

Possible value: Contact, Device, ContactAndDevice, ContactThenDevice

<simpleType name="timeZoneSource" base="xsd:string">
	<xsd:enumeration value="Contact"/>
	<xsd:enumeration value="Device"/>
	<xsd:enumeration value="ContactAndDevice"/>
	<xsd:enumeration value="ContactThenDevice"/>
</simpleType>

UIVersion

Possible value: Beta, Current, Prerelease

<simpleType name="UIVersion" base="xsd:string">
	<xsd:enumeration value="Beta"/>
	<xsd:enumeration value="Current"/>
	<xsd:enumeration value="Prerelease"/>
</simpleType>

UploadRequestArtifacts

Possible value: OriginalFile, MessageFile, RejectFile

<simpleType name="UploadRequestArtifacts" base="xsd:string">
	<xsd:enumeration value="OriginalFile"/>
	<xsd:enumeration value="MessageFile"/>
	<xsd:enumeration value="RejectFile"/>
</simpleType>

Other Types

Time Zones

Time Zones are represented as strings using the standard "tz database" (See en.wikipedia.org/wiki/Zoneinfo).

Time

A time as an offset is not represented as a xsd:time due to the issues with mapping this to a native type, so all such objects are mapped as strings but use the format of an xsd:time i.e. hh:mm:ss.sss.

Phone Numbers

Phone numbers are formatted using E.123 format (See http://en.wikipedia.org/wiki/E.123) and are always normalized on input. This means that all of the following 617.875.9182, 617-875-9182, 1 617 875 9182 will be normalized on input and will be represented as +1 617 875 9182 (assuming it is a US-based account).

Locales

Locales are specified by using a language code (see ISO-639) followed by an underscore followed by a country code (see ISO-3166). For details see en.wikipedia.org/wiki/Locale.

BaseEntity

An entity is an abstract type. The following domain objects are all entities:

  • Contact
  • Campaign
  • ContactPointValidation
  • Device
  • Event
  • EventSchedule
  • Job
  • List
  • Notification
  • NotificationView
  • Org
  • Outreach Strategy
  • Pass
  • PasswordResetRequest
  • ReportRequest
  • RuleCategory
  • RuleContext
  • RuleTemplate
  • Session
  • Script
  • SecurityToken
  • SubCampaign
  • User

Feedback

Comment on this article:

blog comments powered by Disqus
This page was last modified on 6 September 2016, at 11:25.