v1

latestOpenAPI 3.0.12026-07-26105162235.7 KB

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 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

senderIdstring nullable

statusUrlstring nullable

sentAtstring date-time nullable

failedReasonstring nullable

callbackUrlstring nullable

waitReplyboolean nullable