| Feature | Version | |
|---|---|---|
| interactions | 6 |
| Feature | Version | |
|---|---|---|
| interactions | 6 |
Required
The ININ session token necessary for all calls that require a security or user context.Required
The session cookie. With the exception of the connection request, all requests must provide a session cookie.Required
The ININ session ID necessary for all calls that require a security or user context.Required
The interaction ID for the interaction resource.Required
The JSON type representing this option.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.
Required
The ID of the interaction this message corresponds to.Required
Required
The JSON type representing this option.Required
The type of this chat member.Required
The display name of the chat member.Required
The interaction ID for the updated interaction. A combination of this field and the userId can be used to uniquely identify a user.Required
The userId of the chat member. A combination of this field and the interactionId can be used to uniquely identify a user.Required
Indicates if this chat member is typing.Required
Required
Required
The JSON type representing this option.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.
Required
The ID of the interaction this message corresponds to.Required
Required
The chat member responsible for this chat text.Multiple options:
The value can be assigned any of the following options.Required
The type of this chat member.Required
The display name of the chat member.Required
The interaction ID for the updated interaction. A combination of this field and the userId can be used to uniquely identify a user.Required
The userId of the chat member. A combination of this field and the interactionId can be used to uniquely identify a user.Required
The JSON type representing this option.Required
The type of this chat member.Required
The display name of the chat member.Required
The interaction ID for the updated interaction. A combination of this field and the userId can be used to uniquely identify a user.Required
The userId of the chat member. A combination of this field and the interactionId can be used to uniquely identify a user.Required
Indicates if this chat member is typing.Required
The chat text.This property can be null.
Required
The timestamp associated with the chat text.| Feature | Version | |
|---|---|---|
| interactions | 10 |
Required
A message that describes the current error.Required
A message that describes the current error.Required
A message that describes the current error.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"
Required
A message that describes the current error.Required
A message that describes the current error.Required
A message that describes the current error.| Feature | Version | |
|---|---|---|
| interactions | 6 |
Required
The ININ session token necessary for all calls that require a security or user context.Required
The session cookie. With the exception of the connection request, all requests must provide a session cookie.Required
The ININ session ID necessary for all calls that require a security or user context.Required
The interaction ID for the interaction resource.Required
A message that describes the current error.Required
A message that describes the current error.Required
A message that describes the current error.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"
Required
A message that describes the current error.Required
A message that describes the current error.Required
A message that describes the current error.