Help Center Kompatibilità TurboSMS API

Kompatibilità TurboSMS API

SMSBAT jappoġġja bis-sħiħ saff ta’ kompatibilità mal-TurboSMS API. Dan jippermettilek temigra l-integrazzjonijiet eżistenti tiegħek li kienu ddisinjati għat-TurboSMS direttament għal SMSBAT mingħajr ma jkollok bżonn tikteb mill-ġdid l-istrutturi tal-messaġġi jew il-payloads tal-endpoint.

Aħna nappoġġaw li jintbagħtu messaġġi SMS u Viber (inklużi karatteristiċi avvanzati bħall-karużelli u stħarriġ), il-ġbir ta’ status, u l-ġbir ta’ dettalji tal-messaġġi bl-użu eżatt tal-istess strutturi tal-korp ta’ talba li inti diġà familjari magħhom.

Awtentikazzjoni

L-unika differenza mill-API TurboSMS nattiva hija l-mekkaniżmu ta ‘Awtentikazzjoni. Filwaqt li TurboSMS juża parametru ta’ mistoqsija “token” tad-dwana jew header ta’ awtorizzazzjoni speċifiku, SMSBAT jeħtieġ Bearer Token standard.

Trid tinkludi l-SMSBAT API Token tiegħek fl-intestatura “Awtorizzazzjoni” għat-talbiet kollha:

Authorization: Bearer YOUR_SMSBAT_TOKEN

URL tal-bażi

L-endpoints kollha għandhom ikunu diretti lejn il-URL bażi tal-API SMSBAT:

https://restapi.smsbat.com

Ibgħat Messaġġ Uniku

Endpoint: POST /api/tsms/message/send

Jippermetti li jintbagħtu messaġġi SMS u Viber b’appoġġ għall-kunsinna ibrida (Viber b’SMS fallback). Jipproċessa talba waħda biex tibgħat u jirritorna r-riżultati tal-kunsinna għal kull riċevitur.

Kapaċitajiet Ewlenin

  • Parametri Flessibbli: Parametri globali jistgħu jiġu sostitwiti minn parametri speċifiċi ta ‘SMS/Viber.
  • Kontenut: Jappoġġja karużelli Viber, stħarriġ, attachments tal-fajls, u buttuni interattivi.
  • Immaniġġjar ta’ Żbalji: Jirritorna HTTP 200 anke għal żbalji (tweġibiet ta’ żball strutturati). response_code: 999 bi status FATAL_ERROR għal żbalji tas-sistema.
  • Żbalji tar-Riċevitur: Żbalji speċifiċi tar-riċevitur jintbagħtu lura fil-firxa response_result. Ir-riċevituri li fallew għandhom message_id: null u kodiċi ta’ żball speċifiċi.

Eżempju ta’ Talba (Messaġġ Ibridu)

{
  "sender": "GlobalSender",
  "text": "Test message",
  "recipients": ["380951111111", "380952222222"],
  "start_time": "2025-09-29T10:00:00Z",
  "sequence_id": "seq_12345",
  "sms": {
    "sender": "SMSSender",
    "text": "SMS version of message",
    "is_flash": false
  },
  "viber": {
    "sender": "ViberSender",
    "text": "Viber version of message",
    "ttl": 3600,
    "image_url": "https://example.com/image.png",
    "caption": "Button text",
    "action": "https://google.com",
    "count_clicks": true,
    "is_transactional": false
  }
}

{
  "sender": "GlobalSender",
  "text": "Check out our products",
  "recipients": ["380951111111"],
  "viber": {
    "sender": "ViberSender",
    "text": "Check out our products",
    "is_transactional": false,
    "carousel": [
      {
        "title": "Product 1",
        "image_url": "https://example.com/product1.jpg",
        "button_caption": "Buy Now",
        "button_url": "https://example.com/buy/product1",
        "link_caption": "Learn More",
        "link_url": "https://example.com/product1"
      },
      {
        "title": "Product 2",
        "image_url": "https://example.com/product2.jpg",
        "button_caption": "Buy Now",
        "button_url": "https://example.com/buy/product2",
        "link_caption": "Learn More",
        "link_url": "https://example.com/product2"
      }
    ]
  }
}

Talba Eżempju (Stħarriġ Viber)

{
  "sender": "GlobalSender",
  "text": "Please rate our service",
  "recipients": ["380951111111"],
  "viber": {
    "sender": "ViberSender",
    "text": "Please rate our service",
    "is_transactional": true,
    "survey": [
      "Excellent",
      "Good",
      "Average",
      "Poor"
    ]
  }
}

Ibgħat messaġġi multipli (lott)

Endpoint: POST /api/tsms/message/sendmulti

Dan il-metodu jippermettilek li tibgħat talbiet multipli “ibgħat” f’talba HTTP waħda, filwaqt li tiffranka l-overhead tal-konnessjoni. Sejħa “sendmulti” b’dejta għal 100 talba tkun aktar mgħaġġla milli tesegwixxi 100 talba individwali “ibgħat”.

Talba Eżempju

{
  "batch_1": {
    "sender": "GlobalSender",
    "text": "Test message",
    "recipients": ["380982462128", "380501111111"],    
    "sms": {
        "sender": "SMSSender",
        "text": "SMS version of message"
    }
  },
  "batch_2": {
    "sender": "GlobalSender",
    "text": "Second message",
    "recipients": ["380501111111"],
    "viber": {
      "sender": "ViberSender",
      "text": "Viber message",
      "is_transactional": true
    }
  }
}

Eżempju ta’ Rispons

{
    "response_code": 0,
    "response_status": "OK",
    "response_result": {
        "batch_1": {
            "response_code": 800,
            "response_status": "SUCCESS_MESSAGE_ACCEPTED",
            "response_result": [
                {
                    "phone": "380982462128",
                    "response_code": 0,
                    "message_id": "f1640579-ea75-4bc1-b708-1c3858bf222d",
                    "response_status": "OK"
                }
            ]
        },
        "batch_2": { ... }
    }
}

Ikseb l-Istatus tal-Messaġġ

Endpoint: POST /api/tsms/messagg/status

Irkupra l-istatus tat-twassil tal-messaġġi mibgħuta billi tipprovdi l-”message_id” tagħhom.

Talba Eżempju

{
  "messages": [
      "573dcb46-7851-4e16-bb1f-721c13ef5f38", 
      "6b7f9ff5-28c8-4f38-913b-31af6021fbea"
  ]
}

Ikseb id-Dettalji tal-Messaġġ

Endpoint: POST /api/tsms/message/details

Jippermettilek tirkupra informazzjoni dettaljata dwar messaġġi maħluqa, inklużi dettalji sħaħ tat-tagħbija għall-kanali SMS u Viber, prezzijiet, u timestamps eżatti.

Talba Eżempju

{
  "messages": [
      "573dcb46-7851-4e16-bb1f-721c13ef5f38", 
      "f1640579-ea75-4bc1-b708-1c3858bf222d"
  ]
}

Eżempju ta’ Rispons

{
    "response_code": 0,
    "response_status": "OK",
    "response_result": [
        {
            "message_id": "573dcb46-7851-4e16-bb1f-721c13ef5f38",
            "sms": null,
            "viber": {
                "added": "2025-09-29T14:17:02.577Z",
                "start": "2025-09-29T10:00:00Z",
                "sent": "2025-09-29T14:17:02.577Z",
                "updated": "2025-09-29T14:17:02.577Z",
                "sender": "ViberSender",
                "text": "Viber version of message",
                "recipient": "380982462128",
                "message_type": "promotional",
                "status": "Queued",
                "price": 0,
                "ttl": 3600,
                "caption": "Button text",
                "action": "https://google.com"
            },
            "response_code": 0,
            "response_status": "OK"
        }
    ]
}