Whatsapp.Interactions

Retorna as interações de um contato com as mensagens de WhatsApp (jornadas automáticas e recuperação de carrinho) a partir do número de telefone.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Retornos

  • Success = {true | false}
    Mostra se houve erro ou não

  • ErrorCode = {integer | array de integers}
    Se houve erro, apresenta o código de erro. Quando um parâmetro obrigatório não é enviado, o retorno é um array (ex.: [1]); nos demais erros é um integer.

  • ErrorText = {text}
    Se houve erro, apresenta o texto do erro

  • Data = {object}
    Resultado da consulta, com phone, periodDays e interactions

  • Data.phone = {text}
    Telefone consultado

  • Data.periodDays = {integer}
    Janela da consulta, em dias (ex.: 90). Só são retornadas interações enviadas dentro desse período.

  • Data.interactions = {array}
    Interações ordenadas da mais recente para a mais antiga (pode vir vazio). Cada item contém:

    • type - Tipo da mensagem: flow (jornada automática) ou cart-recovery (carrinho abandonado)
    • journeyId - ID da jornada que enviou a mensagem
    • journeyName - Nome da jornada (ex.: Recompra)
    • sentDate - Data e hora do envio
    • deliveredDate - Data e hora da entrega (null se não confirmada)
    • openingDate - Data e hora da leitura (null se não lida)
    • clickDate - Data e hora do clique (null se não houve clique)
    • hasLinkClick - true se algum link da mensagem foi clicado
    • linkClicked - URL clicada (null se não houve clique)

    As datas estão no formato ISO 8601, em UTC (ex.: 2026-06-11T21:39:07.400+00:00).

Códigos de Erro

  • 1 - Faltou o telefone (phone)
  • 2 - Conta não habilitada para consulta de interações de WhatsApp
  • 3 - Formato de telefone inválido (esperado DDI + DDD + 9 dígitos, ex.: 5511952069400)
  • 99998 - Falha de autenticação ou sessão expirada
  • 99999 - Sem privilégios suficientes
Query Params
string
required

Chave de Autenticação

string
required
Defaults to Whatsapp.Interactions

Comando da API

string
required
Defaults to JSON

Formato do retorno

boolean

Envie este parâmetro em caso de cross-domain

string
required

Telefone do contato com 13 dígitos: DDI + DDD + número com 9 dígitos, sem + ou traços (ex.: 5511952069400)

Response

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json