Skip to main content
POST
Enviar template

Autorizações

apikey
string
header
obrigatório

Your Pilot Status API key (ps_...). Evolution GO also accepts Authorization: Bearer <key>.

Parâmetros de caminho

instance
string
obrigatório

O nome de exibição do número no painel do Pilot Status.

Corpo

application/json
name
string
obrigatório

Nome do template aprovado.

Exemplo:

"order_confirmation"

language
string
obrigatório

Código de idioma/localidade do template (ex.: pt_BR).

Exemplo:

"pt_BR"

number
string

Telefone do destinatário em E.164 sem +, ou um JID.

Exemplo:

"5511999999999"

components
object[]

Componentes do template (parâmetros de cabeçalho/corpo/botão).

Exemplo:
webhookUrl
string

URL de webhook opcional por mensagem para callbacks de status.

Exemplo:

"https://example.com/webhooks/template"

Resposta

Sucesso — corpo de resposta nativo do provedor.

Sent template message. Served by the Cloud API (Meta) channel; returns the persisted messageRaw envelope with the template rendered as a conversation preview.

key
object

Message key identifying the sent template message.

message
object

Rendered message content. Templates are stored as a conversation preview marked with the template name.

messageType
string

Content type; templates render as 'conversation'.

messageTimestamp
integer

Unix timestamp (seconds) when the message was accepted.

instanceId
string

Instance UUID that sent the message.

webhookUrl
string | null

Webhook URL configured for this instance (may be null).

status
enum<string>

Delivery status.

Opções disponíveis:
ERROR,
PENDING,
SERVER_ACK,
DELIVERY_ACK,
READ,
PLAYED
source
string

Origin device; 'unknown' for Cloud API sends.