Login Cadastre-se

Buscar conversa

Endpoint: GET https://croncrm.com/api/v2/chats/find

Busque conversas por filtros (status, etiqueta, etc).

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

apiKey

Informe sua API Key gerada na interface do CRONCRM.

Sim

String

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

chat_wid

Informe o número do contato para retornar uma conversa específica.

Ao informar este parâmetro, os demais parâmetros serão ignorados.

O retorno permanece no atributo chats (Array/Null). Se a conversa existir, retorna uma lista com 1 item; caso contrário, retorna null.

Não

String

tag_access_token

Informe o access_token fornecido pelo CRONCRM de uma etiqueta para retornar as conversas vinculadas.

Não

String

funnel_step_access_token

Informe o access_token de uma etapa do funil para retornar as conversas vinculadas.

Não

String

customer_service_status_id

Informe um status para retornar as conversas vinculadas.

  • 1 = Em atendimento
  • 2 = Aguardando atendimento
  • 3 = Chatbot
  • 4 = Encerrados
  • 5 = API

Não

Inteiro

page

Página da listagem.

Não

Inteiro 

GET /api/v2/chats/find?page=1&customer_service_status_id=5
Response do request

Em caso de sucesso, retorna HTTP 200. Se customer_service_status_id for inválido ou se chat_wid for inválido, retorna 422. 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

page

Página atual.

Inteiro

pages

Quantidade total de páginas.

Inteiro

limit

Limite de registros por página.

Inteiro

count

Total de conversas encontradas.

Inteiro

chats

Lista de conversas encontradas. Se não houver registros, retorna null.

Confira aqui os atributos de cada conversa.

Array/Null 

{
  "success": true,
  "msg": "Consulta realizada com sucesso.",
  "page": 1,
  "pages": 1,
  "limit": 20,
  "count": 1,
  "chats": [
    {
      "chat_wid": "[email protected]",
      "profile_name": "Nome da conversa aqui",
      "customer_service_status_id": 1
    }
  ]
}
 
<?php
$apiKey = 'SEU_API_KEY';
$baseUrl = 'https://croncrm.com/api/v2/chats/find';

$query = [
    'page' => 1,
    'customer_service_status_id' => 5,
];

$url = $baseUrl . '?' . http_build_query($query);

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

$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/chats/find' \
  -H 'apiKey: SEU_API_KEY' \
  --data-urlencode 'page=1' \
  --data-urlencode 'customer_service_status_id=5'