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

# Envio de mensagem para chat

> Envia uma mensagem de texto, template ou mídia para um chat existente no escopo da chave de integração. A operação usa o usuário criador da chave como ator, exige permissão `crm/chats.write` e aguarda o retorno imediato da Meta para manter compatibilidade com integrações externas. Para mensagens interativas use `/integrations/external/chats/{id}/messages/interactive`; para localização use `/integrations/external/chats/{id}/messages/location`.




## OpenAPI

````yaml /openapi.json post /integrations/external/chats/{id}/messages
openapi: 3.0.3
info:
  title: >-
    Integração Externa - Leads, Oportunidades, Tarefas, Arquivos, Propostas,
    Chats, Satisfação e Campos Personalizados
  version: 1.0.0
  description: >
    Documentação oficial da API externa da Wegly para campos personalizados,
    leads, oportunidades, tarefas, arquivos, propostas, chats e satisfação
    (`/integrations/external/custom-fields`, `/integrations/external/files`,
    `/integrations/external/leads`, `/integrations/external/deals`,
    `/integrations/external/tasks`, `/integrations/external/proposals`,
    `/integrations/external/chats` e `/integrations/external/satisfaction`).
    Todas as descrições estão em português e refletem as regras aplicadas pelo
    serviço.
servers:
  - url: https://api.wegly.com.br
    description: Ambiente de produção Wegly
security:
  - bearerAuth: []
tags:
  - name: Campos Personalizados
    description: >-
      Consulta dos campos personalizados disponíveis para uso nas integrações
      externas.
  - name: Arquivos
    description: >-
      Upload de arquivos públicos de integração vinculados diretamente a leads
      ou oportunidades.
  - name: Leads
    description: >-
      Operações de listagem, criação, consulta e atualização de leads via
      integração externa.
  - name: Oportunidades
    description: Operações de criação de oportunidades (deals) via integração externa.
  - name: Tarefas
    description: >-
      Operações de listagem, criação, consulta, atualização e remoção de tarefas
      vinculadas a leads, oportunidades, entregas, pessoas ou organizações.
  - name: Satisfação
    description: >-
      Geração de links públicos para formulários de satisfação via integração
      externa.
  - name: Propostas
    description: >-
      Operações de listagem, criação, consulta, atualização e remoção de
      propostas via integração externa.
  - name: Chats
    description: >-
      Operações principais de listagem, criação, consulta e resumo de não lidas
      de chats via integração externa.
paths:
  /integrations/external/chats/{id}/messages:
    post:
      tags:
        - Chats
      summary: Envio de mensagem para chat
      description: >
        Envia uma mensagem de texto, template ou mídia para um chat existente no
        escopo da chave de integração. A operação usa o usuário criador da chave
        como ator, exige permissão `crm/chats.write` e aguarda o retorno
        imediato da Meta para manter compatibilidade com integrações externas.
        Para mensagens interativas use
        `/integrations/external/chats/{id}/messages/interactive`; para
        localização use `/integrations/external/chats/{id}/messages/location`.
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: UUID do chat que receberá a mensagem.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SendExternalChatMessage'
            examples:
              texto:
                summary: Mensagem de texto
                value:
                  type: text
                  body: Olá, tudo bem?
              template:
                summary: Mensagem com template
                value:
                  type: template
                  template:
                    name: saudacao_inicial
                    language: pt_BR
                  template_fields:
                    - component: BODY
                      type: TEXT
                      index: 1
                      value: João
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/SendExternalChatMessageMultipart'
            encoding:
              files:
                style: form
                explode: true
              file:
                style: form
                explode: true
              template:
                contentType: application/json
              template_fields:
                contentType: application/json
      responses:
        '201':
          description: Mensagem enviada e registrada no chat.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChatMessagesResponse'
        '400':
          description: >-
            Payload inválido, mensagem sem conteúdo, template inválido, arquivo
            ausente/incompatível ou regra de negócio não atendida.
        '401':
          description: Token de integração ausente ou inválido.
        '403':
          description: >-
            Permissão `crm/chats.write` ausente, chat fora do escopo da chave ou
            usuário sem acesso ao número.
        '404':
          description: >-
            Chat, número de WhatsApp, conexão ou mensagem de referência não
            encontrados.
        '500':
          description: Falha ao enviar a mensagem para o provedor ou ao registrar o envio.
components:
  schemas:
    SendExternalChatMessage:
      type: object
      description: >-
        Payload para envio de mensagem textual, template ou mídia em um chat
        existente.
      properties:
        type:
          $ref: '#/components/schemas/SendExternalChatMessageTypeEnum'
        body:
          type: string
          description: Texto da mensagem ou legenda de mídia, conforme o tipo enviado.
        reference_wamid:
          type: string
          maxLength: 200
          description: >-
            Identificador da mensagem do WhatsApp que será respondida, quando
            houver.
        template:
          $ref: '#/components/schemas/ChatTemplateInfo'
        template_fields:
          type: array
          items:
            $ref: '#/components/schemas/ChatTemplateField'
      example:
        type: text
        body: Olá, tudo bem?
    SendExternalChatMessageMultipart:
      allOf:
        - $ref: '#/components/schemas/SendExternalChatMessage'
        - type: object
          description: >-
            Payload multipart para envio de mídia. Os campos `template` e
            `template_fields`, quando enviados por formulário, podem ser
            serializados como JSON.
          properties:
            files:
              type: array
              description: Arquivos enviados no campo `files`.
              items:
                type: string
                format: binary
            file:
              type: array
              description: Arquivos enviados no campo alternativo `file`.
              items:
                type: string
                format: binary
    ChatMessagesResponse:
      type: object
      properties:
        total:
          type: integer
          description: Quantidade de mensagens retornadas pela operação.
        records:
          type: array
          items:
            $ref: '#/components/schemas/ChatMessageSummary'
    SendExternalChatMessageTypeEnum:
      type: string
      enum:
        - text
        - reaction
        - image
        - video
        - audio
        - document
        - template
        - call
      description: >-
        Tipo de mensagem aceito no endpoint principal. Mensagens interativas e
        de localização possuem endpoints próprios.
    ChatTemplateInfo:
      type: object
      required:
        - name
        - language
      properties:
        name:
          type: string
        language:
          type: string
    ChatTemplateField:
      type: object
      required:
        - component
        - type
        - value
      properties:
        component:
          type: string
          enum:
            - HEADER
            - BODY
            - BUTTONS
        type:
          type: string
          enum:
            - TEXT
            - IMAGE
            - VIDEO
            - DOCUMENT
            - LOCATION
        value:
          type: string
        index:
          type: number
        button_index:
          type: number
        card_index:
          type: number
    ChatMessageSummary:
      type: object
      properties:
        id:
          type: string
          format: uuid
        type:
          $ref: '#/components/schemas/ChatMessageTypeEnum'
        origin:
          $ref: '#/components/schemas/ChatMessageOriginEnum'
        from_me:
          type: boolean
        sent_via:
          $ref: '#/components/schemas/ChatMessageSentViaEnum'
        status:
          $ref: '#/components/schemas/ChatMessageDeliveryStatusEnum'
        body_text:
          type: string
          nullable: true
        content_payload:
          type: object
          nullable: true
          additionalProperties: true
        reactions:
          type: array
          items:
            $ref: '#/components/schemas/ChatReaction'
        meta_timestamp:
          type: string
        is_history:
          type: boolean
        history_phase:
          type: integer
          nullable: true
        history_chunk_order:
          type: integer
          nullable: true
        history_progress:
          type: integer
          nullable: true
        is_media_placeholder:
          type: boolean
        agent:
          type: object
          nullable: true
          properties:
            id:
              type: string
              format: uuid
            user:
              type: object
              allOf:
                - $ref: '#/components/schemas/ExternalUserSummary'
              nullable: true
        user:
          type: object
          allOf:
            - $ref: '#/components/schemas/ExternalUserSummary'
          nullable: true
        crm_marketing_lead_source:
          type: array
          nullable: true
          items:
            type: object
            additionalProperties: true
    ChatMessageTypeEnum:
      type: string
      enum:
        - text
        - reaction
        - image
        - video
        - audio
        - document
        - template
        - interactive
        - location
        - call
        - contacts
        - unsupported
    ChatMessageOriginEnum:
      type: string
      enum:
        - INBOUND
        - API_OUTBOUND
        - MOBILE_APP_ECHO
        - SYSTEM
    ChatMessageSentViaEnum:
      type: string
      enum:
        - CONTACT
        - API
        - MOBILE_DEVICE
        - SYSTEM
    ChatMessageDeliveryStatusEnum:
      type: string
      enum:
        - processing
        - sent
        - delivered
        - read
        - failed
        - received
        - deleted
    ChatReaction:
      type: object
      properties:
        id:
          type: string
          format: uuid
        emoji:
          type: string
        actor:
          type: string
          enum:
            - CONTACT
            - BUSINESS
        reactor_wa_id:
          type: string
        reactor_user_id:
          type: string
          format: uuid
          nullable: true
        created_at:
          type: string
          format: date-time
    ExternalUserSummary:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        avatar:
          type: string
          nullable: true
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        Utilize o token de integração no header `Authorization: Bearer {token}`.
        O domínio de origem (Origin/Referer) deve respeitar `allowed_domain`,
        quando configurado na chave.

````