Get incoming chat messages.
get
/connectedWorker/clientapi/v2/employees/{employeeId}/messages
This operation retrieves incoming chat messages for an employee.
Request
Path Parameters
-
employeeId: string
Employee identifier
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Incoming chat messages were successfully retrieved.
Root Schema : ChatMessages
Type:
Show Source
object
-
items:
array items
-
links(optional):
array links
Read Only:
true
Nested Schema : ChatMessage
Type:
Show Source
object
-
id(optional):
string
Read Only:
true
The unique id of the objectExample:53
-
lastReminder(optional):
string(date-time)
Read Only:
true
Date and time the reminder was sent for the last time in ISO-8601 format. Automatically assigned on backend when the reminder is sent. -
links(optional):
array links
-
priority:
string
Allowed Values:
[ "HIGH", "MEDIUM", "LOW" ]
Priority of messageExample:MEDIUM
-
read(optional):
boolean
Read Only:
true
Indicates whether the chat message was read by the recipientExample:true
-
readTime(optional):
string(date-time)
Read Only:
true
Date and time the chat message was acknowledged by a recipient in ISO-8601 format. Automatically assigned on backend when the message was read. -
receivedTime(optional):
string(date-time)
Read Only:
true
Date and time the chat message was received in ISO-8601 format. Automatically assigned on backend during creation of chat message. -
recipients:
array recipients
List of recipients, cannot be empty
-
text:
string
The chat message, cannot be blankExample:
Chat message send among employees
Nested Schema : recipients
Type:
array
List of recipients, cannot be empty
Show Source
-
Array of:
string
List of recipients, cannot be emptyExample:
["johnSmith","johnDeere"]
Example:
[
"johnSmith",
"johnDeere"
]
Nested Schema : Link
Type:
Show Source
object
-
href:
string
The target resource's URI
-
rel:
string
Relation type