Listar todos los contactos con paginación
curl --request POST \
--url https://api.wppfy.com/contacts/list \
--header 'Content-Type: application/json' \
--header 'token: <api-key>' \
--data '
{
"limit": 100,
"offset": 0,
"contactScope": "address_book"
}
'import requests
url = "https://api.wppfy.com/contacts/list"
payload = {
"limit": 100,
"offset": 0,
"contactScope": "address_book"
}
headers = {
"token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {token: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({limit: 100, offset: 0, contactScope: 'address_book'})
};
fetch('https://api.wppfy.com/contacts/list', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.wppfy.com/contacts/list",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'limit' => 100,
'offset' => 0,
'contactScope' => 'address_book'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.wppfy.com/contacts/list"
payload := strings.NewReader("{\n \"limit\": 100,\n \"offset\": 0,\n \"contactScope\": \"address_book\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("token", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.wppfy.com/contacts/list")
.header("token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"limit\": 100,\n \"offset\": 0,\n \"contactScope\": \"address_book\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.wppfy.com/contacts/list")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"limit\": 100,\n \"offset\": 0,\n \"contactScope\": \"address_book\"\n}"
response = http.request(request)
puts response.read_body{
"contacts": [
{
"jid": "5511999999999@s.whatsapp.net",
"contact_name": "Juan Pérez",
"contact_FirstName": "Joao"
}
],
"totalDeviceContacts": 123,
"pagination": {
"totalRecords": 123,
"limit": 123,
"offset": 123,
"hasMore": true,
"nextOffset": 123
}
}{
"error": "No session"
}{
"error": "<string>"
}Contactos
Listar todos los contactos con paginación
Devuelve una lista paginada de contactos de la cuenta de WhatsApp actualmente conectada.
Use este endpoint (POST) para controlar limit y offset mediante el cuerpo de la solicitud.
El campo contactScope permite elegir entre contactos de la agenda, fuera de la agenda o todos los contactos conocidos.
La ruta GET /contacts sigue disponible para quien prefiera la lista completa sin paginación.
POST
/
contacts
/
list
Listar todos los contactos con paginación
curl --request POST \
--url https://api.wppfy.com/contacts/list \
--header 'Content-Type: application/json' \
--header 'token: <api-key>' \
--data '
{
"limit": 100,
"offset": 0,
"contactScope": "address_book"
}
'import requests
url = "https://api.wppfy.com/contacts/list"
payload = {
"limit": 100,
"offset": 0,
"contactScope": "address_book"
}
headers = {
"token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {token: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({limit: 100, offset: 0, contactScope: 'address_book'})
};
fetch('https://api.wppfy.com/contacts/list', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.wppfy.com/contacts/list",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'limit' => 100,
'offset' => 0,
'contactScope' => 'address_book'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.wppfy.com/contacts/list"
payload := strings.NewReader("{\n \"limit\": 100,\n \"offset\": 0,\n \"contactScope\": \"address_book\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("token", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.wppfy.com/contacts/list")
.header("token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"limit\": 100,\n \"offset\": 0,\n \"contactScope\": \"address_book\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.wppfy.com/contacts/list")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"limit\": 100,\n \"offset\": 0,\n \"contactScope\": \"address_book\"\n}"
response = http.request(request)
puts response.read_body{
"contacts": [
{
"jid": "5511999999999@s.whatsapp.net",
"contact_name": "Juan Pérez",
"contact_FirstName": "Joao"
}
],
"totalDeviceContacts": 123,
"pagination": {
"totalRecords": 123,
"limit": 123,
"offset": 123,
"hasMore": true,
"nextOffset": 123
}
}{
"error": "No session"
}{
"error": "<string>"
}Autorizaciones
Cuerpo
application/json
Cantidad máxima de resultados por página (predeterminado 100, máximo 1000)
Rango requerido:
1 <= x <= 1000Desplazamiento con base cero para paginación
Define si la búsqueda devuelve solo contactos de la agenda, solo fuera de la agenda o todos los contactos conocidos.
Opciones disponibles:
address_book, outside_address_book, all 