Cuentas WhatsApp

Flujo de vinculacion

Para usar WhatsApp a traves de WhatsBoost, necesitas vincular al menos una cuenta escaneando un codigo QR. El flujo completo es el siguiente:

Vincular cuenta (generar QR)

POST /api/create/wa.link

Genera un codigo QR para vincular una nueva cuenta de WhatsApp. El sistema selecciona automaticamente un servidor WA con capacidad disponible.

Parametros

Permisos requeridos: create_whatsapp

Respuesta exitosa

{
  "status": 200,
  "message": "QR code generated successfully",
  "data": {
    "qrstring": "2@abc123...base64encodedstring",
    "qrimagelink": "https://tudominio.com/api/get/wa.qr?token=TOKEN_UNICO",
    "infolink": "https://tudominio.com/api/get/wa.info?token=TOKEN_UNICO"
  }
}

Revincular cuenta existente

POST /api/create/wa.relink

Revincula una cuenta de WhatsApp que se ha desconectado. Tambien permite migrar la cuenta a un servidor diferente especificando el parametro sid.

Parametros

Respuesta exitosa

{
  "status": 200,
  "message": "QR code generated successfully",
  "data": {
    "qrstring": "2@abc123...",
    "qrimagelink": "https://tudominio.com/api/get/wa.qr?token=TOKEN_UNICO",
    "infolink": "https://tudominio.com/api/get/wa.info?token=TOKEN_UNICO"
  }
}

Listar cuentas vinculadas

GET /api/get/wa.accounts

Obtiene la lista de todas las cuentas de WhatsApp vinculadas a tu usuario con paginacion.

Parametros

Permisos requeridos: get_wa_accounts

Respuesta exitosa

{
  "status": 200,
  "message": "WhatsApp Accounts",
  "data": [
    {
      "id": 15,
      "phone": "+34612345678",
      "unique": "a1b2c3d4e5f6",
      "status": "connected",
      "created": "2025-03-15 10:30:00"
    },
    {
      "id": 16,
      "phone": "+34698765432",
      "unique": "f6e5d4c3b2a1",
      "status": "disconnected",
      "created": "2025-04-01 14:20:00"
    }
  ]
}

Obtener imagen QR

GET /api/get/wa.qr?token={token}

Devuelve directamente la imagen PNG del codigo QR. No devuelve JSON, sino el binario de la imagen. Puedes usar esta URL directamente en una etiqueta <img>.

Parametros

Ejemplo de uso en HTML

<img src="https://tudominio.com/api/get/wa.qr?token=TOKEN_UNICO" alt="QR WhatsApp" />

Verificar estado de vinculacion

GET /api/get/wa.info?token={token}

Despues de que el usuario escanee el QR, usa este endpoint para comprobar si la vinculacion fue exitosa. Devuelve la informacion de la cuenta si ya se completo la vinculacion.

Parametros

Respuesta exitosa (vinculacion completada)

{
  "status": 200,
  "message": "Account linked successfully",
  "data": {
    "phone": "+34612345678",
    "unique": "a1b2c3d4e5f6",
    "status": "connected"
  }
}

Respuesta pendiente (aun no se escaneo)

{
  "status": 202,
  "message": "Waiting for QR scan",
  "data": false
}

Eliminar cuenta

DELETE /api/delete/wa.account

Elimina permanentemente una cuenta de WhatsApp vinculada. La cuenta se elimina de WhatsBoost y se desconecta del servidor.

Parametros

Permisos requeridos: delete_wa_account

Respuesta exitosa

{
  "status": 200,
  "message": "WhatsApp account has been deleted."
}

Servidores disponibles

GET /api/get/wa.servers

Retorna la lista de servidores WhatsApp disponibles con su estado y capacidad. Util para verificar la disponibilidad del servicio o elegir un servidor especifico al revincular.

Parametros

Respuesta exitosa

{
  "status": 200,
  "message": "WhatsApp Servers",
  "data": [
    {
      "id": 1,
      "name": "WA Server EU-1",
      "status": "online",
      "accounts": 45,
      "capacity": 100
    },
    {
      "id": 2,
      "name": "WA Server EU-2",
      "status": "offline",
      "accounts": 0,
      "capacity": 100
    }
  ]
}

Estados de conexion

Cada cuenta de WhatsApp vinculada tiene un estado de conexion que indica su disponibilidad actual:

Configuracion de cuenta

Cada cuenta vinculada tiene opciones de configuracion que controlan el comportamiento de envio y recepcion:

Ejemplos de codigo

Vincular una nueva cuenta

curl -X POST https://tudominio.com/api/create/wa.link \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "secret=TU_API_KEY"

$ch = curl_init();
curl_setopt_array($ch, [
    CURLOPT_URL            => "https://tudominio.com/api/create/wa.link",
    CURLOPT_POST           => true,
    CURLOPT_POSTFIELDS     => http_build_query([
        "secret" => "TU_API_KEY"
    ]),
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER     => ["Content-Type: application/x-www-form-urlencoded"]
]);
$response = curl_exec($ch);
curl_close($ch);

$data = json_decode($response, true);

if ($data["status"] === 200) {
    echo "QR Image: " . $data["data"]["qrimagelink"];
    echo "Verificar estado: " . $data["data"]["infolink"];
} else {
    echo "Error: " . $data["message"];
}

Listar cuentas vinculadas

curl -X GET "https://tudominio.com/api/get/wa.accounts?secret=TU_API_KEY&page=1&limit=10"

$ch = curl_init();
curl_setopt_array($ch, [
    CURLOPT_URL            => "https://tudominio.com/api/get/wa.accounts?" . http_build_query([
        "secret" => "TU_API_KEY",
        "page"   => 1,
        "limit"  => 10
    ]),
    CURLOPT_RETURNTRANSFER => true
]);
$response = curl_exec($ch);
curl_close($ch);

$data = json_decode($response, true);

if ($data["status"] === 200) {
    foreach ($data["data"] as $account) {
        echo $account["phone"] . " — " . $account["status"] . "\n";
    }
}

Eliminar una cuenta

curl -X DELETE https://tudominio.com/api/delete/wa.account \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "secret=TU_API_KEY&unique=a1b2c3d4e5f6"

$ch = curl_init();
curl_setopt_array($ch, [
    CURLOPT_URL            => "https://tudominio.com/api/delete/wa.account",
    CURLOPT_CUSTOMREQUEST  => "DELETE",
    CURLOPT_POSTFIELDS     => http_build_query([
        "secret" => "TU_API_KEY",
        "unique" => "a1b2c3d4e5f6"
    ]),
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER     => ["Content-Type: application/x-www-form-urlencoded"]
]);
$response = curl_exec($ch);
curl_close($ch);

$data = json_decode($response, true);
echo $data["message"];

Documentacion relacionada