Documentación API

ZiraBox API Documentation

API REST profesional para automatizar el envío de mensajes de WhatsApp con máxima confiabilidad y escalabilidad. Consulta nuestros planes y precios para más información.

Rápido y Confiable

API REST optimizada para envío de mensajes de WhatsApp en tiempo real con alta disponibilidad y respuesta instantánea

Seguro y Escalable

Autenticación por tokens API seguros, límites inteligentes y conexiones HTTPS encriptadas para máxima seguridad

Fácil Integración

Integra en minutos con cualquier lenguaje de programación usando nuestra API REST simple y bien documentada

Comenzar

Sigue estos pasos para empezar a usar ZiraBox en minutos

Crear una cuenta

Regístrate en ZiraBox para obtener acceso inmediato a la API

Conectar WhatsApp

Escanea el código QR para conectar tu cuenta de WhatsApp de forma segura

Obtener credenciales

Copia tu User ID y API Token desde el dashboard de administración

Enviar mensajes

Usa la API para enviar mensajes según tu plan. Ver precios

Rápido y Confiable

API REST optimizada para envío de mensajes de WhatsApp en tiempo real con alta disponibilidad

Seguro y Escalable

Autenticación por tokens API seguros, límites inteligentes y conexiones HTTPS encriptadas

Fácil Integración

Integra en minutos con cualquier lenguaje de programación usando nuestra API REST

Referencia API

Documentación completa de los endpoints disponibles

POST

/api/send-message

Envía un mensaje de WhatsApp a un número específico

Límites: Consulta nuestros planes y precios para conocer los límites de cada plan

Headers

Authorization: Bearer YOUR_API_TOKEN
Content-Type: application/json

Body Parameters

Parámetro	Tipo	Requerido	Descripción
`number`	string	Sí	Número de teléfono con código de país (ej: 573001234567)
`message`	string	Sí	Contenido del mensaje a enviar

Ejemplo de Request

curl -X POST https://zirabox.com/api/send-message \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "number": "573001234567",
    "message": "¡Hola! Este es un mensaje desde ZiraBox."
  }'

Respuestas

200 - Éxito

{
  "success": true,
  "message": "Mensaje enviado exitosamente",
  "messagesUsed": 15,
  "remainingMessages": 5,
  "planType": "free"
}

429 - Límite Alcanzado

{
  "success": false,
  "error": "Límite de mensajes alcanzado",
  "planType": "free",
  "upgradeUrl": "https://zirabox.com/pricing"
}

POST

/api/webhooks/config

Premium

Configura webhooks para recibir notificaciones en tiempo real (solo usuarios premium)

Body Parameters

Parámetro	Tipo	Descripción
`webhookUrl`	string	URL donde recibir las notificaciones
`secretToken`	string	Token secreto para validar webhooks

Ejemplos de Código

Ejemplos en diferentes lenguajes de programación

JS
JavaScript/Node.js

const axios = require('axios');

async function sendWhatsAppMessage(number, message) {
  try {
    const response = await axios.post('https://zirabox.com/api/send-message', {
      number: number,
      message: message
    }, {
      headers: {
        'Authorization': 'Bearer YOUR_API_TOKEN',
        'Content-Type': 'application/json'
      }
    });
    
    console.log('Mensaje enviado:', response.data);
    console.log(`Mensajes usados: ${response.data.messagesUsed}`);
    console.log(`Mensajes restantes: ${response.data.remainingMessages}`);
    console.log(`Plan: ${response.data.planType}`);
    
  } catch (error) {
    if (error.response?.status === 429) {
      console.log('Límite de mensajes alcanzado. Ver planes en: https://zirabox.com/pricing');
    } else {
      console.error('Error:', error.response?.data || error.message);
    }
  }
}

// Uso
sendWhatsAppMessage('573001234567', '¡Hola desde ZiraBox!');

PY
Python

import requests
import json

def send_whatsapp_message(number, message):
    url = "https://zirabox.com/api/send-message"
    
    headers = {
        "Authorization": "Bearer YOUR_API_TOKEN",
        "Content-Type": "application/json"
    }
    
    data = {
        "number": number,
        "message": message
    }
    
    try:
        response = requests.post(url, headers=headers, json=data)
        
        if response.status_code == 200:
            result = response.json()
            print(f"Mensaje enviado: {result['message']}")
            print(f"Mensajes usados: {result['messagesUsed']}")
            print(f"Mensajes restantes: {result['remainingMessages']}")
            print(f"Plan: {result['planType']}")
                
        elif response.status_code == 429:
            print("Límite de mensajes alcanzado. Ver planes en: https://zirabox.com/pricing")
        else:
            response.raise_for_status()
            
    except requests.exceptions.RequestException as e:
        print(f"Error: {e}")

# Uso
send_whatsapp_message("573001234567", "¡Hola desde ZiraBox!")

PHP
PHP

<?php
function sendWhatsAppMessage($number, $message) {
    $url = 'https://zirabox.com/api/send-message';
    
    $data = array(
        'number' => $number,
        'message' => $message
    );
    
    $options = array(
        'http' => array(
            'header' => "Authorization: Bearer YOUR_API_TOKEN\r\n" .
                       "Content-Type: application/json\r\n",
            'method' => 'POST',
            'content' => json_encode($data)
        )
    );
    
    $context = stream_context_create($options);
    $result = file_get_contents($url, false, $context);
    
    if ($result === FALSE) {
        echo "Error enviando mensaje\n";
    } else {
        $response = json_decode($result, true);
        
        if (isset($response['success']) && $response['success']) {
            echo "Mensaje enviado: " . $response['message'] . "\n";
            echo "Mensajes usados: " . $response['messagesUsed'] . "\n";
            echo "Mensajes restantes: " . $response['remainingMessages'] . "\n";
            echo "Plan: " . $response['planType'] . "\n";
        } else {
            echo "Error: " . ($response['error'] ?? 'Error desconocido') . "\n";
        }
    }
}

// Uso
sendWhatsAppMessage("573001234567", "¡Hola desde ZiraBox!");
?>

Códigos de Error

Códigos de estado HTTP y sus significados

Código	Estado	Descripción
200	OK	Mensaje enviado exitosamente
400	Bad Request	Parámetros faltantes o inválidos
401	Unauthorized	Token API inválido o faltante
403	Forbidden	Función requiere suscripción Premium
404	Not Found	Endpoint no encontrado
429	Too Many Requests	Límite diario de mensajes alcanzado
500	Internal Server Error	Error interno del servidor

Mejores Prácticas

Recomendaciones para usar ZiraBox de manera efectiva

Manejo de Límites

Monitorea el contador de mensajes en cada respuesta y maneja el error 429 apropiadamente

Manejo de Errores

Implementa retry logic y manejo de errores robusto para todos los códigos de estado HTTP

Validación de Números

Valida los números de teléfono antes de enviar mensajes para evitar errores y desperdiciar límites

Seguridad del Token

Nunca expongas tu API token en el frontend. Úsalo solo en el backend

Webhooks Premium

Los webhooks solo están disponibles para usuarios Premium. Actualiza tu plan para recibir notificaciones en tiempo real

Contactos Guardados

Para mejores resultados, asegúrate de que los destinatarios tengan tu número guardado

ZiraBox API Documentation

Crear una cuenta

Conectar WhatsApp

Obtener credenciales

Enviar mensajes

Headers

Body Parameters

Ejemplo de Request

Respuestas

Body Parameters

JSJavaScript/Node.js

PYPython

PHPPHP

Manejo de Límites

Manejo de Errores

Validación de Números

Seguridad del Token

Webhooks Premium

Contactos Guardados

JS
JavaScript/Node.js

PY
Python

PHP
PHP