Skip to main content
GET
/
api
/
contacts
/
all
Obter todos os contatos
curl --request GET \
  --url https://{host}/api/contacts/all \
  --header 'apikey: <api-key>'
{
  "contacts": [
    {
      "jid": "5511999999999@s.whatsapp.net",
      "name": "João Silva",
      "notify": "João",
      "verifiedName": "João Silva",
      "businessName": ""
    },
    {
      "jid": "5511888888888@s.whatsapp.net",
      "name": "Maria Santos",
      "notify": "Maria",
      "verifiedName": "Maria Santos",
      "businessName": ""
    }
  ]
}

​
Descrição

Este endpoint retorna a lista completa de todos os contatos disponíveis na sessão do WhatsApp, sem paginação. Use este endpoint quando precisar de todos os contatos de uma só vez.

​
Query Parameters

​
sessionId
string
required
ID da sessão autenticada
{
  "contacts": [
    {
      "jid": "5511999999999@s.whatsapp.net",
      "name": "João Silva",
      "notify": "João",
      "verifiedName": "João Silva",
      "businessName": ""
    },
    {
      "jid": "5511888888888@s.whatsapp.net",
      "name": "Maria Santos",
      "notify": "Maria",
      "verifiedName": "Maria Santos",
      "businessName": ""
    }
  ]
}

​
Códigos de Status

  • 200 - Contatos retornados com sucesso
  • 400 - Parâmetros inválidos
  • 401 - Sessão não autorizada
  • 404 - Sessão não encontrada

​
Exemplo de Uso

curl -X GET "https://api.wappfy.com.br/api/contacts/all?sessionId=my-session"

Authorizations

​
apikey
string
header
required

Sua chave de API do Wappfy (obtenha em dash.wappfy.com.br)

Query Parameters

​
sortBy
enum<string>

Ordenar por campo

Available options:
id,
name
​
sortOrder
enum<string>

Ordem de ordenação - <b>desc</b>endente (Z => A, Novo primeiro) ou <b>asc</b>endente (A => Z, Antigo primeiro) (Sort order - <b>desc</b>ending (Z => A, New first) or <b>asc</b>ending (A => Z, Old first))

Available options:
desc,
asc
​
limit
number
​
offset
number
⌘I