English
cURL
curl --request POST \ --url https://api.wppfy.com/contacts/list \ --header 'Content-Type: application/json' \ --header 'token: <api-key>' \ --data ' { "page": 1, "pageSize": 100, "limit": 123, "offset": 0 } '
{ "contacts": [ { "jid": "5511999999999@s.whatsapp.net", "contact_name": "Joao Silva", "contact_FirstName": "Joao" } ], "pagination": { "totalRecords": 123, "totalDeviceContacts": 123, "pageSize": 123, "currentPage": 123, "totalPages": 123, "hasNextPage": true, "hasPreviousPage": true } }
Retorna uma lista paginada de contatos da instancia do WhatsApp. Use este endpoint (POST) para controlar pagina, tamanho e offset via corpo da requisicao. A rota GET /contacts continua disponivel para quem prefere a lista completa sem paginacao.
/contacts
Numero da pagina para paginacao (padrao 1)
Quantidade de resultados por pagina (padrao 100, maximo 1000)
Alias opcional para pageSize
pageSize
Deslocamento base zero para paginacao; se informado recalcula a pagina
Lista de contatos recuperada com sucesso
Show child attributes
ID unico do contato no WhatsApp (formato: numero@s.whatsapp.net)
"5511999999999@s.whatsapp.net"
Nome completo do contato (quando salvo)
"Joao Silva"
Primeiro nome do contato
"Joao"
Total de contatos apos filtragem
Total bruto de contatos no dispositivo
Quantidade de itens por pagina
Pagina atual
Numero total de paginas
Indica se existe uma proxima pagina
Indica se existe pagina anterior