Login Cadastre-se

Procurar mensagens

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

Método para retornar uma lista de mensagens.

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

apiKey

Informe sua API Key gerada na interface do CRONCRM.

Sim

String

Query do request

Para este endpoint (GET), os parâmetros devem ser enviados na URL (query string).

Atributo Descrição Obrigatório Tipo

chat_wid

Informe o número da conversa.

Sim

String

message_wid

Identificador da mensagem para filtrar.

Dica: para localizar uma mensagem específica, informe também o access_token.

Não

String

access_token

Token de acesso da mensagem para filtrar.

Dica: para localizar uma mensagem específica, informe também o message_wid.

Não

String

shipping_status

Informe o status de envio da mensagem para filtrar.

  • all = Todos os status.
  • sent = Enviada.
  • failed = Falha ao tentar enviar, novas tentativas serão feitas.
  • queued = Na fila de envio.
  • cancelled = Cancelada.
  • received = Mensagem recebida.
  • daily_limit = Limite diário atingido.
  • error = Erro ao processar.

Dica: para consultar mensagens recebidas, você também pode usar source=in.

Não

String

source

Informe a origem da mensagem.

  • all = Todas as origens.
  • in = Recebidas.
  • out = Enviadas.

Não

String

message_type

Informe o tipo de mensagem para filtrar.

  • all = Retorna todos os tipos.
  • reaction = Reação.
  • list = Lista.
  • chat = Texto (inclui mensagens com botões).
  • link = Link.
  • ptt = Áudio gravado no momento do envio.
  • audio = Áudio (arquivo).
  • document = Documento/arquivo.
  • image = Imagem.
  • sticker = Sticker.
  • ptv = Vídeo curto.
  • video = Vídeo.
  • location = Localização.
  • vcard = Contato único.
  • multi_vcard = Vários contatos.

Observação: dependendo da versão/tipo da mensagem, alguns valores podem aparecer no retorno mesmo quando não usados como filtro.

Não

String

message_ack

Informe o status da mensagem para filtrar.

  • all = Retorna todos os status.
  • -1 = Mensagem recebida.
  • 0 = Aguardando envio.
  • 1 = Entregue no servidor de entrega.
  • 2 = Entregue no contato.
  • 3 = Lida pelo contato.
  • 4 = Escutada/assistida (comum para áudio e vídeos).
  • 100 = Cancelada no CRONCRM.

Não

Inteiro / String

date_start

Data de início para filtrar (formato YYYY-MM-DD).

Não

String

date_end

Data limite para filtrar (formato YYYY-MM-DD).

Não

String

page

Número da página para paginação.

Não

Inteiro 

                        
                            {
                              "chat_wid": "[email protected]",
                              "shipping_status": "all",
                              "source": "all",
                              "message_type": "all",
                              "message_ack": "all",
                              "date_start": "2026-01-01",
                              "date_end": "2026-01-31",
                              "page": 1
                            }
Response do request
Atributo Descrição Tipo
success Informa se a operação teve sucesso ou não. Boolean
page Página atual. Inteiro
pages Total de páginas. Inteiro
limit Limite de registros por página. Inteiro
count Total de registros encontrados. Inteiro
messages

Lista de mensagens encontradas.

Confira aqui os atributos de cada mensagem.

Array 
                        
                            {
                                "success": true,
                                "page": 1,
                                "pages": 1,
                                "limit": 20,
                                "count": 1,
                                "messages": [
                                    {
                                        "access_token": "MSG_TOKEN",
                                        "chat_wid": "[email protected]",
                                        "message_type": "chat",
                                        "message_body": "Olá!",
                                        "created": "2026-01-09 12:00:00"
                                    }
                                ]
                            }
                        
                    
<?php
$apiKey = 'SEU_API_KEY';
$url = 'https://croncrm.com/api/v2/messages/find';

$query = http_build_query([
    'chat_wid' => '[email protected]',
    'shipping_status' => 'all',
    'source' => 'all',
    'message_type' => 'all',
    'message_ack' => 'all',
    'date_start' => '2026-01-01',
    'date_end' => '2026-01-31',
    'page' => 1,
]);

$url .= '?' . $query;

$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/messages/find' \
  -H 'apiKey: SEU_API_KEY' \
  --data-urlencode '[email protected]' \
  --data-urlencode 'shipping_status=all' \
  --data-urlencode 'source=all' \
  --data-urlencode 'message_type=all' \
  --data-urlencode 'message_ack=all' \
  --data-urlencode 'date_start=2026-01-01' \
  --data-urlencode 'date_end=2026-01-31' \
  --data-urlencode 'page=1'