Chat Message Fields
The chat message fields are listed in this section.
Name |
Label |
Data Type |
Mandatory |
Description |
---|---|---|---|---|
activityId |
activityId |
INTEGER |
The identifier of the activity with which the shared entity is related (integer). This field is available only for inventory and activity sharing or transferring. The value is zero if the entity isn't related to any activity. |
|
attachmentId |
attachmentId |
INTEGER |
The identifier of the attachment (integer) that is used to store this attachment in the field collaboration . |
|
author |
author |
VARCHAR2 |
The user login of the user who started this transaction (string). This field will be present only for transactions started by a user. |
|
chatId |
chatId |
INTEGER |
True |
The identifier of the chat or broadcast (string). This is the unique ID for each chat or broadcast in the collaboration server. |
date |
date |
DATE |
The date of the activity shared or transferred (string). This field is available only for activity sharing or transferring. The date format is YYYY-MM-DD. |
|
desc |
desc |
VARCHAR2 |
The description of the entity shared (string) |
|
downloadUrl |
downloadUrl |
VARCHAR2 |
The URL used to download the shared image (string). A GET request to this URL with the authentication of a user with read access to collaboration events will get the image. This field is available only for image sharing. |
|
filename |
filename |
VARCHAR2 |
The name of the image file shared (string). This field is available only for image sharing |
|
inventoryId |
inventoryId |
INTEGER |
The identifier of the inventory shared or transferred (integer). This field is available only for inventory sharing or transferring. |
|
inventoryType |
inventoryType |
VARCHAR2 |
The type of inventory (string). This field is available only for inventory sharing or transferring. |
|
lastUpdatedBy |
lastUpdatedBy |
VARCHAR2 |
The user login of the user who last updated the transaction (string). The value is SYSTEM when the server makes an update. |
|
latitude |
latitude |
VARCHAR2 |
The latitude of the shared location (string). This field is available only for location sharing. |
|
longitude |
longitude |
VARCHAR2 |
The longitude of the shared location (string). This field is available only for location sharing. |
|
messageId* |
messageId |
INTEGER |
True |
The identifier of the message in the collaboration server (long). |
needAcknowledgement |
needAcknowledgement |
VARCHAR2 |
The field indicating whether the acknowledgement option is enabled for this message (Boolean). The field is available only for broadcasts. It isn't available for messages without an acknowledgment. |
|
operationStatus |
operationStatus |
VARCHAR2 |
The latest action that was performed on this transaction (string). The values are accepted, rejected, failed, cancelled, and transferred. |
|
quantity |
quantity |
VARCHAR2 |
The quantity of non serialized inventory transferred (integer). This field is available only for non-serialized inventory transfer. |
|
resourceId |
resourceId |
VARCHAR2 |
The external identifier of the resource (string). This field isn't available for location and image sharing. The value is an empty string if the entity isn't related to any resource. |
|
resourceInternalId |
resourceInternalId |
INTEGER |
The internal identifier of the resource (integer). This field isn't available for location and image sharing. The value is zero if the entity isn't related to any resource. |
|
sequenceNumber |
sequenceNumber |
INTEGER |
The sequence number of the message in the chat or broadcast (long). |
|
startTime |
startTime |
DATE |
The time when this transaction was started (string). The time format is YYYY-MM-DD HH:MM:SS. |
|
status |
status |
VARCHAR2 |
The status of the transaction (string). The values are started, timed out, and finished |
|
text |
VARCHAR2 |
The text content of the message |
||
Time |
time |
DATE |
The time when this participant was invited to chat (string). The time format is YYYY-MM-DD HH:MM:SS. |
|
Timeoutime |
Timeouttime |
DATE |
The time after which the transaction will be timed out (string). The time format is YYYY-MM-DD HH:MM:SS. |
|
toAddress |
toAddress |
VARCHAR2 |
The address of the user to whom this transaction is sent (string). The value is the user who accepted the activity for activity broadcasts. The value is empty if no user accepts the activity in an activity broadcast |
|
transactionId |
transactionId |
INTEGER |
The identifier of the transaction (integer) that is used to store the transaction in the field collaboration server. |
|
type |
type |
VARCHAR2 |
The type of broadcast (string). The values are group:broadcast, location:broadcast, and activity:broadcast. The field is available only for broadcasts. |
|
user* |
user |
VARCHAR2 |
True |
The user who triggered this event (string). |