Interaction Center Web Services (ICWS)

/icws/{sessionId}/dialer/perform-call-list-query

Feature	Version	Obsolete Version
dialer	9

POST

/icws/{sessionId}/dialer/perform-call-list-query

Settings to define the call that will be placed manually on behalf of an agent/campaign.

Feature	Version	Obsolete Version
dialer	9

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

performCallListQueryParameters

Expand All Collapse All

Property

Value

Comments

connectionid

String

Required

The ID of the Database Connection (GUID).

command

Complex Type: dbCommandParameters

Required

The DB command parameters.

contactlisttable

String

Required

The name of the Contact List Table in the Database.

statement

String

Required

The query statement (in SQL) to be passed in.

commandtype

Enumeration: dbCommandType

Required

The type of SQL command that is being executed (i.e. Select, insert, delete, etc.).

eDBCommandType_Create

eDBCommandType_Insert

eDBCommandType_Update

eDBCommandType_Delete

eDBCommandType_Select

eDBCommandType_Drop

dbcommandparameterlist

List [Unbounded]: Complex Type: dbCommandQueryParameters

(Optional)The list of parameters to pass into the DB query.

value

String

Required

The database parameter value (often the column name) for the query.

type

Int

Required

The type of the value to be returned in integer form (OLE DB Type). For instance, date is type '7', big integer is type '20', double is type '5'.

size

Int

(Use depends on the type value).

scale

Int

(Use depends on the type value).

precision

Int

(Use depends on the type value).

tabletype

Enumeration: dbTableType

Required

The type of Dialer table that is being queried by int.

CallList

CallHistory

AgentStat

CallSchedule

Audit

Recycle

PhoneNumberDetail

Version

128

JIT

256

CampaignStat

512

Upload

1024

UploadIds

2048

PenetrationRange

4096

PenetrationData

8192

PenetrationCallsCompleted

16384

DNCMetaDataTable

32768

displayname

String

Response

200 - OK

Return response from the server.

callListQueryResponse

Expand All Collapse All

Property

Value

Comments

recordsaffected

Int

Required

errorMessage

String

Required

records

List [Unbounded]: Complex Type: dialerContactData

Required

status

String

Required

The status of the contact list record.

identity

String

The I3_Identity of the contact list record.

zone

String

The zone associated with the contact list record.

values

Dictionary

List of additional entries retrieved about the contact list record from the query.

[key]

String

Required

[value]

String

Required

202 - Accepted

The performCallListQuery request was received.

400 - Bad Request

An error occurred while attempting to process the call parameters.

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.

403 - Forbidden

Neither the agent nor the station the agent is logged in to has a Dialer Add-on License available, or the agent is trying to log in to a specific campaign without the "Logon Campaign" security right.

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.