---
title: "TextMessages.get"
method: GET
path: "/entities/TextMessages/{id}"
tags: ["Text"]
---

# TextMessages.get

`GET /entities/TextMessages/{id}`

Returns TextMessage with given id

## Path parameters

- `id` string, uuid, required

## Response `200`

TextMessage data

- object
  - `success` boolean — True when response succeeded, false on error.
  - `data` TextMessage
    - `is_delete_protected` boolean, required — Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.
    - `id` string, uuid, required — Unique identifier of entity.
    - `is_deleted` boolean — Specifies if the entity is considered deleted.
    - `modified` string, date-time — Last modification time.
    - `created` string, date-time — Creation time.
    - `chat_conversation` string, uri — Internal AI chat conversation this message belongs to, when applicable. Relation to ChatConversation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ChatConversation' object for properties.
    - `text_message_conversation` string, uri — Conversation this message belongs to. Empty for messages produced by AI chat that do not belong to a thread of customer conversation. Relation to TextMessageConversation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'TextMessageConversation' object for properties.
    - `chat_conversation_id` string, uuid — Id of the chat conversation.
    - `content` string, required — Body of the message. May be plain text or a JSON payload (e.g. AI assistant examples / suggestions).
    - `datetime_sent` string, date-time — Timestamp the message was sent.
    - `direction` 1 | 2, required — Direction of the message (Incoming, Outgoing). Integer enum value: 1 - OutgoingEmail, 2 - IncomingEmail
    - `message_sid` string — External message identifier from the SMS provider (e.g. Twilio Message SID).
    - `score` integer — Quality score given to the message by the user (e.g. for AI-suggested replies). Used to feed back into the suggestion engine.
    - `status` 1 | 2 | 3 | 4 | 5 — Delivery status of the message (e.g. Sent, Delivered, Failed). Integer enum value: 1 - Sending, 2 - Sent, 3 - Failed, 4 - Received, 5 - Seen
    - `text_message_conversation_id` string, uuid — Id of the conversation.
    - `revision` integer — Revision when entity was lastly changed.
    - `attachments` string[] — Files attached to the message (e.g. MMS attachments).
    - `content_as_html` string, required — HTML-rendered version of the message body, ready for display in chat UIs.
    - `data` string, binary, required — Structured AI payload of the message (examples or suggestions). Empty for regular text messages.
    - `topic_prompts` string, binary, required — List of suggested follow-up prompts produced by the AI for this message. Empty when the AI did not produce prompts.

## Other responses

- `404` — Sent when invalid ID is given
- `500` — unexpected error

---

[API](https://skmtc.net/aws/apis/pipeliner-cloud-api.md) · [All operations](https://skmtc.net/aws/apis/pipeliner-cloud-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/pipeliner-cloud-api/versions/e8c12ae60aca/schema)