---
title: "Enviar síncrono"
method: POST
path: "/v1/message/send-sync"
tags: ["Mensagens"]
---

# Enviar síncrono

`POST /v1/message/send-sync`

Este endpoint segue as mesmas regras do canal de atendimento, por exemplo: uma conversa só pode ser iniciada no WhatsApp utilizando um modelo de mensagem.<br />Caso o contato não esteja cadastrado, ele será cadastrado automaticamente antes do envio.<br />O envio da mensagem será síncrono, então ele pode demorar um tempo até que o servidor do canal de atencimento responda com um status válido para a mensagem.<br />O tempo máximo que este metodo esperará uma resposta é de 25 segundos, após este tempo ele entregará a última situação da mensagem;

## Request body

- PublicReqQuickSendMessageDTO
  - `from` string, nullable — Número de telefone do canal cadastrado na conta.
  - `to` string, required — Número de telefone do destinatário.
  - `botId` string, uuid, nullable — ID do bot que será ativado após a resposta do contato.
  - `body` PublicQuickSendBodyDTO, required
    - `text` string, nullable — Texto da mensagem a ser enviada. Obrigatório caso não seja informado o parâmetro `templateId` ou `fileUrl`.
    - `templateId` string, nullable — ID do modelo de mensagem para a mensagem a ser enviada. Obrigatório caso não seja informado o parâmetro `text` ou `fileUrl`.
    - `parameters` object, nullable — Parâmetros do modelo de mensagem. Obrigatório caso o modelo de mensagem informado no `templateId` possua parâmetros.
    - `fileUrl` string, nullable — URL pública de algum arquivo que deseja-se enviar na mensagem. O arquivo enviado deverá seguir as regras do canal de atendimento.
    - `fileId` string, uuid, nullable — Código do arquivo que deseja-se enviar na mensagem, o ID pode ser obtido nas rotas /core/v2/file, o arquivo deverá seguir as regras do canal de atendimento.
    - `refId` string, uuid, nullable — ID de referência para identificar a mensagem externamente como resposta a uma mensagem anterior.
  - `department` PublicQuickSendDepartmentDTO
    - `id` string, uuid, nullable — ID da equipe que deverá ser atribuída ao atendimento. Será utilizado somente caso seja criado um novo atendimento.
    - `name` string, nullable — Nome da equipe que deverá ser atribuída ao atendimento. Será utilizado somente caso seja criado um novo atendimento.
  - `user` PublicQuickSendUserDTO
    - `id` string, uuid, nullable — ID do atendente que deverá ser atribuído ao atendimento. Será utilizado somente caso seja criado um novo atendimento.
    - `phoneNumber` string, nullable — Telefone do atendente que deverá ser atribuído ao atendimento. Será utilizado somente caso seja criado um novo atendimento.
    - `email` string, nullable — Email do atendente que deverá ser atribuído ao atendimento. Será utilizado somente caso seja criado um novo atendimento.
  - `options` PublicQuickSendOptionsDTO
    - `enableBot` boolean, nullable — Determina se o chatbot deve ser ativado ao receber uma resposta do contato. Válido apenas caso um novo atendimento seja criado ao enviar a mensagem.
    - `hiddenSession` boolean, nullable — Determina se o atendimento deve estar oculto na tela. Válido apenas caso um novo atendimento seja criado ao enviar a mensagem. O atendimento passará a ser visível caso o contato responda.
    - `forceStartSession` boolean, nullable — Se um atendimento estiver em andamento, força o encerramento dele e inicia um novo.

## 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/revisions/811b2cdd2ec2/schema)