Login Cadastre-se

Status

Endpoint: GET https://croncrm.com/api/v2/auth/status

Consulte o status da conexão com o CRONCRM.

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

Se o header apiKey não for informado, o retorno pode ser 400. Método incorreto retorna 405. Em falhas inesperadas, o retorno pode ser 500.

Atributo Descrição Tipo

success

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

  • TRUE = Se a consulta ocorreu com sucesso.
  • FALSE = Algo de errado aconteceu e não foi possível efetuar a consulta.

Boolean

msg

Mensagem de retorno.

String

status

Retorna o status real da conexão com o CRONCRM.

  • CONNECTED = Conectado e disponível para uso.
  • TIMEOUT = Conectado, porém, com intermitência na conexão.
  • DISCONNECTED = Desconectado. (Efetue o login para conectar seu WhatsApp).
  • CONNECTING = Inicializando conexão, aguarde alguns instantes.

String 

                    
                        {
                          "success": true,
                                                    "msg": "WhatsApp conectado e disponível para uso.",
                          "status": "CONNECTED"
                        }
                    
                    
<?php
$apiKey = 'SEU_API_KEY';
$url = 'https://croncrm.com/api/v2/auth/status';

$ch = curl_init($url);
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPGET => true,
    CURLOPT_HTTPHEADER => [
        'apiKey: ' . $apiKey,
    ],
]);

$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 -G \
  'https://croncrm.com/api/v2/auth/status' \
  -H 'apiKey: SEU_API_KEY'