Interaction Center Web Services (ICWS)

/icws/{sessionId}/messaging/subscription/journeymap/related-interaction/{subscriptionId}

PUT

/icws/{sessionId}/messaging/subscription/journeymap/related-interaction/{subscriptionId}

Resolves an interaction to an individual or organization, location.

Note

Along with "icInteractionId" at least "indivId" should be provided in the request body.

Feature	Version	Obsolete Version
journey-map	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.

Template

subscriptionId

Required

Subscription Id for related interactions.

Representations

relatedInteractionSubscriptionParameters

Expand All Collapse All

Property

Value

Comments

entityId

String

Required

Individual's ID or organizaion's ID or location's ID to search. The entityId should be populated based on entityType.

icUserId

String

IC user's individual id.

entityType

Enumeration: entityType

Required

Organization location name.

individual

Interaction related to Individual.

organization

Interaction related to organization.

location

Interactions related to location .

startDateTime

DateTime

Start date and time for interactions.

endDateTime

DateTime

End dateand time for interactions.

count

Int

Number of interactions to be retrieved.If not sent maximum of 25 will be sent.

index

Int

Zero based index to start retrieved.If not sent 0 will be start index.

Response

204 - No Content

Related interactions.

Associated Message

Related Interactions.

relatedInteractionsInfo

Expand All Collapse All

Property

Value

Comments

__type

"urn:inin.com:journeymap:relatedInteractionsInfo"

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.

filteredCount

Int

This number represents the total number of interactions that match the subscription parameters.

subscriptionId

String

Required

The Subscription's Id.

relatedIntxSearchID

String

Required

This is same as what is provided in subscription parameters. eg. indivId, orgId, locId.

relatedInteractionList

List [Unbounded]: Complex Type: relatedInteraction

List of related interaction.

interactionId

String

Required

The Interaction's Id.

participantList

List [Unbounded]: Complex Type: participant

The set of participants for interaction.

__type

"urn:inin.com:journeymap:participant"

Required

The JSON type representing this option.

indivId

String

Required

Participant's indivID.

displayName

String

Participant's display name.

role

Enumeration: roleType

Required

Participant's display name.

unknown

Participant role is unknown.

initiator

Participant is an initiator.

respondant

Participant is respondant.

participant

Other participants.

orgName

String

Individual's organizaion name.

orgId

String

Individual's organizaion Id.

locationName

String

Individual's location name.

locId

String

Individual's organization's location Id.

wrapUpCode

String

Wrap up code for interaction.

segmentAccountCode

String

Interaction's segment account code.

segmentStartTime

String

Segment's start time.

segmentDuration

String

Segment total duration.

interactionType

String

Segment's interaction type eg. Call, Chat, Email, etc.

noteExists

Boolean

Indicate whether notes exist for interaction.

recordingId

String

Interaction's recording Id.

surveyExist

Boolean

Indicate whether survey exist for interaction.

surveyScore

Int

Survey score for this interaction.

surveyMinScore

Int

Minimum survey score for the interaction.

surveyMaxScore

Int

Maximum survey score for the interaction.

appIncidentId

String

Application incident Id.

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.

403 - Forbidden

The session user does not have permission to add an individual to journey map.

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

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 Responses

Error Identifier

Error Type

Error Description

error.request.internalServerError

Type: urn:inin.com:common:error

The server encountered an unexpected, internal error.

Feature	Version	Obsolete Version
configuration	2

error.request.timeout

Type: urn:inin.com:common:error

The request timed out.

Feature	Version	Obsolete Version
configuration	2

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.

DELETE

/icws/{sessionId}/messaging/subscription/journeymap/related-interaction/{subscriptionId}

Deletes all the subscriptions with the given subscriptionId.

Feature	Version	Obsolete Version
journey-map	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.

Template

subscriptionId

Required

Subscription Id for related interactions.

Response

204 - No Content

Subscription was successfully deleted.

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.