Modelo

post

https://api.chatbotv4.sincorp.com.br/chat/v1/send/template

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.

Body Params

Dados para envio do template.

string

required

length ≥ 1

from

string

required

length ≥ 1

templateId

string

required

length ≥ 1

ID do modelo de mensagem a ser enviado.

parameters

object | null

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

fileIdOrUrl

string | null

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

callbackUrl

string | null

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

sessionId

uuid | null

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

options

object

senderId

string | null

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

sessionMetadata

object | null

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.

Headers

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Responses

200Success

400Bad Request

401Unauthorized

429Too Many Requests

500Server Error