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

# Preview de mensagem - resolve variáveis e retorna mensagem formatada



## OpenAPI

````yaml https://api.nuvia.ai/api/docs/user-json post /v1/campaigns/preview-message
openapi: 3.0.0
info:
  title: Nuvia API - Empresa
  description: Documentação da API para empresas
  version: '1.0'
  contact: {}
servers:
  - url: https://api.nuvia.ai
security: []
tags:
  - name: auth
    description: Autenticação
paths:
  /v1/campaigns/preview-message:
    post:
      tags:
        - campaigns
      summary: Preview de mensagem - resolve variáveis e retorna mensagem formatada
      operationId: CampaignController_previewMessage
      parameters:
        - name: x-company-id
          in: header
          description: >-
            Identificador da empresa-alvo. Obrigatório apenas para API Keys
            globais (type=global). Ignorado para API Keys de empresa e usuários
            humanos.
          required: false
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PreviewMessageDto'
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                type: object
      security:
        - JWT-auth: []
components:
  schemas:
    PreviewMessageDto:
      type: object
      properties:
        action_config:
          type: object
          properties:
            text_content:
              type: string
            template_name:
              type: string
            language_code:
              default: pt_BR
              type: string
            components:
              type: array
              items:
                type: object
                properties:
                  type:
                    type: string
                    enum:
                      - header
                      - body
                      - button
                    description: Tipo do componente (header, body, button)
                  sub_type:
                    description: Subtipo do componente (usado principalmente para botões)
                    type: string
                    enum:
                      - quick_reply
                      - url
                      - phone_number
                  index:
                    description: >-
                      Índice do componente (usado para identificar botões
                      específicos)
                    anyOf:
                      - type: string
                      - type: number
                  parameters:
                    description: Lista de parâmetros/variáveis deste componente
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                            - text
                            - image
                            - document
                            - video
                            - currency
                            - date_time
                            - payload
                          description: Tipo do parâmetro
                        image:
                          description: Configurações de imagem (quando type = "image")
                          type: object
                          properties:
                            link:
                              description: URL da imagem
                              type: string
                            id:
                              description: ID da imagem já carregada
                              type: string
                        document:
                          description: >-
                            Configurações de documento (quando type =
                            "document")
                          type: object
                          properties:
                            link:
                              description: URL do documento
                              type: string
                            filename:
                              description: Nome do arquivo do documento
                              type: string
                        video:
                          description: Configurações de vídeo (quando type = "video")
                          type: object
                          properties:
                            link:
                              description: URL do vídeo
                              type: string
                        text:
                          description: Texto do parâmetro
                          type: string
                        value:
                          description: Valor genérico do parâmetro (alias para text)
                          type: string
                        link:
                          description: Link genérico
                          type: string
                        imageUrl:
                          description: URL alternativa para imagem
                          type: string
                        imageId:
                          description: ID da imagem (quando já carregada)
                          type: string
                        documentUrl:
                          description: URL alternativa para documento
                          type: string
                        documentFilename:
                          description: Nome alternativo do arquivo
                          type: string
                        videoUrl:
                          description: URL alternativa para vídeo
                          type: string
                        currencyCode:
                          description: 'Código da moeda (ex: BRL, USD, EUR)'
                          type: string
                        currencyAmount:
                          description: Valor monetário
                          type: number
                        dateTime:
                          description: Data/hora no formato ISO 8601
                          type: string
                        payload:
                          description: Dados customizados em formato string
                          type: string
                        parameter_name:
                          description: Nome do parâmetro (para templates nomeados)
                          type: string
                        variable_ref:
                          description: >-
                            Referência a variável automática (ex:
                            V_contact_name). Se presente, o valor será resolvido
                            automaticamente do contact/business/conversation.
                          type: string
                        variable_type:
                          description: >-
                            Tipo da variável: "auto" = resolvida
                            automaticamente, "free" = input manual
                          type: string
                          enum:
                            - auto
                            - free
                      required:
                        - type
                required:
                  - type
        list_id:
          type: string
        row_id:
          type: string
        contact_id:
          type: string
        variables:
          type: object
          additionalProperties: {}
        inbox_id:
          type: string
      required:
        - action_config
  securitySchemes:
    JWT-auth:
      scheme: bearer
      bearerFormat: JWT
      type: http
      description: Token JWT de autenticação

````