Skip to main content
GET
/
api
/
contacts
Obter informações básicas do contato
curl --request GET \
  --url https://{host}/api/contacts \
  --header 'apikey: <api-key>'
{
  "contacts": [
    {
      "jid": "5511999999999@s.whatsapp.net",
      "name": "João Silva",
      "notify": "João",
      "verifiedName": "João Silva",
      "businessName": ""
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.wappfy.com.br/llms.txt

Use this file to discover all available pages before exploring further.

​
Descrição

Este endpoint permite obter informações básicas de contatos no WhatsApp. Você pode buscar um contato específico informando o JID ou listar múltiplos contatos usando paginação.

​
Query Parameters

​
sessionId
string
required
ID da sessão autenticada
​
jid
string
Identificador do contato (JID do WhatsApp). Se informado, retorna apenas o contato específico. Formato: 5511999999999@s.whatsapp.net
​
limit
number
default:"100"
Limite de contatos retornados (padrão: 100)
​
offset
number
default:"0"
Offset para paginação (padrão: 0)
{
  "contacts": [
    {
      "jid": "5511999999999@s.whatsapp.net",
      "name": "João Silva",
      "notify": "João",
      "verifiedName": "João Silva",
      "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

# Obter contato específico
curl -X GET "https://api.wappfy.com.br/api/contacts?sessionId=my-session&jid=5511999999999@s.whatsapp.net"

# Listar contatos com paginação
curl -X GET "https://api.wappfy.com.br/api/contacts?sessionId=my-session&limit=50&offset=0"

Authorizations

​
apikey
string
header
required

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

Query Parameters

​
contactId
string
required

Response

200 - undefined