Mensagem Transacional
3 min
Para enviar uma mensagem transacional, você precisará construir uma requisição HTTP POST para a URL apropriada da API do Jimmy.Chat
POST https://api.jimmy.chat/transactionalmessages/sendmessage- recipient_number (Número do Destinatário): Este atributo é obrigatório e representa o número de telefone do destinatário que receberá a mensagem. Certifique-se de fornecer o número no formato apropriado com o DDI e DDD (por exemplo, "5511123456789").
- connection_type (Tipo de Conexão): Este atributo é obrigatório e determina o tipo de conexão a ser utilizada. Você deve definir o valor como "whatsapp" para conexão comum ou "whatsapp-oficial" para usar uma conexão oficial.
- template_name (Nome do Template - Apenas para Conexão Oficial): Este atributo só é utilizado quando a conexão oficial "whatsapp-oficial" é selecionada. Aqui, você deve informar o nome do template que será usado no disparo da mensagem. Certifique-se de utilizar o nome do template exato, conforme definido em sua configuração.
- template_contexts (Campos de Contexto do Template - Apenas para Conexão Oficial): Quando estiver usando a conexão oficial "whatsapp-oficial", este atributo é usado para substituir valores de variáveis no template por campos de contexto do Jimmy.Chat. Os campos ou valores devem ser passados em formato sequencial, separados por ponto e vírgula (;).
- recipient_name (Nome do Destinatário): Este atributo é opcional e pode ser usado para fornecer o nome do contato que receberá a mensagem. Isso pode personalizar a mensagem para incluir o nome do destinatário.
- message (texto da mensagem): Atributo utilizado para passar o conteúdo da mensagem em formato de texto que será enviada para o contato. Esse atributo é utilizado somente em conexão comum.
- media (envio de arquivos): Utilizado para enviar junto da mensagem de texto arquivos como imagens, vídeo, áudio ou documentos. Compatível somente para conexão comum.
Exemplo de Requisição usando conexão comum (em formato JSON):
{
"recipient_number": "5511123456789",
"connection_type": "whatsapp",
"recipient_name": "Nome do Contato"
"message": "conteudo da mensagem a ser enviada"
}Exemplo de Requisição usando conexão com Cloud API Oficial (em formato JSON):
{
"recipient_number": "5511123456789",
"connection_type": "whatsapp-oficial",
"template_name": "nome_do_template",
"template_contexts": "valor1;valor2;valor3",
"recipient_name": "Nome do Contato"
}Exemplo de Requisição usando conexão comum com envio de arquivos (em formato PHP):
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://api.jimmy.chat/transactionalmessages/sendmessage',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_POSTFIELDS => array(
'recipient_number' => '5511993231592', // Número do destinatário
'connection_type' => 'whatsapp', // Tipo de conexão (whatsapp)
'message' => 'Teste', // Texto da mensagem
'media' => new CURLFILE('IMAGEM.JPEG'), // Mídia (imagem, vídeo, áudio, documento)
'recipient_name' => 'Nome do Contato' // Nome do contato (opcional)
),
CURLOPT_HTTPHEADER => array(
'Authorization: Bearer seutokenaqui' // Token de autenticação
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;