API WhatsApp Web API WhatsApp Web

📌 Introducción a los Contactos en la API de WhatsApp Web JS

📖 Conceptualización

En este tema, comprenderás mejor lo que la API de WhatsApp Web JS puede hacer en relación a contactos. Para facilitar la comprensión, hemos dividido el enfoque en algunos puntos esenciales:

🛠️ ¿Cómo maneja WhatsApp los Contactos?

Para WhatsApp Web, ¡todo contacto es simplemente un chat! Puede parecer extraño, pero así es como la plataforma maneja los contactos. WhatsApp utiliza el número de teléfono como identificador para el chat. Por lo tanto, al acceder a la información de los contactos, la API sigue la misma lógica.

¿Cuál es la diferencia entre getChats() y getContacts()?

  • getChats(): solo devuelve los contactos con los que ya has tenido una conversación abierta.
  • getContacts(): devuelve todos los contactos que tienen cuenta en WhatsApp, incluyendo los contactos que participan en grupos de los que eres parte.

📌 ¿Qué puede hacer la API con los contactos?

La API de WhatsApp Web JS tiene las mismas limitaciones que WhatsApp Web, es decir, no es posible:

  • Agregar contactos automáticamente a la agenda.
  • Renombrar contactos.
  • Eliminar contactos directamente de la cuenta.

Esto sucede porque WhatsApp Web no tiene acceso a la agenda de tu celular. De esta forma, la API tampoco puede realizar estas acciones.

📌 Sobre la Listado de Contactos

El método que devuelve los contactos puede parecer confuso, porque, al utilizarlo, puedes ver un número mayor de contactos que los que realmente están en tu agenda. Esto ocurre porque el método getContacts() también devuelve los números de los participantes de grupos de los que eres parte.

📌 Ejemplo práctico:

Si estás en un grupo con 50 personas, todas ellas serán listadas en la respuesta del método getContacts(), aunque ellas no estén guardadas en tu agenda.

Esta característica puede ser útil para identificar nuevos contactos dentro de grupos o filtrar mensajes recibidos de desconocidos.

🚀 ¡Ahora que entiendes mejor cómo funciona la gestión de contactos en WhatsApp Web JS, explora los métodos disponibles en la API!

Añadir Nuevo Contacto en WhatsApp

Documentación de la API

Esta API permite añadir un nuevo contacto a la lista de contactos de WhatsApp.

URL Base

URL Base: https://apiwhatsappweb.com/api/add-contact

Todas las solicitudes deben realizarse a esta URL base.

Autenticación

Para autenticar las solicitudes, debes incluir la clave API (apiKey) y la identificación de la instancia ID en el encabezado (Header).

{
    "apiKey": "Tu clave API aquí",
    "id": "La identificación de la instancia aquí"
}

Cómo Añadir un Nuevo Contacto

Cuerpo de la Solicitud

El cuerpo de la solicitud debe ser un objeto JSON con la siguiente estructura:

{
    "firstName": "Contacto 1",
    "lastName": "Apellido 1",
    "phone": "554499999999"
}

Ejemplos de Código

const axios = require("axios");

let data = JSON.stringify({
    "firstName": "Contacto 1",
    "lastName": "Apellido 1",
    "phone": "554499999999"
});

let config = {
    method: 'post',
    url: 'https://apiwhatsappweb.com/api/add-contact',
    headers: { 
        'apiKey': 'Bearer Tu_ApiKey',
        'id': 'Tu_ID_de_Instancia_Aquí',
        'Content-Type': 'application/json'
    },
    data: data
};

axios.request(config)
    .then((response) => console.log(response.data))
    .catch((error) => console.log(error));
            

Ejemplos de Respuestas

Ejemplo de Éxito

{
    "success": true,
    "message": "¡Contacto añadido con éxito!",
    "contact": {
        "firstName": "Contacto 1",
        "lastName": "Apellido 1",
        "phone": "554499999999"
    }
}

Ejemplo de Error

{
    "error": "Número de teléfono inválido."
}

Códigos de Estado

  • 200 OK: Contacto añadido con éxito.
  • 400 Bad Request: Número de teléfono inválido.
  • 401 Unauthorized: Fallo en la autenticación.
  • 500 Internal Server Error: Ocurrió un error en el servidor.

Eliminar Contacto en WhatsApp

Documentación de la API

Esta API permite eliminar un contacto de la lista de contactos de WhatsApp.

URL Base

URL Base: https://apiwhatsappweb.com/api/delete-contact

Autenticación

Para autenticar las solicitudes, debes incluir la clave API (apiKey) y la identificación de la instancia ID (identificación) en el encabezado (Header).

{
    "apiKey": "Tu clave API aquí",
    "id": "La identificación de la instancia aquí"
}

Cómo eliminar un contacto:

Cuerpo de la Solicitud

El cuerpo de la solicitud debe ser un objeto JSON con la siguiente estructura:

{
    "id": "INSTANCE_ID",
    "phone": "554499999999"
}

Ejemplos de uso

Ejemplos en Node.js, Python y C:

Aviso Importante

¡Atención!

Eliminar un contacto es una acción irreversible. Asegúrate de que deseas eliminar este contacto antes de continuar.

Obtener Imagen de Contacto en WhatsApp

Documentación de la API

Esta API permite obtener la foto de perfil de un contacto en WhatsApp.

URL Base

URL Base: https://apiwhatsappweb.com/api/get-contact-image

Todas las solicitudes deben realizarse a esta URL base.

Autenticación

Para autenticar las solicitudes, debes incluir la clave API (apiKey) y la identificación de la instancia ID (identificación) en el encabezado (Header).

{
    "apiKey": "Tu clave API aquí",
    "id": "La identificación de la instancia aquí"
}

Cómo obtener la imagen de un contacto

Cuerpo de la Solicitud

El cuerpo de la solicitud debe ser un objeto JSON con la siguiente estructura:

{
    "id": "INSTANCE_ID",
    "phone": "554499999999"
}

Ejemplo de Uso

const axios = require("axios");

let data = JSON.stringify({
    "id": "INSTANCE_ID",
    "phone": "554499999999"
});

let config = {
    method: 'post',
    url: 'https://apiwhatsappweb.com/api/get-contact-image',
    headers: { 
        'apiKey': 'Bearer Your_ApiKey',
        'id': 'Your_Instance_ID_Here',
        'Content-Type': 'application/json'
    },
    data: data
};

axios.request(config)
    .then((response) => console.log(response.data))
    .catch((error) => console.log(error));

Bloquear/Desbloquear Contacto en WhatsApp

Documentación de la API

Esta API permite bloquear o desbloquear un contacto en WhatsApp.

URL Base

URL Base: https://apiwhatsappweb.com/api/block-unblock

Todas las solicitudes deben realizarse a esta URL base.

Autenticación

Para autenticar las solicitudes, debes incluir la clave API (apiKey) y la identificación de la instancia ID (identificación) en el encabezado (Header).

{
    apiKey: Tu clave API aquí
    id: La identificación de la instancia aquí
}

Cómo bloquear o desbloquear un contacto:

Cuerpo de la Solicitud

El cuerpo de la solicitud debe ser un objeto JSON con la siguiente estructura:

{
"id": "INSTANCE_ID",  // ID de la instancia conectada a WhatsApp
"phone": "554499999999",  // Número del contacto a ser bloqueado/desbloqueado
"action": "block"  // Acción: "block" para bloquear, "unblock" para desbloquear
}

Ejemplos de uso

const axios = require("axios");

let data = JSON.stringify({
"id": "INSTANCE_ID",
"phone": "554499999999",
"action": "block"
});

let config = {
    method: 'post',
    url: 'https://apiwhatsappweb.com/api/block-unblock',
    headers: { 
'apiKey': 'Bearer Your_ApiKey',
'id': 'Your_Instance_ID_Here',
'Content-Type': 'application/json'
    },
    data: data
};

axios.request(config)
    .then((response) => {
        console.log(response.data);
    })
    .catch((error) => {
        console.log(error);
    });

Denunciar Contacto en WhatsApp

Documentación de la API

Esta API permite denunciar un contacto en WhatsApp.

URL Base

URL: https://apiwhatsappweb.com/api/report-contact

Todas las solicitudes deben realizarse a esta URL base.

Autenticación

Para autenticar las solicitudes, incluye la Clave API (apiKey) y la Identificación de la Instancia (id) en el encabezado (Header).

{
    "apiKey": "Tu clave API aquí",
    "id": "La identificación de la instancia aquí"
}
    

Cómo denunciar un contacto

Cuerpo de la Solicitud

El cuerpo de la solicitud debe ser un objeto JSON con la siguiente estructura:

{
    "id": "INSTANCE_ID",  
    "phone": "554499999999",  
    "reason": "spam"
}
    

Ejemplos de Uso

const axios = require("axios");

let data = JSON.stringify({
    "id": "INSTANCE_ID",
    "phone": "554499999999",
    "reason": "spam"
});

let config = {
    method: 'post',
    url: 'https://apiwhatsappweb.com/api/report-contact',
    headers: { 
        'apiKey': 'Bearer Your_ApiKey',
        'id': 'Your_Instance_ID_Here',
        'Content-Type': 'application/json'
    },
    data: data
};

axios.request(config)
    .then((response) => console.log(response.data))
    .catch((error) => console.log(error));

📌 Listar Todos los Contactos de WhatsApp

📖 Documentación de la API

Esta API permite recuperar todos los contactos asociados a una instancia de WhatsApp.

🔗 URL Base

URL: https://apiwhatsappweb.com/api/contacts

Todas las solicitudes deben realizarse a esta URL base.

🔑 Autenticación

Para autenticar las solicitudes, incluye la Clave API (apiKey) y la Identificación de la Instancia (id) en el encabezado (Header).

{
    "apiKey": "Tu clave API aquí",
    "id": "La identificación de la instancia aquí"
}
    

📌 Cómo listar los contactos

📩 Cuerpo de la Solicitud

El cuerpo de la solicitud debe ser un objeto JSON con la siguiente estructura:

{
    "id": "INSTANCE_ID"  // ID de la instancia conectada a WhatsApp
}
    

📌 Ejemplos de Uso

const axios = require("axios");

let data = JSON.stringify({
    "id": "INSTANCE_ID"
});

let config = {
    method: 'post',
    url: 'https://apiwhatsappweb.com/api/contacts',
    headers: { 
        'apiKey': 'Bearer Your_ApiKey',
        'id': 'Your_Instance_ID_Here',
        'Content-Type': 'application/json'
    },
    data: data
};

axios.request(config)
    .then(response => console.log(response.data))
    .catch(error => console.error(error));

Sobre nosotros

API WhatsApp Web – Su solución completa para integrar y automatizar la comunicación vía WhatsApp.

Conéctate con nosotros

© 2024 API WA message API - Todos los derechos reservados.