Login Cadastre-se

Enviar mensagem e acionar gatilho do chatbot

Endpoint: POST https://croncrm.com/api/v2/messages/send-message-and-add-trigger-chatbot

Método para enviar uma mensagem e iniciar um fluxo do chatbot na conversa.

Header do request
Atributo Descrição Obrigatório Tipo

apiKey

Informe sua API Key gerada na interface do CRONCRM.

Sim

String

toTransmit

Força a transmissão imediata da mensagem, sem passar pela fila.

Use toTransmit: 1 para ativar. Para não transmitir imediatamente, omita o header ou use toTransmit: 0.

Não

String / Boolean

Body do request
Atributo Descrição Obrigatório Tipo

chat_wid

Identificador do chat/contato (wid)

Sim

String

message

Texto da mensagem

Sim

String

account_access_token

Associa envio a um usuário (opcional)

Não

String 

{
  "chat_wid": "[email protected]",
  "message": "Oi",
  "account_access_token": "ACCOUNT_TOKEN"
}
Response do request

Em caso de sucesso, este endpoint retorna HTTP 201. Se chat_wid ou message não forem informados, retorna 422. Se chat_wid ou account_access_token forem inválidos, retorna 400. Método incorreto retorna 405; falhas inesperadas retornam 500.

Se a conversa já estiver em atendimento ou aguardando atendimento, a API pode retornar HTTP 200 com success false e uma mensagem informando o status atual.

Quando o header toTransmit está ativado e a transmissão ocorre com sucesso, a resposta pode incluir campos adicionais na mensagem como message_wid, message_ack, message_timestamp e shipping_status.

Atributo Descrição Tipo

success

Informa se a operação teve sucesso ou não.

Boolean

msg

Mensagem de retorno.

String

chat

Dados da conversa.

Confira aqui os atributos de uma conversa.

Array

message

Dados da mensagem criada.

Confira aqui os atributos de uma mensagem.

Array 

{
  "success": true,
    "msg": "Mensagem criada com sucesso.",
  "chat": {
    "access_token": "CHAT_TOKEN",
    "customer_service_status_id": 3
  },
  "message": {
    "access_token": "MSG_TOKEN",
    "message_type": "chat",
    "message_body": "Oi"
  }
}
 
<?php
$apiKey = 'SEU_API_KEY';
$url = 'https://croncrm.com/api/v2/messages/send-message-and-add-trigger-chatbot';

$payload = [
    'chat_wid' => '[email protected]',
    'message' => 'Oi',
    'account_access_token' => 'ACCOUNT_TOKEN',
];

$ch = curl_init($url);
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_POST => true,
    CURLOPT_HTTPHEADER => [
        'apiKey: ' . $apiKey,
        // Opcional: 'toTransmit: 1',
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS => json_encode($payload, JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE),
]);

$response = curl_exec($ch);
$httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
$error = curl_error($ch);
curl_close($ch);

if ($error) {
    throw new RuntimeException($error);
}

echo "HTTP {$httpCode}\n";
echo $response;
?>
curl -X POST \
  'https://croncrm.com/api/v2/messages/send-message-and-add-trigger-chatbot' \
  -H 'apiKey: SEU_API_KEY' \
  -H 'toTransmit: 1' \
  -H 'Content-Type: application/json' \
  -d '{"chat_wid":"[email protected]","message":"Oi","account_access_token":"ACCOUNT_TOKEN"}'