API de historial de mensajes

Obtén una lista de los mensajes de tu espacio de trabajo en un rango de fechas, con el estado de cada uno. Úsala para cuadrar lo que se envió, generar informes o encontrar mensajes fallidos para reintentarlos.

El historial incluye todos los mensajes del espacio de trabajo de tu clave API, tanto si se enviaron a través de la API como desde el panel o una campaña. Los resultados llegan de 200 en 200 por página, del más antiguo al más reciente. Los mismos datos están disponibles en la página de Reportes.

Ejemplo rápido#

curl -X POST https://wbiztool.com/api/v1/report/ \
  -H "Content-Type: application/json" \
  -d '{
    "client_id": 12345,
    "api_key": "YOUR_API_KEY",
    "start_date": "01-09-2026",
    "end_date": "08-09-2026",
    "page": 1
  }'

import requests

page = 1
history = []

while True:
    response = requests.post(
        "https://wbiztool.com/api/v1/report/",
        json={
            "client_id": 12345,
            "api_key": "YOUR_API_KEY",
            "start_date": "01-09-2026",
            "end_date": "08-09-2026",
            "page": page,  # must be a JSON number, not a string
        },
        timeout=60,
    )
    result = response.json()  # read the body even when the HTTP code is 400

    if result.get("message") != "Success" or "total" not in result:
        print("Failed:", result.get("message", "no message in response"))
        break

    history.extend(result["history"])
    if page * 200 >= result["total"]:
        break
    page += 1

failed = [m for m in history if m["message_status"] == "Failed"]
print(len(history), "messages,", len(failed), "failed")

// Node.js 18+ (built-in fetch). Save as .mjs to use top-level await.
const history = [];
let page = 1;

while (true) {
  const response = await fetch("https://wbiztool.com/api/v1/report/", {
    method: "POST",
    headers: { "Content-Type": "application/json" },
    body: JSON.stringify({
      client_id: 12345,
      api_key: "YOUR_API_KEY",
      start_date: "01-09-2026",
      end_date: "08-09-2026",
      page, // must be a JSON number, not a string
    }),
  });
  const result = await response.json(); // read the body even when the HTTP code is 400

  if (result.message !== "Success" || !("total" in result)) {
    console.error("Failed:", result.message ?? "no message in response");
    break;
  }

  history.push(...result.history);
  if (page * 200 >= result.total) break;
  page += 1;
}

const failed = history.filter((m) => m.message_status === "Failed");
console.log(`${history.length} messages, ${failed.length} failed`);

<?php
$history = [];
$page = 1;

do {
    $ch = curl_init('https://wbiztool.com/api/v1/report/');
    curl_setopt_array($ch, [
        CURLOPT_POST           => true,
        CURLOPT_HTTPHEADER     => ['Content-Type: application/json'],
        CURLOPT_POSTFIELDS     => json_encode([
            'client_id'  => 12345,
            'api_key'    => 'YOUR_API_KEY',
            'start_date' => '01-09-2026',
            'end_date'   => '08-09-2026',
            'page'       => $page, // an integer, so json_encode sends a number
        ]),
        CURLOPT_RETURNTRANSFER => true,
        CURLOPT_TIMEOUT        => 60,
    ]);
    $result = json_decode(curl_exec($ch), true);
    curl_close($ch);

    if (($result['message'] ?? '') !== 'Success' || !isset($result['total'])) {
        echo 'Failed: ' . ($result['message'] ?? 'no message in response');
        break;
    }

    $history = array_merge($history, $result['history']);
    $page++;
} while (($page - 1) * 200 < $result['total']);

echo count($history) . ' messages';

Sustituye 12345 y YOUR_API_KEY por tus propios valores. Consulta Autenticación para saber dónde encontrarlos.

Parámetros de la solicitud#

Rango de fechas#

Las fechas se interpretan como la medianoche al inicio de ese día en la hora estándar de la India (IST, UTC+5:30), y los mensajes se filtran según cuándo se crearon (se pusieron en cola o se programaron), no según cuándo se enviaron. El rango va desde start_date a las 00:00 hasta end_date a las 00:00, así que:

• "start_date": "01-09-2026", "end_date": "08-09-2026" devuelve del 1 al 7 de septiembre. El 8 de septiembre no se incluye.
• Para obtener un solo día, pon en end_date el día siguiente: "start_date": "15-09-2026", "end_date": "16-09-2026".
• Si las dos fechas son iguales, no obtienes ningún mensaje.

Paginación#

Cada respuesta contiene total, el número de mensajes de todo el rango, y hasta 200 de ellos en history. Pide la page 2, 3 y así sucesivamente hasta que page × 200 sea como mínimo total.

Respuesta#

Una solicitud correcta devuelve HTTP 200:

{
  "message": "Success",
  "status": 0,
  "total": 3,
  "history": [
    { "id": 9817263, "msg_type": "Text", "contact": "919876543210", "message_status": "Sent" },
    { "id": 9817264, "msg_type": "File", "contact": "919812345670", "message_status": "Failed" },
    { "id": 9817265, "msg_type": "Image", "contact": "Sales Team Mumbai", "message_status": "Pending" }
  ]
}

Valores de estado del mensaje#

Actualmente no se registran las marcas de entrega y lectura, así que los mensajes enviados siempre aparecen como Sent. Delivered y Read son valores reservados; si alguna vez aparecen, trátalos como Sent.

Errores#

Los errores devuelven HTTP 200 con status con valor 0, salvo que se indique lo contrario:

{ "message": "Error", "status": 0, "history": [] }

Consejos#

• Obtén el historial en rangos pequeños: un día o una semana cada vez mantiene bajo el número de páginas.
• Encuentra los mensajes fallidos: filtra history por Failed y luego llama a Estado del mensaje con cada id para ver por qué falló. Antes de reintentar, revisa el error: Sending was interrupted and may have been delivered… significa que es posible que el destinatario ya tenga el mensaje.
• Los mensajes antiguos se purgan: los mensajes que llegaron a un estado final y no han cambiado en unos 90 días pueden purgarse y dejar de aparecer aquí, igual que los mensajes que siguen en cola 90 días después de crearse o de su hora programada, en un número desconectado o eliminado.
• Seguimiento en tiempo real: para reaccionar a medida que se envían los mensajes, pasa un webhook cuando envíes el mensaje en lugar de consultar periódicamente este endpoint.