Skip to content

support_message_get

Get one message by id, in the same shape a list element has — the files it carries included, each with a freshly signed download URL.

Tool

support_message_get

Get one message by id, in the same shape a list element has — the files it carries included, each with a freshly signed download URL.

Get one message by id, in the same shape a list element has — the files it carries included, each with a freshly signed download URL. An internal note is returned like any other message: visibility narrows the list, it does not hide a message from this tool. A message belonging to another product is reported as not found

Behavior

HTTP
GET /support/messages/:id

Arguments

Name
Type
Required
Description
id
string
•
Message id

Response

Field
Type
Always
Description
id
string
•
Message id
body
string
•
The message text, byte-identical to what was stored
editedAt
string
•
ISO-8601 time of the last edit, or null when the message was never edited
threadId
string
•
Thread this message belongs to
createdAt
string
•
ISO-8601 creation timestamp
deletedAt
string
•
ISO-8601 time the message was deleted, or null. A deleted message stays in the thread as a placeholder: its body is empty and it carries no attachments
direction
string
•
inbound: written by the external end user. outbound: written by support, going out to them
visibility
string
•
public: part of the conversation the external end user sees. internal: a note between agents that never leaves the support contour
attachments
array
•
Files this message carries, each with a freshly signed download URL. Empty when there are none. Attachments whose upload was never confirmed are never listed here
attachmentIds
array
•
The same files as a flat list of ids, in the order attachments[] has them. This is the value support_message_create takes back; attachments.0.id names only the first file
authorAgentId
string
•
The agent author, or null when the external end user wrote the message
attachmentCount
integer
•
How many files this message carries, 0 when it carries none. A dot-path has no length, so this is the only way a step can branch on whether there are files at all — and a message may carry a file and no body, so it is what tells those two messages apart
authorExternalId
string
•
The external author, or null when an agent wrote the message
createdByIdentityId
string
•
The Lepsto identity that posted the message — the one allowed to edit or delete it. Null for a message from the public edge or from before authorship was recorded: nobody owns those, and only support_message_delete_any removes them

Try it

Get one message by id, in the same shape a list element has — the files it carries included, each with a freshly signed download URL.

When to use

Get one message by id, in the same shape a list element has — the files it carries included, each with a freshly signed download URL. An internal note is returned like any other message: visibility narrows the list, it does not hide a message from this tool. A message belonging to another product is reported as not found

Example

Ask your agent something like this:

Get one message by id, in the same shape a list element has — the files it carries included, each with a freshly signed download URL.

The agent will invoke support_message_get with these arguments:

{
  "id": "<id>"
}

Esc

Start typing to search the docs.

↑↓navigate↵select