Interaction Center Web Services (ICWS)

/icws/{sessionId}/dialer/request-form-definition

Feature	Version	Obsolete Version
dialer	3

POST

/icws/{sessionId}/dialer/request-form-definition

Retrieves Base Script form definition.

Feature	Version	Obsolete Version
dialer	3

Request

Parameters

Type

Name

Comments

Header

ININ-ICWS-CSRF-Token

Required

The ININ session token necessary for all calls that require a security or user context.

Header

Required

The session cookie. With the exception of the connection request, all requests must provide a session cookie.

Template

sessionId

Required

The ININ session ID necessary for all calls that require a security or user context.

Representations

formDefinitionParameters

Expand All Collapse All

Property

Value

Comments

campaignId

String

Campaign ID for the Base Script form definition.

Response

200 - OK

Form definition is included within entity body.

formDefinition

Expand All Collapse All

Property

Value

Comments

pages

List [1,*]: Complex Type: baseScriptPage

Required

Collection of pages used within a Base Script.

name

String

Required

Name of the Base Script page.

controls

List [1,*]: Complex Type: baseScriptPageControl

Required

Form controls for a Base Script page.

column

String

Required

Database column linked to control.

label

String

Required

Label of the Base Script page.

readOnly

Boolean

Required

Specifies whether control has read-only property set.

type

Enumeration: baseScriptPageControlType

Required

Specifies type of control to display.

Text

Numeric

Radio

Listbox

DateTime

maxLines

Int

Maximum lines allowed for the control if applicable.

maxChars

Int

Maximum characters allowed for the control if applicable.

dateFormat

Enumeration: baseScriptDateTimeControlFormat

The format of the date time control.

ShortDate

LongDate

Time

ShortDateWithTime

LongDateWithTime

dataItems

Dictionary

Data for the dropdown list items or the radio button items.

Property type documentation:

Represents a collection of key/value string pairs.

[key]

String

Required

The key identifying this pair.

[value]

String

Required

The value of this pair.

dispositions

List [1,*]: Complex Type: baseScriptPageDisposition

Required

The collection of disposition choices an agent can select from at the end of a call. These choices are configured on the default page of the script that this campaign is configured to use.

label

String

Required

Name of a disposition choice the agent can select from at the end of a call.

wrapUpCategory

String

Required

The wrap-up category assigned to the call.

wrapUpCode

String

Required

The wrap-up code assigned to the call.

abandon

Boolean

Required

Specifies if a call is marked as abandoned.

recordStatus

String

Required

Record status assigned for this disposition.

isContact

Boolean

Required

Specifies if this disposition is considered a contact.

text

String

Required

Static text of the Base Script page.

stage

Int

Stage ID for the Base Script page.

foregroundColor

String

Required

Foreground color of the Base Script page.

backgroundColor

String

Required

Background color of the Base Script page.

misc

Complex Type: baseScriptMisc

Required

Miscellaneous options configured for a Base Script.

allowBreak

Boolean

Required

Specifies whether this base script allows agents to request break.

allowSkip

Boolean

Required

Specifies whether this base script allows agents to skip calls.

allowAgentOwned

Boolean

Required

Specifies whether this base script allows agent-owned callbacks.

militaryTime

Boolean

Required

Specifies whether this base script should use 24-time format.

pickupCall

Boolean

Required

Specifies whether this base script should automatically pick-up alerting calls.

allowSchedulePhone

Boolean

Required

Specifies whether this base script allows scheduling.

autoDisconnect

Boolean

Required

Specifies whether this base script allows auto disconnect on disposition.

allowEditingOfNumberToDial

Boolean

Required

Specifies whether this base script allows editing of Number to Dial.

allowAgentsAdditionalCalls

Boolean

Required

Specifies whether this base script allows agents to place Additional Followup calls.

allowEditingAdditionalCallNumbers

Boolean

Required

Specifies whether this base script allows editing Additional Call Numbers.

overrideDncBlock

Boolean

Required

Specifies whether this base script allows overriding DNC block for manual calls.

overrideZoneBlock

Boolean

Required

Specifies whether this base script allows overriding zone block for manual calls.

overrideSkillsBlock

Boolean

Required

Specifies whether this base script allows overriding skills block for manual calls.

overrideDailyLimitBlock

Boolean

Required

Specifies whether this base script allows overriding daily limit block for manual calls.

extensions

List [1,*]: Complex Type: extensionDefinition

Required

Contains list of allowable extensions to dial.

objectName

String

Required

Object display name.

extension

String

Required

Extension number.

objectType

String

Required

Type of the object [Station, User, Workgroup, StationGroup or Attendant].

403 - Forbidden

Neither the agent nor the station the agent is logged in to has a Dialer Add-on License available.

error

Provides additional detail for an error.

Expand All Collapse All

Property

Value

Comments

errorId

String

The error identifier that describes the current error.

message

String

Required

A message that describes the current error.

400 - Bad Request

The request was invalid. This can occur when the message body is malformed or missing required items. This will also occur if a required header or query string parameter is missing or invalid.

error

Provides additional detail for an error.

Expand All Collapse All

Property

Value

Comments

errorId

String

The error identifier that describes the current error.

message

String

Required

A message that describes the current error.

401 - Unauthorized

The specified session token is missing, invalid, or has expired.

Parameters

Type

Name

Comments

Header

WWW-Authenticate

Required

Indicates that the client needs to authenticate using a custom ICWS scheme, which supports a realm of type ICWS and a location which is the URL at which the client can authenticate. A typical example would be the following.


								WWW-Authenticate: ICWS realm="ICWS" location="/ICWS/connection"

error

Provides additional detail for an error.

Expand All Collapse All

Property

Value

Comments

errorId

String

The error identifier that describes the current error.

message

String

Required

A message that describes the current error.

410 - Gone

This resource has been deprecated and removed from the API.

error

Provides additional detail for an error.

Expand All Collapse All

Property

Value

Comments

errorId

String

The error identifier that describes the current error.

message

String

Required

A message that describes the current error.

500 - Internal Server Error

An unexpected error occurred while processing the request.

error

Provides additional detail for an error.

Expand All Collapse All

Property

Value

Comments

errorId

String

The error identifier that describes the current error.

message

String

Required

A message that describes the current error.