Skip to content

Iċċekkja l-Istatus tal-Messaġġ

Intraċċa l-istat tal-kunsinna tal-messaġġi tiegħek billi tuża l-endpoint tal-kontroll tal-istatus.

Endpoint

GET /bat/message/{messageId}

Talba

Parametri tal-URL

Parametru Tip Meħtieġa Deskrizzjoni
MessageId spag Iva Identifikatur uniku tal-messaġġ mir-rispons ibgħat

Awtentikazzjoni

Uża kwalunkwe mit-tliet metodi ta' awtentikazzjoni:

curl -X GET https://restapi.smsbat.com/bat/message/abc123def456 \
  -H "X-Authorization-Key: your-api-key"

curl -X GET https://restapi.smsbat.com/bat/message/abc123def456 \
  -u "username:password"

curl -X GET https://restapi.smsbat.com/bat/message/abc123def456 \
  -u "@:your-api-key"

Rispons

Rispons Bażiku

{
  "messagelistId": 123456,
  "messageId": "abc123def456",
  "deliverystatus": "delivered",
  "partscount": 1,
  "cost": 0.05
}

Oqsma ta’ Rispons

Qasam Tip Deskrizzjoni
MessagelistId numru sħiħ Identifikatur tal-lott
MessageId spag Identifikatur uniku tal-messaġġ
deliverystatus spag Status attwali tal-kunsinna
"partscount" numru sħiħ Numru ta' partijiet tal-messaġġ
"ispiża" numru Kost tal-messaġġ f'unitajiet ta' munita

Rispons Estiż (b'Fallback)

Meta tiġi kkonfigurata l-fallback, ir-rispons jinkludi oqsma addizzjonali:

{
  "messagelistId": 123456,
  "messageId": "abc123def456",
  "deliverystatus": "delivered",
  "partscount": 1,
  "cost": 0.05,
  "fallbacks": [
    {
      "type": "sms",
      "status": "not_used"
    }
  ],
  "extendedStatuses": {
    "viber": "delivered",
    "sms": "not_used"
  },
  "rate": 0.05,
  "rateAmount": 0.05,
  "rateCurrency": "USD",
  "billAmount": 0.05,
  "billCurrency": "USD"
}

Valuri tal-Istatus ta' Kunsinna

Status Deskrizzjoni
"skedat" Fil-kju biex jintbagħat
"ipproċessar" Bħalissa qed jintbagħat
"konsenjat" Imwassla b'suċċess
"ma jistax jitwassal" Il-kunsinna falliet, messaġġ miċħud
"error permanenti" Imneħħija mill-kju minħabba żball persistenti

Ċiklu tal-Ħajja tal-Istat

graph LR
    A[scheduled] --> B[processing]
    B --> C[delivered]
    B --> D[undeliverable]
    B --> E[permanenterror]

Skedata

Il-messaġġ huwa aċċettat u fil-kju għall-kunsinna:

{
  "deliverystatus": "scheduled",
  "partscount": 1
}

Ipproċessar

Bħalissa qed jintbagħat messaġġ lir-riċevitur:

{
  "deliverystatus": "processing",
  "partscount": 1
}

Mogħtija

Messaġġ ikkunsinnat b'suċċess lir-riċevitur:

{
  "deliverystatus": "delivered",
  "partscount": 1,
  "cost": 0.05
}

Ma jistax jitwassal

Il-messaġġ ma setax jitwassal (numru mhux validu, żball tan-netwerk):

{
  "deliverystatus": "undeliverable",
  "partscount": 1,
  "cost": 0.00
}

Żball Permanenti

Messaġġ imneħħi mill-kju minħabba kwistjonijiet persistenti ta' kunsinna:

{
  "deliverystatus": "permanenterror",
  "partscount": 1,
  "cost": 0.00
}

Iċċekkja Messaġġi Multipli

Iċċekkja l-istatus għal messaġġi multipli fl-applikazzjoni tiegħek:

// JavaScript example
async function checkMessageStatuses(messageIds) {
  const statuses = await Promise.all(
    messageIds.map(async (messageId) => {
      const response = await fetch(
        `https://restapi.smsbat.com/bat/message/${messageId}`,
        {
          headers: {
            'X-Authorization-Key': 'your-api-key'
          }
        }
      );
      return response.json();
    })
  );

  return statuses;
}

// Usage
const messageIds = ['abc123', 'def456', 'ghi789'];
const statuses = await checkMessageStatuses(messageIds);

statuses.forEach(status => {
  console.log(`Message ${status.messageId}: ${status.deliverystatus}`);
});

Votazzjoni għal Aġġornamenti tal-Istatus

Ivverifika l-endpoint tal-istatus biex issegwi l-kunsinna:

// Poll every 5 seconds until delivered
async function waitForDelivery(messageId, maxAttempts = 12) {
  for (let i = 0; i < maxAttempts; i++) {
    const response = await fetch(
      `https://restapi.smsbat.com/bat/message/${messageId}`,
      {
        headers: { 'X-Authorization-Key': 'your-api-key' }
      }
    );

    const status = await response.json();

    if (status.deliverystatus === 'delivered') {
      return { success: true, status };
    }

    if (status.deliverystatus === 'undeliverable' ||
        status.deliverystatus === 'permanenterror') {
      return { success: false, status };
    }

    // Wait 5 seconds before next check
    await new Promise(resolve => setTimeout(resolve, 5000));
  }

  // Timeout after 60 seconds
  return { success: false, timeout: true };
}

Alternattiva tal-Webhook

Minflok il-votazzjoni, uża webhooks għal aġġornamenti tal-istatus f'ħin reali:

POST https://your-server.com/webhook
{
  "messageId": "abc123def456",
  "deliverystatus": "delivered",
  "timestamp": "2025-01-23T10:30:00Z",
  "cost": 0.05
}

Ikkuntattja lill-maniġer tal-kont tiegħek biex tikkonfigura l-URL tal-webhook.

Eżempji ta' Implimentazzjoni

Python

import requests
import time

def check_status(message_id, api_key):
    url = f"https://restapi.smsbat.com/bat/message/{message_id}"
    headers = {"X-Authorization-Key": api_key}

    response = requests.get(url, headers=headers)
    return response.json()

def wait_for_delivery(message_id, api_key, timeout=60):
    """Poll until delivered or timeout"""
    start_time = time.time()

    while time.time() - start_time < timeout:
        status = check_status(message_id, api_key)

        if status['deliverystatus'] == 'delivered':
            return {'success': True, 'status': status}

        if status['deliverystatus'] in ['undeliverable', 'permanenterror']:
            return {'success': False, 'status': status}

        time.sleep(5)

    return {'success': False, 'timeout': True}

# Usage
message_id = "abc123def456"
result = wait_for_delivery(message_id, "your-api-key")

if result['success']:
    print(f"Message delivered! Cost: {result['status']['cost']}")
else:
    print("Message delivery failed or timeout")

PHP

<?php

function checkStatus($messageId, $apiKey) {
    $url = "https://restapi.smsbat.com/bat/message/" . $messageId;

    $ch = curl_init($url);
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
    curl_setopt($ch, CURLOPT_HTTPHEADER, [
        "X-Authorization-Key: " . $apiKey
    ]);

    $response = curl_exec($ch);
    curl_close($ch);

    return json_decode($response, true);
}

function waitForDelivery($messageId, $apiKey, $timeout = 60) {
    $startTime = time();

    while (time() - $startTime < $timeout) {
        $status = checkStatus($messageId, $apiKey);

        if ($status['deliverystatus'] === 'delivered') {
            return ['success' => true, 'status' => $status];
        }

        if (in_array($status['deliverystatus'],
                    ['undeliverable', 'permanenterror'])) {
            return ['success' => false, 'status' => $status];
        }

        sleep(5);
    }

    return ['success' => false, 'timeout' => true];
}

// Usage
$messageId = "abc123def456";
$result = waitForDelivery($messageId, "your-api-key");

if ($result['success']) {
    echo "Message delivered! Cost: " . $result['status']['cost'];
} else {
    echo "Message delivery failed or timeout";
}

Node.js

const axios = require('axios');

async function checkStatus(messageId, apiKey) {
  const response = await axios.get(
    `https://restapi.smsbat.com/bat/message/${messageId}`,
    {
      headers: { 'X-Authorization-Key': apiKey }
    }
  );

  return response.data;
}

async function waitForDelivery(messageId, apiKey, timeout = 60000) {
  const startTime = Date.now();

  while (Date.now() - startTime < timeout) {
    const status = await checkStatus(messageId, apiKey);

    if (status.deliverystatus === 'delivered') {
      return { success: true, status };
    }

    if (['undeliverable', 'permanenterror'].includes(
      status.deliverystatus
    )) {
      return { success: false, status };
    }

    // Wait 5 seconds
    await new Promise(resolve => setTimeout(resolve, 5000));
  }

  return { success: false, timeout: true };
}

// Usage
const messageId = 'abc123def456';
const result = await waitForDelivery(messageId, 'your-api-key');

if (result.success) {
  console.log(`Message delivered! Cost: ${result.status.cost}`);
} else {
  console.log('Message delivery failed or timeout');
}

L-Aħjar Prattiċi

Frekwenza tal-Votazzjoni

  • ✅ Poll kull 5-10 sekondi
  • ✅ Timplimenta backoff esponenzjali
  • ✅ Issettja timeout raġonevoli (60-120 sekonda)
  • ❌ Tivotax aktar minn darba kull sekonda
  • ❌ Tivotax b'mod indefinit

Immaniġġjar ta' Żbalji

async function checkStatusWithRetry(messageId, apiKey, retries = 3) {
  for (let i = 0; i < retries; i++) {
    try {
      const response = await fetch(
        `https://restapi.smsbat.com/bat/message/${messageId}`,
        {
          headers: { 'X-Authorization-Key': apiKey }
        }
      );

      if (!response.ok) {
        throw new Error(`HTTP ${response.status}`);
      }

      return await response.json();
    } catch (error) {
      if (i === retries - 1) throw error;

      // Wait before retry (exponential backoff)
      await new Promise(resolve =>
        setTimeout(resolve, Math.pow(2, i) * 1000)
      );
    }
  }
}

Caching

Riżultati tal-istatus tal-cache biex jitnaqqsu sejħiet API:

const statusCache = new Map();

async function getCachedStatus(messageId, apiKey, cacheTTL = 30000) {
  const cached = statusCache.get(messageId);

  if (cached && Date.now() - cached.timestamp < cacheTTL) {
    return cached.status;
  }

  const status = await checkStatus(messageId, apiKey);

  statusCache.set(messageId, {
    status,
    timestamp: Date.now()
  });

  return status;
}

Ipproċessar tal-lott

Meta tiċċekkja ħafna messaġġi, it-talbiet tal-lott:

async function checkBatchStatus(messageIds, apiKey, batchSize = 10) {
  const results = [];

  for (let i = 0; i < messageIds.length; i += batchSize) {
    const batch = messageIds.slice(i, i + batchSize);
    const batchResults = await Promise.all(
      batch.map(id => checkStatus(id, apiKey))
    );
    results.push(...batchResults);

    // Rate limiting
    if (i + batchSize < messageIds.length) {
      await new Promise(resolve => setTimeout(resolve, 1000));
    }
  }

  return results;
}

Każijiet ta' Użu

Konferma tal-Ordni

Track il-kunsinna tal-messaġġi ta' konferma tal-ordni:

const orderMessage = await sendMessage({
  to: customer.phone,
  text: `Order #${orderId} confirmed`
});

// Wait for delivery
const result = await waitForDelivery(orderMessage.messageId, apiKey);

if (result.success) {
  await updateOrder(orderId, { notificationSent: true });
} else {
  await scheduleRetry(orderId);
}

Awtentikazzjoni b'żewġ fatturi

Ivverifika l-kunsinna OTP qabel iż-żmien:

const otpMessage = await sendOTP(userPhone, otpCode);

// Poll for delivery
const delivered = await waitForDelivery(
  otpMessage.messageId,
  apiKey,
  30 // 30 second timeout
);

if (!delivered.success) {
  // Send via alternative channel
  await sendEmailOTP(userEmail, otpCode);
}

Kampanji ta' Marketing

Issegwi r-rati tal-kunsinna tal-messaġġi tal-kampanja:

const messageIds = await sendCampaign(recipientList);

// Check all statuses after 5 minutes
setTimeout(async () => {
  const statuses = await checkBatchStatus(messageIds, apiKey);

  const delivered = statuses.filter(s =>
    s.deliverystatus === 'delivered'
  ).length;

  console.log(`Delivery rate: ${delivered / statuses.length * 100}%`);
}, 5 * 60 * 1000);

Il-passi li jmiss