> ## Documentation Index
> Fetch the complete documentation index at: https://br.developers.hubspot.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Get a message

> Obtenha os detalhes de uma mensagem específica enviada por meio de um canal personalizado

> **Supported products**

> **Required Scopes**


## OpenAPI

````yaml specs/2026-09/conversations-custom-channels-v2026-09.json GET /conversations/custom-channels/2026-09/{channelId}/messages/{messageId}
openapi: 3.0.1
info:
  title: Conversations Custom Channels
  description: Basepom for all HubSpot Projects
  version: 2026-09
  x-hubspot-product-tier-requirements:
    marketing: FREE
    sales: PROFESSIONAL
    service: PROFESSIONAL
    cms: FREE
    commerce: FREE
    crmHub: FREE
    dataHub: FREE
  x-hubspot-api-use-case: >-
    Allow admins to install an integration with a third-party messaging channel
    that your team uses to communicate with customers, to allow users in your
    account to manage their conversations for that channel directly in HubSpot.
  x-hubspot-introduction: >-
    Use the custom channels API to create custom channels to build a bridge
    between an external message service and HubSpot's inbox or help desk
    features. 
servers:
  - url: https://api.hubapi.com
security: []
tags:
  - name: Basic
  - name: Channel accounts
  - name: Channels
  - name: Messages
paths:
  /conversations/custom-channels/2026-09/{channelId}/messages/{messageId}:
    get:
      tags:
        - Messages
      summary: Obtenha uma mensagem
      description: >-
        Obtenha os detalhes de uma mensagem específica enviada por meio de um
        canal personalizado
      operationId: >-
        get-/conversations/custom-channels/2026-09/{channelId}/messages/{messageId}
      parameters:
        - name: channelId
          in: path
          description: >-
            O identificador exclusivo do canal personalizado do qual a mensagem
            deve ser recuperada.
          required: true
          style: simple
          explode: false
          schema:
            type: integer
            format: int32
        - name: messageId
          in: path
          description: O identificador exclusivo da mensagem a ser recuperada.
          required: true
          style: simple
          explode: false
          schema:
            type: string
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicConversationsMessage'
        default:
          $ref: '#/components/responses/Error'
          description: ''
      security:
        - oauth2:
            - conversations.custom_channels.read
components:
  schemas:
    PublicConversationsMessage:
      required:
        - archived
        - attachments
        - channelAccountId
        - channelId
        - client
        - conversationsThreadId
        - createdAt
        - createdBy
        - direction
        - id
        - recipients
        - senders
        - text
        - truncationStatus
        - type
      type: object
      properties:
        archived:
          type: boolean
          description: Booleano que indica se a mensagem está arquivada.
        attachments:
          type: array
          description: >-
            Uma matriz de anexos incluídos na mensagem, que podem ser arquivos,
            localizações, contatos ou outros tipos compatíveis.
          items:
            oneOf:
              - $ref: '#/components/schemas/PublicFile'
              - $ref: '#/components/schemas/PublicLocation'
              - $ref: '#/components/schemas/PublicContact'
              - $ref: '#/components/schemas/PublicUnsupportedContent'
              - $ref: '#/components/schemas/PublicMessageHeader'
              - $ref: '#/components/schemas/PublicQuickReplies'
              - $ref: '#/components/schemas/PublicWhatsAppTemplateMetadata'
              - $ref: '#/components/schemas/PublicSocialMetadataAttachment'
        channelAccountId:
          type: string
          description: O identificador da conta de canal associada à mensagem.
        channelId:
          type: string
          description: O identificador do canal pelo qual a mensagem foi enviada.
        client:
          $ref: '#/components/schemas/PublicClient'
        conversationsThreadId:
          type: string
          description: >-
            O identificador do thread de conversa ao qual esta mensagem
            pertence.
        createdAt:
          type: string
          description: A data e a hora em que a mensagem foi criada, no formato ISO 8601.
          format: date-time
        createdBy:
          type: string
          description: O identificador do usuário ou sistema que criou a mensagem.
        direction:
          type: string
          description: A direção da mensagem, seja "INCOMING" ou "OUTGOING".
          enum:
            - INCOMING
            - OUTGOING
        id:
          type: string
          description: O identificador exclusivo da mensagem.
        inReplyToId:
          type: string
          description: >-
            O identificador da mensagem a que esta mensagem responde, se
            aplicável.
        recipients:
          type: array
          description: >-
            Uma matriz de destinatários da mensagem, cada um contendo detalhes
            do destinatário.
          items:
            $ref: '#/components/schemas/PublicRecipient'
        richText:
          type: string
          description: O conteúdo de rich text da mensagem, se disponível.
        senders:
          type: array
          description: >-
            Uma matriz de remetentes associados à mensagem, cada um contendo
            detalhes do remetente.
          items:
            $ref: '#/components/schemas/PublicSender'
        status:
          $ref: '#/components/schemas/PublicMessageStatus'
        subject:
          type: string
          description: O assunto da mensagem, se aplicável.
        text:
          type: string
          description: O conteúdo de texto simples da mensagem.
        truncationStatus:
          type: string
          description: >-
            Indica se o conteúdo da mensagem está truncado. Os valores válidos
            são "NOT_TRUNCATED", "TRUNCATED_TO_MOST_RECENT_REPLY" e "TRUNCATED".
          enum:
            - NOT_TRUNCATED
            - TRUNCATED
            - TRUNCATED_TO_MOST_RECENT_REPLY
        type:
          type: string
          description: O tipo da mensagem, que é sempre 'MESSAGE'.
          default: MESSAGE
          enum:
            - MESSAGE
        updatedAt:
          type: string
          description: >-
            A data e a hora da última atualização da mensagem, no formato ISO
            8601.
          format: date-time
      x-hubspot-sub-type-impl: true
    PublicFile:
      title: FILE
      required:
        - fileId
        - fileUsageType
        - type
      type: object
      properties:
        fileId:
          type: string
          description: Uma string que representa o identificador exclusivo do arquivo.
        fileUsageType:
          type: string
          description: >-
            Uma string que especifica o tipo de uso do arquivo, que pode ser
            'STICKER', 'VOICE_RECORDING', 'IMAGE', 'AUDIO' ou 'OTHER'.
          enum:
            - AUDIO
            - IMAGE
            - OTHER
            - STICKER
            - VOICE_RECORDING
        name:
          type: string
          description: Uma string contendo o nome do arquivo.
        type:
          type: string
          description: Uma string que indica o tipo do anexo, que é sempre 'FILE'.
          default: FILE
          enum:
            - FILE
        url:
          type: string
          description: Uma string que contém o URL onde o arquivo pode ser acessado.
      x-hubspot-sub-type-impl: true
    PublicLocation:
      title: LOCATION
      required:
        - latitude
        - longitude
        - type
      type: object
      properties:
        address:
          type: string
          description: Uma string que representa o endereço do local.
        latitude:
          type: number
          description: Um número que representa a latitude do local.
        longitude:
          type: number
          description: Um número que representa a longitude do local.
        name:
          type: string
          description: Uma string que representa o nome do local.
        type:
          type: string
          description: Uma string que especifica o tipo do componente, que é 'LOCATION'.
          default: LOCATION
          enum:
            - LOCATION
        url:
          type: string
          description: Uma string que representa um URL associado ao local.
      x-hubspot-sub-type-impl: true
    PublicContact:
      title: CONTACT
      required:
        - contactProfile
        - type
      type: object
      properties:
        contactProfile:
          $ref: '#/components/schemas/ContactProfile'
        type:
          type: string
          description: >-
            Uma string que indica o tipo do componente, que é "CONTACT" por
            padrão.
          default: CONTACT
          enum:
            - CONTACT
      x-hubspot-sub-type-impl: true
    PublicUnsupportedContent:
      title: UNSUPPORTED_CONTENT
      required:
        - type
      type: object
      properties:
        type:
          type: string
          description: >-
            Uma string que especifica o tipo de conteúdo não compatível. O valor
            padrão e único válido é "UNSUPPORTED_CONTENT".
          default: UNSUPPORTED_CONTENT
          enum:
            - UNSUPPORTED_CONTENT
      x-hubspot-sub-type-impl: true
    PublicMessageHeader:
      title: MESSAGE_HEADER
      required:
        - type
      type: object
      properties:
        fileId:
          type: integer
          description: >-
            Um número inteiro que representa o ID de um arquivo associado,
            formatado como um int64.
          format: int64
        text:
          type: string
          description: Uma string que contém o conteúdo de texto do cabeçalho da mensagem.
        type:
          type: string
          description: >-
            Uma string que indica o tipo do cabeçalho da mensagem. O valor
            padrão e único válido é 'MESSAGE_HEADER'.
          default: MESSAGE_HEADER
          enum:
            - MESSAGE_HEADER
      x-hubspot-sub-type-impl: true
    PublicQuickReplies:
      title: QUICK_REPLIES
      required:
        - allowMultiSelect
        - allowUserInput
        - quickReplies
        - type
      type: object
      properties:
        allowMultiSelect:
          type: boolean
          description: >-
            Um booleano que indica se várias respostas rápidas podem ser
            selecionadas pelo usuário.
        allowUserInput:
          type: boolean
          description: >-
            Um booleano que indica se o usuário pode inserir sua própria
            resposta, além de selecionar entre as respostas rápidas.
        quickReplies:
          type: array
          description: >-
            Uma matriz de objetos QuickReply, cada um representando uma única
            opção de resposta rápida disponível para o usuário.
          items:
            $ref: '#/components/schemas/QuickReply'
        type:
          type: string
          description: Uma string que indica o tipo do componente, que é "QUICK_REPLIES".
          default: QUICK_REPLIES
          enum:
            - QUICK_REPLIES
      x-hubspot-sub-type-impl: true
    PublicWhatsAppTemplateMetadata:
      title: WHATSAPP_TEMPLATE_METADATA
      required:
        - crmObjectIds
        - parameters
        - type
      type: object
      properties:
        contentId:
          type: integer
          description: >-
            Um número inteiro que representa o ID do conteúdo associado ao
            modelo. Este é um número inteiro de 64 bits.
          format: int64
        crmObjectIds:
          type: object
          additionalProperties:
            type: integer
            format: int64
          description: >-
            Um objeto que mapeia tipos de objetos do CRM aos seus respectivos
            IDs, em que cada ID é um número inteiro de 64 bits.
        mappedTemplateId:
          type: integer
          description: >-
            Um número inteiro que representa o ID do modelo mapeado. Este é um
            número inteiro de 64 bits.
          format: int64
        parameters:
          type: object
          additionalProperties:
            type: string
          description: >-
            Um objeto que contém pares de chave-valor de parâmetros usados para
            personalização de modelo, em que cada valor é uma string.
        rootMicId:
          type: integer
          description: >-
            Um número inteiro que representa o ID do contexto de interação da
            mensagem raiz. Este é um número inteiro de 64 bits.
          format: int64
        type:
          type: string
          description: >-
            Uma string que indica o tipo de metadados, que é
            'WHATSAPP_TEMPLATE_METADATA'.
          default: WHATSAPP_TEMPLATE_METADATA
          enum:
            - WHATSAPP_TEMPLATE_METADATA
      x-hubspot-sub-type-impl: true
    PublicSocialMetadataAttachment:
      title: SOCIAL_MEDIA_METADATA
      required:
        - socialMetadata
        - type
      type: object
      properties:
        socialMetadata:
          $ref: '#/components/schemas/SocialMetadata'
        type:
          type: string
          description: >-
            Uma string que indica o tipo de anexo, que é
            'SOCIAL_MEDIA_METADATA'.
          default: SOCIAL_MEDIA_METADATA
          enum:
            - SOCIAL_MEDIA_METADATA
      x-hubspot-sub-type-impl: true
    PublicClient:
      required:
        - clientType
      type: object
      properties:
        clientType:
          type: string
          description: >-
            O tipo de cliente que está interagindo com a API. Os valores válidos
            incluem "HUBSPOT", "SYSTEM", "INTEGRATION" e "UNKNOWN".
          enum:
            - HUBSPOT
            - INTEGRATION
            - SYSTEM
            - UNKNOWN
        integrationAppId:
          type: integer
          description: >-
            O identificador exclusivo para o aplicativo de integração associado
            a este cliente. É um valor inteiro.
          format: int32
    PublicRecipient:
      required:
        - deliveryIdentifier
      type: object
      properties:
        actorId:
          type: string
          description: >-
            Uma string que representa o identificador exclusivo do ator
            associado ao destinatário.
        deliveryIdentifier:
          $ref: '#/components/schemas/PublicDeliveryIdentifier'
        name:
          type: string
          description: Uma string que representa o nome do destinatário.
        recipientField:
          type: string
          description: >-
            Uma string que representa um campo específico relacionado ao
            destinatário.
    PublicSender:
      type: object
      properties:
        actorId:
          type: string
          description: >-
            O identificador exclusivo do remetente, representado como uma
            string.
        deliveryIdentifier:
          $ref: '#/components/schemas/PublicDeliveryIdentifier'
        name:
          type: string
          description: O nome do remetente, representado como uma string.
        senderField:
          type: string
          description: >-
            Um campo de string associado ao remetente, seu uso específico não é
            detalhado na especificação.
    PublicMessageStatus:
      required:
        - statusType
      type: object
      properties:
        failureDetails:
          $ref: '#/components/schemas/PublicMessageFailureDetails'
        statusType:
          type: string
          description: >-
            O status atual da mensagem. Os valores válidos incluem "SENT",
            "FAILED", "RECEIVED" e "READ".
          enum:
            - FAILED
            - READ
            - RECEIVED
            - SENT
    Error:
      required:
        - category
        - correlationId
        - message
      type: object
      properties:
        category:
          type: string
          description: A categoria de erro
        context:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: Contexto sobre a condição do erro
          example: >-
            {invalidPropertyName=[propertyValue], missingScopes=[scope1,
            scope2]}
        correlationId:
          type: string
          description: >-
            Um identificador exclusivo para a solicitação. Inclua este valor em
            relatórios de erro ou tickets de suporte
          format: uuid
          example: aeb5f871-7f07-4993-9211-075dc63e7cbf
        errors:
          type: array
          description: mais informações sobre o erro
          items:
            $ref: '#/components/schemas/ErrorDetail'
        links:
          type: object
          additionalProperties:
            type: string
          description: >-
            Um mapa de nomes de links para URIs associados que contêm
            documentação sobre o erro ou as etapas de correção recomendadas
        message:
          type: string
          description: >-
            Uma mensagem legível por humanos que descreve o erro, juntamente com
            as etapas de correção, quando apropriado
          example: An error occurred
        subCategory:
          type: string
          description: >-
            Uma categoria específica que contém mais detalhes específicos sobre
            o erro
      description: >-
        Representa uma resposta de erro retornada pela API quando uma operação
        falha. Este componente é usado em vários endpoints para fornecer
        informações detalhadas sobre o erro encontrado.
      example:
        message: Invalid input (details will vary based on the error)
        correlationId: aeb5f871-7f07-4993-9211-075dc63e7cbf
        category: VALIDATION_ERROR
        links:
          knowledge-base: https://www.hubspot.com/products/service/knowledge-base
    ContactProfile:
      required:
        - addresses
        - emails
        - phones
        - urls
      type: object
      properties:
        addresses:
          type: array
          description: >-
            Uma matriz de endereços associados ao contato, em que cada endereço
            inclui detalhes como tipo (por exemplo, HOME, WORK), rua, cidade,
            estado, CEP, país e código do país.
          items:
            $ref: '#/components/schemas/ContactAddress'
        emails:
          type: array
          description: >-
            Uma matriz de endereços de e-mail do contato, em que cada e-mail
            possui um tipo (por exemplo, HOME, WORK) e o próprio endereço de
            e-mail.
          items:
            $ref: '#/components/schemas/ContactEmail'
        name:
          $ref: '#/components/schemas/ContactName'
        org:
          $ref: '#/components/schemas/ContactOrg'
        phones:
          type: array
          description: >-
            Uma matriz de números de telefone do contato, em que cada número
            inclui um tipo (por exemplo, CELL, MAIN, HOME, WORK) e o número de
            telefone.
          items:
            $ref: '#/components/schemas/ContactPhone'
        urls:
          type: array
          description: >-
            Uma matriz de URLs relacionadas ao contato, em que cada URL inclui
            um tipo (por exemplo, HOME, WORK) e a própria URL.
          items:
            $ref: '#/components/schemas/ContactUrl'
    QuickReply:
      required:
        - value
        - valueType
      type: object
      properties:
        label:
          type: string
          description: >-
            O rótulo exibido ao usuário para a opção de resposta rápida. É uma
            string.
        value:
          type: string
          description: >-
            O valor associado à resposta rápida, geralmente usado como a
            resposta quando a resposta rápida é selecionada. É uma string.
        valueType:
          type: string
          description: >-
            O tipo do valor, indicando como ele deve ser interpretado. É uma
            string e pode ser "TEXT" ou "URL".
          enum:
            - TEXT
            - URL
    SocialMetadata:
      required:
        - mediaType
      type: object
      properties:
        description:
          type: string
          description: Uma descrição do conteúdo de mídia.
        id:
          type: string
          description: O identificador exclusivo para este conteúdo de mídia.
        mediaTitle:
          type: string
          description: O título do conteúdo de mídia.
        mediaType:
          type: string
          description: >-
            O tipo de conteúdo de mídia, como "PHOTO", "VIDEO", "CAROUSEL",
            "LINK", "ARTICLE", "GIF", "DOCUMENT", "POLL", "NONE", "STORY" ou
            "AUDIO".
          enum:
            - ARTICLE
            - AUDIO
            - CAROUSEL
            - DOCUMENT
            - GIF
            - LINK
            - NONE
            - PHOTO
            - POLL
            - STORY
            - VIDEO
        mediaUrl:
          type: string
          description: O URL onde o conteúdo de mídia está localizado.
        mediaUrlString:
          type: string
          description: Uma string que representa a URL do conteúdo de mídia.
        thumbnailUrl:
          type: string
          description: O URL da imagem em miniatura para o conteúdo de mídia.
    PublicDeliveryIdentifier:
      required:
        - type
        - value
      type: object
      properties:
        type:
          type: string
          description: >-
            Uma string que representa o tipo de identificador de entrega. Os
            valores válidos incluem 'HS_EMAIL_ADDRESS', 'HS_PHONE_NUMBER',
            'HS_SHORT_CODE' e 'CHANNEL_SPECIFIC_OPAQUE_ID'.
          enum:
            - CHANNEL_SPECIFIC_OPAQUE_ID
            - HS_EMAIL_ADDRESS
            - HS_PHONE_NUMBER
            - HS_SHORT_CODE
        value:
          type: string
          description: >-
            Uma string que representa o valor associado ao tipo de identificador
            de entrega.
    PublicMessageFailureDetails:
      required:
        - errorMessageTokens
      type: object
      properties:
        errorMessage:
          type: string
          description: >-
            Uma string que contém uma descrição legível por humanos do erro que
            ocorreu durante a entrega da mensagem.
        errorMessageTokens:
          type: object
          additionalProperties:
            type: string
          description: >-
            Um objeto que contém pares chave-valor, em que cada chave é um nome
            de token e cada valor é uma string. Esses tokens fornecem contexto
            ou detalhes adicionais relacionados à mensagem de erro.
    ErrorDetail:
      required:
        - message
      type: object
      properties:
        code:
          type: string
          description: O código de status associado ao detalhe do erro
        context:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: Contexto sobre a condição do erro
          example: '{missingScopes=[scope1, scope2]}'
        in:
          type: string
          description: O nome do campo ou parâmetro no qual o erro foi encontrado.
        message:
          type: string
          description: >-
            Uma mensagem legível por humanos que descreve o erro, juntamente com
            as etapas de correção, quando apropriado
        subCategory:
          type: string
          description: >-
            Uma categoria específica que contém mais detalhes específicos sobre
            o erro
      description: >-
        Representa informações detalhadas sobre um erro ocorrido na API. Este
        componente é usado para fornecer contexto e detalhes adicionais sobre os
        erros, geralmente como parte de uma resposta de erro.
    ContactAddress:
      type: object
      properties:
        city:
          type: string
          description: A cidade onde o contato está localizado. É um valor de string.
        country:
          type: string
          description: O país onde o contato está localizado. É um valor de string.
        countryCode:
          type: string
          description: >-
            O código que representa o país do endereço do contato. É um valor de
            string.
        state:
          type: string
          description: Estado onde o contato está localizado. É um valor de string.
        street:
          type: string
          description: O endereço do contato. É um valor de string.
        type:
          type: string
          description: O tipo de endereço, que pode ser 'HOME' ou 'WORK'.
          enum:
            - HOME
            - WORK
        zip:
          type: string
          description: O código postal do endereço do contato. É um valor de string.
    ContactEmail:
      required:
        - email
      type: object
      properties:
        email:
          type: string
          description: O endereço de e-mail real do contato, representado como uma string.
        type:
          type: string
          description: O tipo de endereço de e-mail, que pode ser "HOME" ou "WORK".
          enum:
            - HOME
            - WORK
    ContactName:
      type: object
      properties:
        firstName:
          type: string
          description: Uma string que representa o primeiro nome do contato.
        lastName:
          type: string
          description: Uma string que representa o sobrenome do contato.
        middleName:
          type: string
          description: Uma string que representa o nome do meio do contato.
        prefix:
          type: string
          description: >-
            Uma string que representa o prefixo do nome do contato, como "Sr.",
            "Sra." ou "Dr.".
        suffix:
          type: string
          description: >-
            Uma string que representa o sufixo do nome do contato, como "Jr.",
            "Sr." ou "III".
    ContactOrg:
      type: object
      properties:
        company:
          type: string
          description: >-
            O nome da empresa à qual o contato está associado. É um valor de
            string.
        department:
          type: string
          description: >-
            O departamento da empresa onde o contato trabalha. É um valor de
            string.
        title:
          type: string
          description: O cargo do contato na empresa. É um valor de tipo string.
    ContactPhone:
      required:
        - phone
      type: object
      properties:
        phone:
          type: string
          description: >-
            O número de telefone associado ao contato. Esta é uma string que
            representa o número de telefone do contato.
        type:
          type: string
          description: 'O tipo de telefone, que pode ser: "CELL", "MAIN", "HOME" ou "WORK".'
          enum:
            - CELL
            - HOME
            - MAIN
            - WORK
    ContactUrl:
      required:
        - url
      type: object
      properties:
        type:
          type: string
          description: >-
            A categoria do URL, indicando sua finalidade. Os valores válidos
            incluem "HOME" e "WORK".
          enum:
            - HOME
            - WORK
        url:
          type: string
          description: O URL real associado ao contato.
  responses:
    Error:
      description: An error occurred.
      content:
        '*/*':
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://app.hubspot.com/oauth/authorize
          tokenUrl: https://api.hubapi.com/oauth/v1/token
          scopes:
            conversations.custom_channels.read: ''
            conversations.custom_channels.write: ''

````