Envio

Modelo

Envia um modelo de mensagem para um único destinatário. O campo TemplateId é obrigatório e deve corresponder a um template cadastrado no canal. O campo Parameters deve ser preenchido caso o template possua variáveis. O campo FileIdOrUrl é necessário apenas para templates com mídia. O CallbackUrl permite receber webhook quando a mensagem for entregue ou falhar. Este endpoint tem rate limit individual e permite 1000 requisições a cada 2 minutos.

post/v1/send/template

Request

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

Request body

tostring required
fromstring required
templateIdstring required

ID do modelo de mensagem a ser enviado.

parametersobject nullable

Parâmetros do modelo de mensagem. Obrigatório caso o template possua variáveis.

fileIdOrUrlstring nullable

URL pública ou ID de um arquivo a ser enviado junto ao template. O arquivo deve seguir as regras do canal de atendimento.

callbackUrlstring nullable

URL para receber webhook quando a mensagem for enviada ou falhar.

sessionIdstring uuid nullable

ID do atendimento. (Opcional) Deve ser utilizado para atendimentos em tempo real, como respostas de IA externa.

senderIdstring nullable

ID de identificação no seu sistema para rastreamento e consulta da mensagem.

sessionMetadataobject nullable

Metadados do atendimento na estrutura chave-valor. Utilizáveis como parâmetros no chatbot e enviados de volta nos webhooks. Válidos apenas enquanto o atendimento estiver ativo.

Response

Success

idstring uuid
createdAtstring date-time
updatedAtstring date-time nullable
companyIdstring uuid
sessionIdstring uuid nullable
status'PROCESSING' | 'SAVED' | 'QUEUED' | 'SENT' | 'DELIVERED' | 'READ' | 'FAILED' | 'DELETED' | 'WAIT_REPLY'
senderIdstring nullable
statusUrlstring nullable
sentAtstring date-time nullable
failedReasonstring nullable
callbackUrlstring nullable
waitReplyboolean nullable

Changes

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