Close

Endpoint: POST https://croncrm.com/api/v2/auth/close

Encerra a conexão com o CRONCRM.

Está ação não irá encerrar sessões geradas anteriormente, então se ocorrer um pedido de conexão será reaproveitado sessões geradas anteriormente dispensando a necessidade da leitura do qrcode.

IMPORTANTE: Por padrão a plataforma faz uma verificação a cada 10 minutos em todos os canais que estão desconectadas e com uma sessão válida para iniciar o processo de conexão automaticamente.

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

apiKey

Informe sua API Key gerada na interface do CRONCRM.

Sim

String

Body do request

Sem necessidade de passar parâmetros no body.

Response do request

Para erros de autenticação/headers (ex.: ausência de apiKey ou Content-Type diferente de application/json), o retorno pode ser 400. Método incorreto retorna 405.

Atributo Descrição Tipo

success

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

  • TRUE = Conexão encerrada com sucesso.
  • FALSE = Algo de errado aconteceu e não foi possível encerrar a conexão.

Boolean

msg

Mensagem de retorno.

String

                    
                        {
                          "success": true,
                          "msg": "Conexão encerrada com sucesso. (Acompanhe o status da conexão pelo Webhook webhookStateChanged)"
                        }
                    
                    
<?php
$apiKey = 'SEU_API_KEY';
$url = 'https://croncrm.com/api/v2/auth/close';

$payload = [];

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

$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/auth/close' \
  -H 'apiKey: SEU_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{}'