REST Resource: projects.locations.instances.cases.chatMessages

Resource: ChatMessage

This service is available for customers who migrated SOAR to a customer managed project and have the Chronicle API enabled. ChatMessage represents a message in a case chat.

JSON representation 
{
  "name": string,
  "createTime": string,
  "author": string,
  "text": string,
  "attachments": [
    {
      object (FileAttachment)
    }
  ],
  "pinned": boolean
}
Fields
name

string

Identifier. The unique name(ID) of the chat message. Format: projects/{project}/locations/{location}/instances/{instance}/cases/{case}/chatMessage/{chatMessage}
createTime

string (Timestamp format)

Output only. The message creation time.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
author

string

Output only. The message author.
text

string

Required. The message text.
attachments[]

object (FileAttachment)

Optional. The message attachments.
pinned

boolean

Output only. Whether the message is pinned to the case wall

FileAttachment

Attachments

JSON representation 
{
  "name": string,
  "fileName": string
}
Fields
name

string

Required. The name of the file attachment.
fileName

string

Required. The file name of the attachment.

Methods

create

 Creates a Case-chat message.

get

 Gets a Case-chat message.

list

 Lists all Case-chat messages for a given case.

pinMessage

 Pins a Case-chat message to the case wall.

unpinMessage

 Unpins a Case-chat message from the case wall.

upload

 Creates a Case-chat message with an attachment.