Get Message

Returns details about the specified message.
get
https://youragentURL.symphony.com/agent
/v1/message/{id}
Get a message by ID
Parameters
Path
id*
string
Message ID as a URL-safe string
Header
sessionToken*
string
Session authentication token.
keyManagerToken*
string
Key Manager authentication token.
Responses
200: OK
OK
204: No Content
No Messages.
400: Bad Request
Client error, see response body for further details.
401: Unauthorized
Unauthorized: Session tokens invalid.
403: Forbidden
Forbidden: Caller lacks necessary entitlement.
500: Internal Server Error
Server error, see response body for further details.

📘 Optional attributes returned

Note that some attributes are returned in the payload only under specific conditions:
  • sharedMessage only when the message represented by this class is a wall post sharing another message;
  • initialMessageId, initialTimestamp, and replacing only when the corresponding message is sent as an update to another message thanks to Update Message endpoint. Note that the first two attributes relate to the original (and therefore first) message sent, whereas the replacing attribute relates to the message that has been updated by this message;
  • replacedBy only when this message has been updated by a new message. It contains the id of the replacing message.
  • parentMessageId only when this message is a reply or a forward of another message which id is returned in this attribute.
Last modified 2mo ago