Login Cadastre-se

Enviar menções

Endpoint: POST https://croncrm.com/api/v2/groups/send-mentions

Envie uma mensagem no grupo mencionando participantes específicos.

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

WID do grupo.

Sim

String

message

Mensagem a ser enviada.

Sim

String

mentions

WIDs (contact_wid) separados por ; para mencionar na mensagem.

Exemplo: [email protected];[email protected]

Sim

String

account_access_token

Token da conta (opcional).

Não

String

 
{
  "chat_wid": "[email protected]",
  "message": "Olá @todos",
  "mentions": "[email protected];[email protected]"
}
Response do request

Em caso de sucesso, retorna HTTP 201 com success true. Se chat_wid, message ou mentions não forem informados, retorna 422. Se chat_wid for inválido, se algum contato em mentions for inválido, ou se account_access_token for informado e não identificar usuário, retorna 400. Método incorreto retorna 405; falhas inesperadas retornam 500.

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 do chat (grupo).

Array|null

message

Dados da mensagem criada.

Array|null

 
{
  "success": true,
  "msg": "Mensagem criada com sucesso.",
  "chat": {
    "chat_wid": "[email protected]"
  },
  "message": {
    "access_token": "MSG_TOKEN",
    "message_type": "chat",
    "message_body": "Olá @todos",
    "message_mentioneds": "[email protected];[email protected]"
  }
}
 
<?php
$apiKey = 'SEU_API_KEY';
$url = 'https://croncrm.com/api/v2/groups/send-mentions';

$payload = [
    'chat_wid' => '[email protected]',
    'message' => 'Olá @todos',
    'mentions' => '[email protected];[email protected]',
];

$ch = curl_init($url);
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_HTTPHEADER => [
        'apiKey: ' . $apiKey,
        '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/groups/send-mentions' \
  -H 'apiKey: SEU_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"chat_wid":"[email protected]","message":"Olá @todos","mentions":"[email protected];[email protected]"}'