Interaction Center Web Services (ICWS)

/icws/{sessionId}/directories/lookup-entries

Feature	Version	Obsolete Version
directories	4

POST

/icws/{sessionId}/directories/lookup-entries

Gets any lookup entries that satisfy the query parameters. The logged in user must have the appropriate search rights configured in Interaction Administrator for results to be included. These search rights can be found in the Access Control container under the Search column.

Feature	Version	Obsolete Version
directories	4

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

lookupEntriesQuery

Expand All Collapse All

Property

Value

Comments

lookupEntryTypes

List [1,*]: Enumeration: lookupEntryType

Required

The type of lookup entries to search.

When specifying AttendantProfile, attendant profiles can only be included in the lookup results if the logged in user has the sufficient search rights assigned. From within Interaction Administrator, the logged in user must have the search rights for the appropriate Email/Inbound/Operator/Outbound profiles set in the Access Control container. Additionally, the attendant profile must also be setup to be a transfer target from within Interaction Attendant.

None

No lookup entry type specified.

User

Include Users while doing lookups.

StandalonePhone

Include Standalone Phones while doing lookups.

Station

Include Stations while doing lookups.

StationGroup

Include Station Groups while doing lookups.

AttendantProfile

Include Attendant Profiles while doing lookups.

Workgroup

Include Workgroups while doing lookups.

OutboundAttendantProfile

Include Outbound Attendant Profiles while doing lookups.

Feature	Version	Obsolete Version
directories	11

lookupEntryProperties

List [1,*]: Enumeration: lookupEntryProperty

Required

The properties that should be checked for the lookupString.

none

None.

firstName

First Name.

lastName

Last Name.

displayName

Display Name.

department

Department.

entryID

ID of this lookup entry.

extension

Extension of this lookup entry.

mobilePhone

Mobile phone number of this lookup entry.

homePhone

Home phone number of this lookup entry.

homePhone2

Alternate home phone number of this lookup entry.

homeEmail

Home email address of this lookup entry.

businessPhone

Business phone number of this lookup entry.

businessPhone2

Alternate business phone number of this lookup entry.

businessEmail

Business email address of this lookup entry.

isActive

Is Active (applies to workgroups only).

lookupComparisonType

Enumeration: lookupComparisonType

Required

The type of comparison to use for this lookup entry search.

None

None.

Exact

The lookup string matches a property exactly.

StartsWith

A property value starts with the lookup string.

Contains

The lookup string is a substring of a property.

Wildcards

The lookup string contains wildcards. The filter expression may contain wildcard symbols. A "*" will match zero or more characters. A "?" will match any single character. For example "Dev*" would match "Developers", "Development-Asia", and "Devices". "T?m" would match "Tim" and "Tom" but not "Team".

lookupString

String

Required

The string to use for this lookup entry search.

maxEntries

Int

Required

The maximum number of lookup entries to return from this search.

Response

200 - OK

The query was successful. Matched lookup entries are included in the response.

lookupEntries

Expand All Collapse All

Property

Value

Comments

lookupEntriesList

List [Unbounded]: Complex Type: lookupEntry

Required

A set of lookup entries.

businessEmail

String

The lookup entry's business email address.

businessPhone

Complex Type: phoneNumber

The lookup entry's business phone number.

Property type documentation:

Represents a phone number.

standardizedNumber

String

Required

The standardized phone number.

displayString

String

Required

The phone number's display string.

numberInfo

Complex Type: editablePhoneNumber

It contains the base-number,extension and auto dial information.

Feature	Version	Obsolete Version
directories	8

baseNumber

String

The phone number.

extension

String

The extension.

autoDialable

Boolean

Whether or not the extension is a auto dialable.

editNumber

String

The string to use when editing the phone number. This property contains the phone number and/or an extension. They are delimited by /^ when the extension is autodialed, and just ^ when it isn't. Extensions without a number will always be returned as autodialed.

Note

editNumber has been marked obsolete. displayString can be used in its place, as it provides identical information. Alternatively numberInfo can be used for to retrieve similar information as it contains the parsed information found in displayString.

Feature	Version	Obsolete Version
directories	6	8

dialable

Boolean

Whether or not the returned number is a dialable number.

businessPhone2

Complex Type: phoneNumber

The lookup entry's alternate business phone number.

Property type documentation:

Represents a phone number.

department

String

The lookup entry's department.

displayName

String

The lookup entry's display name.

entryID

String

The lookup entry's ID.

extension

String

The lookup entry's extension.

firstName

String

The lookup entry's first name.

homeEmail

String

The lookup entry's home email address.

homePhone

Complex Type: phoneNumber

The lookup entry's home phone number.

Property type documentation:

Represents a phone number.

homePhone2

Complex Type: phoneNumber

The lookup entry's alternate home phone number.

Property type documentation:

Represents a phone number.

isActive

Boolean

A value indicating whether a lookup entry is active or not.

lastName

String

The lookup entry's last name.

lookupEntryType

Enumeration: lookupEntryType

Required

The lookup entry type for this search.

None

No lookup entry type specified.

User

Include Users while doing lookups.

StandalonePhone

Include Standalone Phones while doing lookups.

Station

Include Stations while doing lookups.

StationGroup

Include Station Groups while doing lookups.

AttendantProfile

Include Attendant Profiles while doing lookups.

Workgroup

Include Workgroups while doing lookups.

OutboundAttendantProfile

Include Outbound Attendant Profiles while doing lookups.

Feature	Version	Obsolete Version
directories	11

mobilePhone

Complex Type: phoneNumber

The lookup entry's mobile phone number.

Property type documentation:

Represents a phone number.

statusURI

String

The lookup entry's statusURI.

queueID

Complex Type: queueId

The id of the lookup entry's queue, if there is one.

Property type documentation:

A queueId containing the queue type and its name.

queueType

Enumeration: queueType

Required

The type of queue being identified.

system

A special Queue that represents interactions on a user's queue or station queue.

user

Represents a user's interactions.

workgroup

Represents a workgroup's interactions. Interactions passed to a Workgroup queue can be picked up by its member agents.

station

Represents a station's interactions.

queueName

String

Required

The name of the queue being identified.

voicemailCapable

Boolean

Required

Whether or not the lookup entry is capable of receiving voicemail.

moreEntriesMatched

Boolean

Required

A value indicating whether there are further matches beyond those returned. This is true when maxEntries limits the returned entries count.

phoneNumber

Complex Type: phoneNumber

Required

A value containing the phone number representation of the lookup string.

Property type documentation:

Represents a phone number.

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.