Interaction Center Web Services (ICWS)

/icws/{sessionId}/directories/speed-dial/{speedDialDirectoryId}/links/{speedDialLinkId}

PUT

/icws/{sessionId}/directories/speed-dial/{speedDialDirectoryId}/links/{speedDialLinkId}

Change primary number on a speed dial contact link.

Feature	Version	Obsolete Version
directories	10

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.

Template

speedDialDirectoryId

Required

The speed dial directory's ID.

Template

speedDialLinkId

Required

The speed dial link's ID.

Representations

speedDialContactLink

Expand All Collapse All

Property

Value

Comments

contactPrimaryNumberDesignation

Enumeration: defaultPhoneNumberType

Required

The new link primary contact number.

none

-1

Identifies that there is no default phone number designated.

Feature	Version	Obsolete Version
directories	7

extension

Identifies the extension field as the default phone number.

businessPhone

Identifies the business phone field as the default phone number.

businessPhone2

Identifies the business phone 2 field as the default phone number.

homePhone

Identifies the home phone field as the default phone number.

homePhone2

Identifies the home phone 2 field as the default phone number.

mobilePhone

Identifies the mobile phone field as the default phone number.

faxPhone

Identifies the fax phone field as the default phone number.

pagerPhone

Identifies the page phone field as the default phone number.

assistantPhone

Identifies the assistant phone field as the default phone number.

Response

204 - No Content

The contact was successfully updated with primary contact number designation.

403 - Forbidden

The session user does not have permission to update this speed dial contact link.

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.

503 - Service Unavailable

The service is currently unavailable.

Error Responses

Error Identifier

Error Type

Error Description

error.request.directory.busy

Type: urn:inin.com:common:error

The service is not able to acquire lock on contact at this time.

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.

DELETE

/icws/{sessionId}/directories/speed-dial/{speedDialDirectoryId}/links/{speedDialLinkId}

Delete a speed dial contact link.

Feature	Version	Obsolete Version
directories	10

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.

Template

speedDialDirectoryId

Required

The speed dial directory's ID.

Template

speedDialLinkId

Required

The speed dial link's ID.

Response

204 - No Content

The speed dial contact link was deleted successfully.

403 - Forbidden

The session user does not have permission to delete this speed dial contact link.

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.

503 - Service Unavailable

The service is currently unavailable.

Error Responses

Error Identifier

Error Type

Error Description

error.request.directory.busy

Type: urn:inin.com:common:error

The service is not able to acquire lock on contact at this time.

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


								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.