Անցնել պարունակությանը

SMSBAT RESTful API ուղեցույց

SMSBAT RESTful API-ի ամբողջական ուղեցույց – այն ամենը, ինչ դուք պետք է իմանաք:

Վերջին թարմացում՝ օգոստոսի 29, 2025

SMSBAT RESTful API-ն թույլ է տալիս ուղարկել տարբեր տեսակի հաղորդագրություններ՝ Viber-carousel, Viber-survey, Viber-promo (պատկերներ, տեսանյութեր), Viber բիզնես զրույցներ, OTP հաղորդագրություններ (Viber OTP, Flash Call) և դրանց հետադարձ տարբերակները:

Նշում. սա միասնական HTTP API-ն է ելքային հաղորդագրությունների համար: Եթե ​​Ձեզ անհրաժեշտ է ինտեգրումներ ներգնա բոտերի հետ (Viber Bot / Telegram Bot), խնդրում ենք դիմել Cascade API-ին:

1. Արձանագրություն

  • Արձանագրություն՝ HTTPS
  • Հարցման մարմին. JSON օբյեկտ, որը պարունակում է «հաղորդագրությունների» զանգված:
  • Մեթոդներ:
  • «GET»՝ տվյալներ ստանալու համար (հաղորդագրության կարգավիճակ, մնացորդ և այլն)
  • «POST»՝ օբյեկտներ ստեղծելու համար (օրինակ՝ հեռարձակում/ուղարկում սկսել)
  • «PATCH»՝ օբյեկտները փոփոխելու համար

2. Թույլտվություն

Ձեր հարմարության համար մենք տրամադրում ենք թույլտվության մի քանի մեթոդներ. - HTTP Հիմնական նույնականացում (մուտք և գաղտնաբառը ձեր վահանակից): - Հատուկ HTTP վերնագիր «X-Authorization-Key», որը պարունակում է API նշան: - HTTP Հիմնական նույնականացման գաղտնաբառի դաշտ, որը պահում է API Token-ը (անցեք «@» որպես մուտք):

API Token-ը կարող է ստեղծվել վահանակում Օգտվողի պրոֆիլի տակ:

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

Հիմնական հեղինակությամբ. 

curl -H "Content-Type: application/json" \
  -X POST -d @/path/to/data.json https://api.smsbat.com/bat/messagelist \
  --user user:password

«X-Authorization-Key»-ով. 

curl -H "X-Authorization-Key: <token>" \
  -H "Content-Type: application/json" \
  -X POST -d @/path/to/data.json https://api.smsbat.com/bat/messagelist

3. Հաղորդագրություններ ուղարկելը

SMSBAT հարթակում ցանկացած հաղորդագրության ուղարկում (նույնիսկ մեկ հաղորդագրություն) համարվում է «Հեռարձակում» (հաղորդագրությունների ցանկ):

Վերջնակետ - Մեթոդ՝ ՓՈՍՏ - URL՝ «https://api.smsbat.com/bat/messagelist»: - Վերնագրեր. «Բովանդակության տեսակը. հավելված/json»:

** Հիմնական բեռի կառուցվածքը. 

{
  "messages": [
    {
      "from": "ALPHANAME",
      "to": "380936670003",
      "text": "Check out our new products!",
      "type": "viber_carousel",
      "ttl": 300,
      "messageData": { ... }
    }
  ]
}

Պահանջվող դաշտեր յուրաքանչյուր հաղորդագրության օբյեկտի համար.

  • «from»՝ հաստատված ուղարկողի ալֆա անունը:
  • «to»՝ ստացողի հեռախոսահամարը (E.164 ձևաչափ):
  • «տեսակ». Հաղորդագրության տեսակը enum:
  • «տեքստ»՝ հաղորդագրության հիմնական տեքստ (ըստ ցանկության, եթե տեսակը չի պահանջում տեքստ):

Աջակցվող «տիպի» արժեքներ՝ - «sms». - «viber_service» (կամ «viber_trans») - «viber_promo»: - «viber_carousel». - «viber_survey». - «viber_otp»: - «viber_sesion». - «flashcall_callback»: - «flashcall».

կամընտիր ընդհանուր դաշտեր.

  • «customerMessageId»՝ լարային ID ձեր սեփական համակարգի ներսում (օգտագործվում է հետադարձ զանգերին հետևելու համար): Պետք է լինի եզակի յուրաքանչյուր հաղորդագրության մեջ:
  • «dtSend»: ISO8601 Պլանավորված ապագա առաքման ամսաթիվը/ժամը:
  • «dtExpire»: ISO8601 Առաքման վերջնաժամկետի ամսաթիվ/ժամ:
  • ttl. Time-To-Live վայրկյաններով: (Եթե «dtExpire»-ը տրամադրված չէ, API-ն հաշվարկում է կանխադրված քարտեզագրումը «տիպից»):

Կանխադրված TTL-ներ (վայրկյաններ):

  • sms - 86400 (24ժ)
  • «viber_trans» / «viber_service» - 345600
  • viber_promo - 604800
  • viber_session - 604800

4. Հետադարձ երթուղում (կասկադային)

Դուք կարող եք նշել հետադարձ հերթ՝ ապահովելու հաղորդագրությունների առաքումը, եթե հիմնական ալիքը ձախողվի կամ ավարտվի:

{
  "messages": [
    {
      "from": "ALPHANAME",
      "to": "380500505051",
      "text": "test message",
      "type": "viber_service",
      "ttl": 60,
      "fallbacks": [
        {
          "from": "ALPHANAME",
          "to": "380936670003",
          "text": "test sms fallback message2",
          "type": "sms"
        }
      ]
    }
  ]
}
Հետադարձ կապերը սկսվում են, երբ մատակարարը մերժում է հիմնական հաղորդագրությունը կամ երբ TTL-ի ժամկետը լրանում է:

5. Հաղորդագրությունների տեսակների և հաղորդագրությունների տվյալների ակնարկ

Հաղորդագրությունների բարդ տեսակները պահանջում են լրացուցիչ կոնֆիգուրացիաներ, որոնք ներարկվում են «messageData» հատկության մեջ:

5.1 Viber Promo («viber_promo»)

Միայն պատկեր 

"messageData":{
  "img":"https://domain.com/image.png"
}

**Տեքստ + կոճակ ** 

"messageData":{
  "buttonText":"Save Now",
  "buttonAction":"https://help.smsbat.com"
}

** Պատկեր + Տեքստ + Կոճակ ** Միավորում է «img»-ը, «buttonText»-ը և «buttonAction»-ը:

Տեսանյութի ծանրաբեռնվածություն: 

"messageData":{
  "video": "https://domain.com/test.mp4",
  "thumbnail": "https://domain.com/carusel.png",
  "fileSize": 12000000,
  "duration": 30
}
(Դուք կարող եք նաև համատեղել Տեսանյութի հատկությունները՝ «buttonText»-ի և «buttonAction»-ի հետ):

5.2 Viber Transaction / Ծառայություն («viber_trans», «viber_service»)

Եթե ունեք հաստատված ձևանմուշ, որը պարունակում է կից ֆայլ՝ 

"messageData": {
  "fileUrl": "https://domain.com/receipt.pdf",
  "fileName": "Receipt.pdf",
  "fileType": "pdf"
}

Պահանջվում է «carousel.items» զանգված՝ «messageData»-ի ներսում:

Սահմանափակումներ. - Նյութերի երկարությունը՝ 2-ից 5 հատ - Վերնագիր՝ 2-ից 38 նիշ - «imageUrl»: JPEG/PNG առաջարկվող չափը 215x185

"messageData": {
  "carousel": {
    "items": [
      {
        "title": "50% Off Shoes!",
        "imageUrl": "https://domain.com/image1.png",
        "primaryButton": { "label": "Shop", "actionUrl": "..." },
        "secondaryButton": { "label": "Details", "actionUrl": "..." }
      }
    ]
  }
}

5.4 Viber Survey / Ցուցակ («viber_survey»)

Ստեղծում է ինտերակտիվ հարցում զրույցի տեսադաշտում: 

"messageData": {
  "survey": {
    "options": [
      "Excellent", "Good", "Normal", "Bad", "Terrible"
    ]
  }
}
Հաղորդագրության «տեքստ» հատկությունը գործում է որպես հարցման վերնագիր (առավելագույնը 85 նիշ): Դուք կարող եք փոխանցել 2-ից 5 տարբերակ՝ յուրաքանչյուրը առավելագույնը 50 նիշ:

5.5 Viber OTP («viber_otp»)

Ամբողջ աշխարհում օգտագործում է նախապես գրանցված տեղայնացված Viber ձևանմուշները: 

"messageData": {
  "templateId": "6c929cef-29b4-4349-bc9d-2a07bdbb6e43",
  "templateLang": "uk",
  "templateParams": {
    "pin": "3211",
    "business_platform_name": "SMSBAT",
    "code_validity_time": 7
  }
}
Կաղապարի պարամետրերը ('pin', 'business_platform_name') խիստ զգայուն են մեծատառերի նկատմամբ: API-ն աջակցում է ISO կոդերի լեզվի տարբեր տարբերակներ («EN», «ES», «RU», «TR», «UK» և այլն):

5.6 Flash Call («flashcall»)

Հավաքելու համարի վերջին թվանշանները (գեներացված կոդը) պետք է փոխանցվեն «տեքստ» պարամետրով: Եթե ​​«տեքստը» բաց է թողնվել, կոդը պատահական է, և դուք պետք է այն հանեք API-ի համաժամանակյա 200 OK արձագանքման մարմնից («հաղորդագրություններ/տեքստ»):

{
  "from": "FLASHCALL",
  "to": "380500000000",
  "type": "flashcall",
  "text": "340"
}