Login Cadastre-se

Finalizar interação com API

Endpoint: POST https://croncrm.com/api/v2/chats/finish-api

Finalize interações iniciadas pela API.

Esse método encerra a interação via API para que a conversa retorne ao fluxo de atendimento da plataforma (status Encerrado).

IMPORTANTE: Sempre que você interagir com um cliente via API, finalize a interação; caso contrário, a conversa pode ficar presa no status API.

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 para finalizar.

Sim

String

account_access_token

Usuário remetente (opcional).

Não

String

request_evaluation_if_available

Se true, finaliza e solicita avaliação de atendimento (se habilitado na plataforma).

Não

Boolean 

{
  "chat_wid": "[email protected]",
  "account_access_token": "ACCOUNT_TOKEN",
  "request_evaluation_if_available": true
}
Response do request

Em caso de sucesso, retorna HTTP 200. Se chat_wid não for informado, retorna 422. Se a conversa não for encontrada, 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": "Interação via API finalizado."
}
 
<?php
$apiKey = 'SEU_API_KEY';
$url = 'https://croncrm.com/api/v2/chats/finish-api';

$payload = [
    'chat_wid' => '[email protected]',
    'account_access_token' => 'ACCOUNT_TOKEN',
    'request_evaluation_if_available' => true,
];

$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, 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/chats/finish-api' \
  -H 'apiKey: SEU_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"chat_wid":"[email protected]","account_access_token":"ACCOUNT_TOKEN","request_evaluation_if_available":true}'