Login Cadastre-se

Fixar conversa

Endpoint: PUT https://croncrm.com/api/v2/chats/pin

Essa função fixa a conversa no topo do feed de conversas e, dentro da nossa plataforma, não tem efeito.

Precisa existir uma conversa iniciada com o contato.

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

apiKey

Informe sua API Key gerada na interface do CRONCRM.

Sim

String

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

chat_wid

Informe o número do contato.

Sim

String

pin

  • TRUE = Para fixar a conversa.
  • FALSE = Para desafixar a conversa.

Sim

Boolean 

{
  "chat_wid": "[email protected]",
  "pin": true
}
Response do request

Em caso de sucesso, retorna HTTP 200. Se chat_wid não for informado ou pin for inválido, retorna 422. Se a conversa/grupo não for encontrada ou o número não tiver WhatsApp, retorna 404. Método incorreto retorna 405; falhas inesperadas retornam 500.

Atributo Descrição Tipo

success

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

Boolean

msg

Mensagem de retorno.

String 

{
  "success": true,
    "msg": "Chat fixado com sucesso."
}
 
<?php
$apiKey = 'SEU_API_KEY';
$url = 'https://croncrm.com/api/v2/chats/pin';

$payload = [
    'chat_wid' => '[email protected]',
    'pin' => true,
];

$ch = curl_init($url);
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_POST => true,
    CURLOPT_CUSTOMREQUEST => 'PUT',
    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 PUT \
  'https://croncrm.com/api/v2/chats/pin' \
  -H 'apiKey: SEU_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"chat_wid":"[email protected]","pin":true}'