Help Center TurboSMS API Համատեղելիություն

TurboSMS API Համատեղելիություն

SMSBAT-ը լիովին աջակցում է TurboSMS API-ի հետ համատեղելիության շերտը: Սա թույլ է տալիս տեղափոխել ձեր գոյություն ունեցող ինտեգրումները, որոնք նախատեսված են TurboSMS-ի համար ուղղակիորեն դեպի SMSBAT՝ առանց հաղորդագրությունների կառուցվածքները կամ վերջնակետային բեռները վերագրելու:

Մենք աջակցում ենք SMS և Viber հաղորդագրությունների ուղարկմանը (ներառյալ առաջադեմ գործառույթները, ինչպիսիք են կարուսելները և հարցումները), ստատուսները և հաղորդագրությունների մանրամասները բեռնելու համար՝ օգտագործելով նույն հարցումների մարմնի կառուցվածքները, որոնց դուք արդեն ծանոթ եք:

Նույնականացում

Մայրենի TurboSMS API-ից միակ տարբերությունը վավերացման մեխանիզմն է: Մինչ TurboSMS-ն օգտագործում է «token» հարցման մաքսային պարամետր կամ որոշակի վավերացման վերնագիր, SMSBAT-ը պահանջում է ստանդարտ Bearer Token:

Բոլոր հարցումների համար դուք պետք է ներառեք ձեր SMSBAT API Token-ը «Authorization» վերնագրում.

Authorization: Bearer YOUR_SMSBAT_TOKEN

Հիմնական URL

Բոլոր վերջնակետերը պետք է ուղղվեն դեպի SMSBAT API բազային URL.

https://restapi.smsbat.com

Ուղարկել մեկ հաղորդագրություն

Վերջնական կետ. «POST /api/tsms/հաղորդագրություն/ուղարկել»:

Թույլ է տալիս ուղարկել SMS և Viber հաղորդագրություններ հիբրիդային առաքման աջակցությամբ (Viber՝ SMS հետադարձով): Այն մշակում է մեկ ուղարկման հարցում և վերադարձնում է առաքման արդյունքները յուրաքանչյուր ստացողի համար:

Հիմնական հնարավորություններ

  • Ճկուն պարամետրեր. Համաշխարհային պարամետրերը կարող են անտեսվել հատուկ SMS/Viber պարամետրերով:
  • Բովանդակություն. Աջակցում է Viber-ի կարուսելներին, հարցումներին, ֆայլերի հավելվածներին և ինտերակտիվ կոճակներին:
  • Սխալների մշակում. Վերադարձնում է HTTP 200 նույնիսկ սխալների դեպքում (կառուցվածքային սխալի պատասխաններ): «պատասխան_կոդ՝ 999»՝ «FATAL_ERROR» կարգավիճակով՝ համակարգի սխալների համար:
  • Ստացողի սխալներ. Ստացողի հատուկ սխալները վերադարձվում են «պատասխան_արդյունք» զանգվածում: Չհաջողված հասցեատերերն ունեն «message_id. null» և հատուկ սխալի կոդեր:

Հարցման օրինակ (հիբրիդային հաղորդագրություն)

{
  "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
  }
}

Հարցման օրինակ (Viber կարուսել)

{
  "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"
      }
    ]
  }
}

Հարցման օրինակ (Viber Survey)

{
  "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"
    ]
  }
}

Ուղարկեք բազմաթիվ հաղորդագրություններ (խմբաքանակ)

Վերջնակետ. «POST /api/tsms/message/sendmulti»:

Այս մեթոդը թույլ է տալիս ուղարկել բազմաթիվ «ուղարկելու» հարցումներ մեկ HTTP հարցումով՝ խնայելով կապի ծախսերը: 100 հարցումների համար «sendmulti» զանգահարելն ավելի արագ կլինի, քան 100 անհատական ​​«ուղարկելու» հարցումների կատարումը:

Հարցման օրինակ

{
  "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
    }
  }
}

Պատասխանի օրինակ

{
    "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": { ... }
    }
}

Ստացեք հաղորդագրության կարգավիճակը

Վերջնական կետ. «POST /api/tsms/հաղորդագրություն/կարգավիճակ»:

Առբերեք ուղարկված հաղորդագրությունների առաքման կարգավիճակները՝ տրամադրելով դրանց «message_id»:

Հարցման օրինակ

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

Ստացեք հաղորդագրության մանրամասները

Վերջնական կետ. «POST /api/tsms/հաղորդագրություն/դետալներ»:

Թույլ է տալիս առբերել ստեղծված հաղորդագրությունների մասին մանրամասն տեղեկատվություն, ներառյալ SMS և Viber ալիքների ամբողջական բեռնվածքի մանրամասները, գները և ճշգրիտ ժամանակի դրոշմանիշերը:

Հարցման օրինակ

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

Պատասխանի օրինակ

{
    "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"
        }
    ]
}