Jump to

• Request
• Response

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 Top

Response

Supported Media Types

• application/json

200 Response

Incoming chat messages were successfully retrieved.

Body ()

Root Schema : ChatMessages

Type: object

Show Source

• items: array items
• links(optional): array links
  Read Only: true

{
    "required":[
        "items"
    ],
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ChatMessage"
            }
        },
        "links":{
            "type":"array",
            "readOnly":true,
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object ChatMessage

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ChatMessage"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object Link

{
    "type":"array",
    "readOnly":true,
    "items":{
        "$ref":"#/components/schemas/Link"
    }
}

Nested Schema : ChatMessage

Type: object

Show Source

• id(optional): string
  Read Only: true

  The unique id of the object

  Example: 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 message

  Example: MEDIUM
• read(optional): boolean
  Read Only: true

  Indicates whether the chat message was read by the recipient

  Example: 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 blank

  Example: Chat message send among employees

{
    "required":[
        "priority",
        "recipients",
        "text"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The unique id of the object",
            "readOnly":true,
            "example":"53"
        },
        "text":{
            "type":"string",
            "description":"The chat message, cannot be blank",
            "example":"Chat message send among employees"
        },
        "priority":{
            "type":"string",
            "description":"Priority of message",
            "example":"MEDIUM",
            "enum":[
                "HIGH",
                "MEDIUM",
                "LOW"
            ]
        },
        "recipients":{
            "type":"array",
            "description":"List of recipients, cannot be empty",
            "writeOnly":true,
            "example":[
                "johnSmith",
                "johnDeere"
            ],
            "items":{
                "type":"string",
                "description":"List of recipients, cannot be empty",
                "example":"[\"johnSmith\",\"johnDeere\"]"
            }
        },
        "read":{
            "type":"boolean",
            "description":"Indicates whether the chat message was read by the recipient",
            "readOnly":true,
            "example":true
        },
        "readTime":{
            "type":"string",
            "description":"Date and time the chat message was acknowledged by a recipient in ISO-8601 format. Automatically assigned on backend when the message was read.",
            "format":"date-time",
            "readOnly":true
        },
        "receivedTime":{
            "type":"string",
            "description":"Date and time the chat message was received in ISO-8601 format. Automatically assigned on backend during creation of chat message.",
            "format":"date-time",
            "readOnly":true
        },
        "lastReminder":{
            "type":"string",
            "description":"Date and time the reminder was sent for the last time in ISO-8601 format. Automatically assigned on backend when the reminder is sent.",
            "format":"date-time",
            "readOnly":true
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    }
}

Nested Schema : recipients

Type: array

List of recipients, cannot be empty

Show Source

• Array of: string
  List of recipients, cannot be empty

  Example: ["johnSmith","johnDeere"]

{
    "type":"array",
    "description":"List of recipients, cannot be empty",
    "writeOnly":true,
    "example":[
        "johnSmith",
        "johnDeere"
    ],
    "items":{
        "type":"string",
        "description":"List of recipients, cannot be empty",
        "example":"[\"johnSmith\",\"johnDeere\"]"
    }
}

Example:

[
    "johnSmith",
    "johnDeere"
]

Nested Schema : Link

Type: object

Show Source

• href: string
  The target resource's URI
• rel: string
  Relation type

{
    "required":[
        "href",
        "rel"
    ],
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "description":"Relation type"
        },
        "href":{
            "type":"string",
            "description":"The target resource's URI"
        }
    }
}

Back to Top