Interaction Center Web Services (ICWS)

/icws/{sessionId}/dialer/initiate-manual-outbound-call

Feature	Version	Obsolete Version
dialer	7

POST

/icws/{sessionId}/dialer/initiate-manual-outbound-call

A set of parameters for querying Dialer database tables related to contact lists.

Feature	Version	Obsolete Version
dialer	7

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

initiateManualOutboundCallParameters

Expand All Collapse All

Property

Value

Comments

campaignid

String

Required

The Campaign ID to be used to place the manual call.

agentid

String

Required

The agent ID who is initiating the call.

identity

String

Required

The contact list's I3_Identity for the record of the call that is being placed.

type

Enumeration: manualCallNumberType

Required

The type of phone number to make.

Unknown

ContactColumnName

ContactColumnId

PhoneNumber

numbervalue

String

The number that corresponds with the manualCallNumberType selection.

ignorefilter

Boolean

Specifies to override the campaign's filter even if it should exclude the number.

ignorequeryfilter

Boolean

Specifies to override the campaign's query-time filter even if it should exclude the number.

ignorezoneblocking

Boolean

Specifies to override the campaign's zone blocking settings even if it should exclude the number.

ignoreskills

Boolean

Specifies to override the campaign's skills setting even if the agent does not possess the necessary skills to dial the number.

ignoredailylimit

Boolean

Specifies to override the campaign's setting on the max calls per day to the record when dialing the record.

ignoreminimumspacing

Boolean

Specifies to override the campaign's setting on the minimum minutes to dial the records a followup time when dialing the record.

ignoredncscrub

Boolean

Specifies to override the campaign's DNC settings and dial the record..

ignorecampaignownership

Boolean

Specifies to override the campaign's setting to prevent the record from being dialed if another campaign has exclusive rights to the contact list record.

Response

200 - OK

Initiate manual outbound call succeeded.

initiateManualOutboundCallResponse

Expand All Collapse All

Property

Value

Comments

response

Boolean

Required

Associated Message

This message will be sent to the client to inform the client about manual outbound call status.

manualOutboundCallStatusMessage

Expand All Collapse All

Property

Value

Comments

__type

"urn:inin.com:dialer:manualOutboundCallStatusMessage"

Required

The JSON type representing this option.

isDelta

Boolean

Required

When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

campaignId

String

Required

Id of the campaign for which manual outbound call was initiated.

agentId

String

Required

Id of the agent that initiated the manual outbound call.

identity

String

Required

Dialer Identity of the manual outbound call.

status

Enumeration: manualOutboundCallStatus

Required

Manual outbound call status.

Unknown

None

InvalidCampaign

InvalidAgent

InternalError

AgentNotIdle

ContactNotFound

ContactUncallable

ContactBlocked

PlaceCallFailed

InvalidPhoneNumber

CallBlocked

CallPlaced

CallComplete

PolicyCompleted

PreviouslyDialed

filterblocked

Boolean

Required

Contact record was excluded by the campaign filter.

zoneblocked

Boolean

Required

Contact was zone blocked.

skillblocked

Boolean

Required

Agent initiating the call does not have the skills necessary.

dailylimitblocked

Boolean

Required

The number of calls for the contact reached the daily limit.

minimumspacingblocked

Boolean

Required

Minimum spacing between calls is not satisfied.

campaignownershipblocked

Boolean

Required

Contact does not belong to the campaign initiating the call.

donotcallblocked

Boolean

Required

Contact is blocked by Do-Not-Call policy.

querytimefilterblocked

Boolean

Required

Contact record was excluded by the campaign query time filter.

previouslydialed

Boolean

Required

A flag indicating the phone number associated with the call has been previously dialed.

uncallablestatus

String

Required

The status of the record when uncallable.

202 - Accepted

The initiateManualOutboundCall 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.