API atual/Referência completa/WhatsApp: caixa de entrada

Contatos importados

Lista a agenda importada do aplicativo WhatsApp Business e mostra totais.

Listar contatos

Devolve os contatos importados por Importar os contatos, do mais recentemente sincronizado para o mais antigo. Contatos removidos no aplicativo não aparecem.

GET/api/v1/admin/whatsapp-confluence/contactsAdmin

Lista contatos importados

Parâmetros de consulta

qstring

Busca por trecho no nome ou telefone.

sourcestring

SH

Origem: S agenda sincronizada, H vindo do histórico. Outro valor é ignorado.

pageintegerpadrão: 1

Página, a partir de 1.

per_pageintegerpadrão: 50

Itens por página, de 1 a 200 (fora disso 50). page_size é aceito como apelido.

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/admin/whatsapp-confluence/contacts?per_page=20" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Contatos

json

{
  "contacts": [
    {
      "id": 17,
      "account_id": "11111111-1111-4111-8111-111111111111",
      "phone": "5511987654321",
      "full_name": "Maria Souza",
      "first_name": "Maria",
      "source": "S",
      "synced_at": "2026-10-09T13:05:00Z"
    }
  ],
  "total": 128,
  "page": 1,
  "page_size": 20
}

Campos da resposta

contactsarray

Contatos da página.

contacts[].idinteger

Id do contato.

contacts[].account_iduuid

Conta de onde veio.

contacts[].phonestring

Telefone, só dígitos com DDI.

contacts[].full_namestring

Nome completo.

contacts[].first_namestring

Primeiro nome.

contacts[].sourcestring

SH

Origem.

contacts[].synced_atstring

Última sincronização (RFC 3339).

totalinteger

Total que combina com o filtro, todas as páginas.

pageinteger

Página devolvida.

page_sizeinteger

Tamanho da página usado.

Erros

Status	Quando	Corpo de exemplo
500	Falha ao consultar.	`{"error":"..."}`
401	Sem token, token inválido ou expirado.	`{"error":"missing authorization header"}`
403	O usuário não tem papel de administrador.	`{"error":"insufficient permissions"}`

Totais de contatos

Resumo para um cartão de painel: quantos contatos há e de onde vieram.

GET/api/v1/admin/whatsapp-confluence/contacts/statsAdmin

Totais dos contatos importados

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/admin/whatsapp-confluence/contacts/stats" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Totais

json

{
  "total": 128,
  "from_app": 97,
  "organic": 31,
  "last_synced_at": "2026-10-09T13:05:00Z"
}

Campos da resposta

totalinteger

Contatos importados.

from_appinteger

Os que vieram do aplicativo.

organicinteger

Os que surgiram de conversas na plataforma.

last_synced_atstring

Última sincronização. Ausente se nunca houve.

Erros

Status	Quando	Corpo de exemplo
500	Falha ao consultar.	`{"error":"..."}`
401	Sem token, token inválido ou expirado.	`{"error":"missing authorization header"}`
403	O usuário não tem papel de administrador.	`{"error":"insufficient permissions"}`

Veja também

API atual/Referência completa/WhatsApp: caixa de entrada

Contatos importados

Lista a agenda importada do aplicativo WhatsApp Business e mostra totais.

Listar contatos

Devolve os contatos importados por Importar os contatos, do mais recentemente sincronizado para o mais antigo. Contatos removidos no aplicativo não aparecem.

GET/api/v1/admin/whatsapp-confluence/contactsAdmin

Lista contatos importados

Parâmetros de consulta

qstring

Busca por trecho no nome ou telefone.

sourcestring

SH

Origem: S agenda sincronizada, H vindo do histórico. Outro valor é ignorado.

pageintegerpadrão: 1

Página, a partir de 1.

per_pageintegerpadrão: 50

Itens por página, de 1 a 200 (fora disso 50). page_size é aceito como apelido.

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/admin/whatsapp-confluence/contacts?per_page=20" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Contatos

json

{
  "contacts": [
    {
      "id": 17,
      "account_id": "11111111-1111-4111-8111-111111111111",
      "phone": "5511987654321",
      "full_name": "Maria Souza",
      "first_name": "Maria",
      "source": "S",
      "synced_at": "2026-10-09T13:05:00Z"
    }
  ],
  "total": 128,
  "page": 1,
  "page_size": 20
}

Campos da resposta

contactsarray

Contatos da página.

contacts[].idinteger

Id do contato.

contacts[].account_iduuid

Conta de onde veio.

contacts[].phonestring

Telefone, só dígitos com DDI.

contacts[].full_namestring

Nome completo.

contacts[].first_namestring

Primeiro nome.

contacts[].sourcestring

SH

Origem.

contacts[].synced_atstring

Última sincronização (RFC 3339).

totalinteger

Total que combina com o filtro, todas as páginas.

pageinteger

Página devolvida.

page_sizeinteger

Tamanho da página usado.

Erros

Status	Quando	Corpo de exemplo
500	Falha ao consultar.	`{"error":"..."}`
401	Sem token, token inválido ou expirado.	`{"error":"missing authorization header"}`
403	O usuário não tem papel de administrador.	`{"error":"insufficient permissions"}`

Totais de contatos

Resumo para um cartão de painel: quantos contatos há e de onde vieram.

GET/api/v1/admin/whatsapp-confluence/contacts/statsAdmin

Totais dos contatos importados

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/admin/whatsapp-confluence/contacts/stats" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Totais

json

{
  "total": 128,
  "from_app": 97,
  "organic": 31,
  "last_synced_at": "2026-10-09T13:05:00Z"
}

Campos da resposta

totalinteger

Contatos importados.

from_appinteger

Os que vieram do aplicativo.

organicinteger

Os que surgiram de conversas na plataforma.

last_synced_atstring

Última sincronização. Ausente se nunca houve.

Erros

Status	Quando	Corpo de exemplo
500	Falha ao consultar.	`{"error":"..."}`
401	Sem token, token inválido ou expirado.	`{"error":"missing authorization header"}`
403	O usuário não tem papel de administrador.	`{"error":"insufficient permissions"}`