HTTP/S Request Header

Any request made to the server includes one of the following HTTP Headers:

Name

Data Type

Comment

Protocol-Version

string

Specifies the message protocol version.

User-Agent

string

Specifies the end-unit agent identifier (this is a standard HTTP attribute).

Application-Id

string

In the Customer context, specifies a unique ID designated to an application.

Application-Version

string

Specifies the cover application version, which is generally built by the Customer.

JMA-Module-Version

string

Specifies the Jacada Interaction Server core module version.

Imei

string

Specifies the device's Unique International Mobile Equipment Identity (IMEI) ID number.

Device-Type

string

Specifies the device type.

Device-Model

string

Specifies the device model number.

Os-Platform-Version

string

Specifies the Operating System (OS) version.

Message-Timestamp

string

Specifies the message time stamp.

Security-Token

string

Specifies the security token identifier provided by an authentication service.

Object-Version

string

Specifies the current running Jacada Interaction Server script version.

Session-Id

string

Specifies a unique identifier to enable a load balancer to dispatch user requests based on the specific relationship to a specific Server.

Object-Step-Id

string

Specifies a Current Active Element, the context on which a specific request is made. For example, when a request for HELP is sent, the server requires a context for this request to designate why the user asked for HELP.

Content-Type

string

Specifies the currently hard-coded application/JavaScript Object Notation (JSON).

Locale

string

Specifies a string to designate the current client language and country with the format {ll-CC}:

ll—2 alpha character language nomenclature (ISO 639-1).

CC—2 alpha character country nomenclature (ISO 3166-1 alpha-2).

For example, he-IL, en-US, en-UK, fr-FR, fr-CA, and so on.

Accept

string

Specifies the response-body. Most requests are hard-coded to application/JavaScript Object Notation (JSON) as a resources request, such as images, and this field should be "/".

UA-pixels*

string

Specifies the display size, for example, 1024x768 indicates a 1024x768 display.

UA-resolution*

string

Specifies the display Dots Per Inch (DPI), where 72 indicates a 72 DPI display.

User-Id

string

A unique identifier designating a specific end-user to be correlated to a specific Jacada Interaction Server system account.

For example, when sharing data between JI and a Telephony system, while the Telephony system is not under JI responsibility, each user requires a unique identifier and session enabling the telephony system to fetch the relevant data.