---
title: "Obter por ID"
method: GET
path: "/v1/message/{id}"
tags: ["Mensagens"]
---

# Obter por ID

`GET /v1/message/{id}`

## Path parameters

- `id` string, uuid, required

## Response `200`

Success

- PublicMessageDTO
  - `id` string, uuid
  - `createdAt` string, date-time
  - `updatedAt` string, date-time
  - `timestamp` string, date-time, nullable
  - `type` 'TEXT' | 'STICKER' | 'IMAGE' | 'AUDIO' | 'VIDEO' | 'DOCUMENT' | 'CONTACT' | 'LOCATION' | 'LIST' | 'BUTTONS' | 'TRANSITION' | 'TRACK' | 'NOTE'
  - `senderId` string, nullable
  - `sessionId` string, uuid
  - `templateId` string, uuid, nullable
  - `userId` string, uuid, nullable
  - `direction` 'FROM_HUB' | 'TO_HUB'
  - `status` 'PROCESSING' | 'SAVED' | 'QUEUED' | 'SENT' | 'DELIVERED' | 'READ' | 'FAILED' | 'DELETED' | 'WAIT_REPLY'
  - `origin` 'DEFAULT' | 'CAMPAIGN' | 'OFFICE_HOURS' | 'BOT' | 'API' | 'PAYMENT' | 'GATEWAY'
  - `text` string, nullable
  - `fileId` string, uuid, nullable
  - `refId` string, uuid, nullable
  - `readContactAt` string, date-time, nullable
  - `details` PublicMessageDetailsDTO
    - `file` PublicFileDTO
      - `id` string, uuid
      - `companyId` string, uuid, nullable
      - `userId` string, uuid, nullable
      - `name` string, nullable
      - `extension` string, nullable
      - `mimeType` string, nullable
      - `type` 'UNDEFINED' | 'PDF' | 'EXCEL' | 'WORD' | 'IMAGE' | 'AUDIO' | 'VIDEO'
      - `publicUrl` string, nullable
      - `publicUrlDownload` string, nullable
      - `size` integer
      - `isThumbnail` boolean
      - `thumbnail` PublicFileThumbnailDTO
        - `id` string, uuid
        - `publicUrl` string, nullable
    - `files` PublicFileDTO[], nullable
      - `id` string, uuid
      - `companyId` string, uuid, nullable
      - `userId` string, uuid, nullable
      - `name` string, nullable
      - `extension` string, nullable
      - `mimeType` string, nullable
      - `type` 'UNDEFINED' | 'PDF' | 'EXCEL' | 'WORD' | 'IMAGE' | 'AUDIO' | 'VIDEO'
      - `publicUrl` string, nullable
      - `publicUrlDownload` string, nullable
      - `size` integer
      - `isThumbnail` boolean
      - `thumbnail` PublicFileThumbnailDTO
        - `id` string, uuid
        - `publicUrl` string, nullable
    - `fileAsLink` PublicMessageFileAsLinkDTO
      - `file` PublicFileDTO
        - `id` string, uuid
        - `companyId` string, uuid, nullable
        - `userId` string, uuid, nullable
        - `name` string, nullable
        - `extension` string, nullable
        - `mimeType` string, nullable
        - `type` 'UNDEFINED' | 'PDF' | 'EXCEL' | 'WORD' | 'IMAGE' | 'AUDIO' | 'VIDEO'
        - `publicUrl` string, nullable
        - `publicUrlDownload` string, nullable
        - `size` integer
        - `isThumbnail` boolean
        - `thumbnail` PublicFileThumbnailDTO
          - `id` string, uuid
          - `publicUrl` string, nullable
      - `shortUrl` string, nullable
    - `location` PublicMessageLocationDTO
      - `latitude` number, double
      - `longitude` number, double
      - `address` string, nullable
      - `name` string, nullable
      - `url` string, nullable
    - `contact` PublicMessageContactDTO
      - `name` string, nullable
      - `email` string, nullable
      - `phoneNumber` string, nullable
      - `phoneNumberFormatted` string, nullable
    - `errors` PublicMessageErrorDTO[], nullable
      - `date` string, date-time
      - `origin` string, nullable
      - `key` string, nullable
      - `text` string, nullable
    - `footerText` string, nullable
    - `utm` PublicUtmDTO
      - `sourceId` string, nullable
      - `source` string, nullable
      - `clid` string, nullable
      - `medium` string, nullable
      - `campaign` string, nullable
      - `content` string, nullable
      - `headline` string, nullable
      - `term` string, nullable
      - `referralUrl` string, nullable
    - `payTransactionId` string, uuid, nullable
    - `reactionToContact` 'SMILE' | 'SAD' | 'WOW' | 'LOVE', nullable
    - `reactionFromContact` string, nullable
    - `track` PublicMessageTrackDTO
      - `id` string, uuid
      - `createdAt` string, date-time
      - `type` 'ACCESS_PAGE' | 'START_CHAT' | 'SAVE_CONTACT'
      - `pageTitle` string, nullable
      - `pageUrl` string, nullable
      - `pageUtm` PublicUtmDTO
        - `sourceId` string, nullable
        - `source` string, nullable
        - `clid` string, nullable
        - `medium` string, nullable
        - `campaign` string, nullable
        - `content` string, nullable
        - `headline` string, nullable
        - `term` string, nullable
        - `referralUrl` string, nullable
      - `isMobileDevice` boolean
      - `formData` PublicMessageTrackFromDataDTO
        - `name` string, nullable
        - `email` string, nullable
        - `phoneNumber` string, nullable
        - `annotation` string, nullable
    - `transcription` PublicMsgTranscriptionDTO
      - `text` string, nullable
      - `processing` boolean
      - `error` boolean
    - `templateCategoryId` string, uuid, nullable
    - `templateCategoryName` string, nullable
    - `waitReply` boolean
  - `failedReason` string, nullable
  - `filesIds` string[], nullable

## Other responses

- `500` — Server Error

---

[API](https://skmtc.net/helena/apis/core.md) · [All operations](https://skmtc.net/helena/apis/core/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/helena/core/versions/811b2cdd2ec2/schema)