Mensagens

Enviar síncrono

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;

post/v1/message/send-sync

Request

  • Base URL: https://api.helena.run/core
  • URL: https://api.helena.run/core/v1/message/send-sync
  • Auth: API key in header Authorization

Request body

fromstring nullable

Número de telefone do canal cadastrado na conta.

tostring required

Número de telefone do destinatário.

botIdstring uuid nullable

ID do bot que será ativado após a resposta do contato.

Response

Success

idstring uuid
createdAtstring date-time
updatedAtstring date-time
timestampstring date-time nullable
type'TEXT' | 'STICKER' | 'IMAGE' | 'AUDIO' | 'VIDEO' | 'DOCUMENT' | 'CONTACT' | 'LOCATION' | 'LIST' | 'BUTTONS' | 'TRANSITION' | 'TRACK' | 'NOTE'
senderIdstring nullable
sessionIdstring uuid
templateIdstring uuid nullable
userIdstring 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'
textstring nullable
fileIdstring uuid nullable
refIdstring uuid nullable
readContactAtstring date-time nullable
failedReasonstring nullable
filesIdsstring[] nullable

Changes

No recorded changes to this operation across all 1 revision of this API.