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 (int64 format)

Output only. The message creation time.
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 new ChatMessage in a Case.

get

 Gets a single ChatMessage by its resource name.

list

 Lists ChatMessages for a specific Case.

pinMessage

 Pins a specific ChatMessage to the Case wall.

unpinMessage

 Unpins a pinned ChatMessage from the Case wall.

unreadMessagesCount

 Returns the number of ChatMessages in the Case chat that the current user has not yet read.

upload

 Creates a ChatMessage in a Case and uploads a ChatMessageAttachment.