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

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

Ուղարկեք հաղորդագրություններ SMSBAT API-ի միջոցով՝ օգտագործելով «/bat/messagelist» վերջնակետը:

Վերջնակետ

POST /bat/messagelist

Հարցման կառուցվածքը

Հարցման մարմինը հաղորդագրության օբյեկտների JSON զանգված է.

{
  "messages": [
    {
      "from": "YourSender",
      "to": "+380XXXXXXXXX",
      "type": "sms",
      "text": "Your message text",
      "customerMessageId": "your-internal-id",
      "ttl": 3600
    }
  ]
}

Պարամետրեր

Պահանջվող պարամետրեր

Պարամետր Տեսակ Նկարագրություն
«ից» լարային Ալֆան-թվային ուղարկողի ID
«դեպի» լարային Ստացողի հեռախոսահամարը E.164 ձևաչափով (օրինակ՝ +380XXXXXXXXX)
«տեսակ» լարային Հաղորդագրության տեսակը՝ «sms», «viber_promo», «viber_trans», «viber_carousel», «viber_survey», «viber_otp», «rcs», «flashcall»
«տեքստ» լարային Հաղորդագրության բովանդակությունը (պահանջվում է շատ տեսակների համար, որոշների համար պարտադիր չէ)

կամընտիր պարամետրեր

Պարամետր Տեսակ Նկարագրություն
«customerMessageId» լարային Ձեր ներքին նույնացուցիչը հետևելու համար
«ttl» ամբողջ թիվ Ապրելու ժամանակը վայրկյաններով
«հաղորդագրությունների տվյալներ» օբյեկտ Տիպային կոնֆիգուրացիա (տարբերվում է ըստ հաղորդագրության տեսակի)

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

Ընտրեք նույնականացման երեք մեթոդներից մեկը.

=== «API բանալի վերնագիր»

```bash
curl -X POST https://restapi.smsbat.com/bat/messagelist \
  -H "X-Authorization-Key: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "messages": [{
      "from": "YourSender",
      "to": "+380XXXXXXXXX",
      "type": "sms",
      "text": "Hello from SMSBAT!"
    }]
  }'
```

=== «HTTP Հիմնական վավերացում»

```bash
curl -X POST https://restapi.smsbat.com/bat/messagelist \
  -u "username:password" \
  -H "Content-Type: application/json" \
  -d '{
    "messages": [{
      "from": "YourSender",
      "to": "+380XXXXXXXXX",
      "type": "sms",
      "text": "Hello from SMSBAT!"
    }]
  }'
```

=== «API բանալի որպես գաղտնաբառ»

```bash
curl -X POST https://restapi.smsbat.com/bat/messagelist \
  -u "@:your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "messages": [{
      "from": "YourSender",
      "to": "+380XXXXXXXXX",
      "type": "sms",
      "text": "Hello from SMSBAT!"
    }]
  }'
```

Պատասխան

Հաջողության պատասխան

{
  "messagelistId": 123456,
  "messages": [
    {
      "messageId": "abc123def456",
      "status": "accepted",
      "parts": 1,
      "customerMessageId": "your-internal-id",
      "to": "+380XXXXXXXXX"
    }
  ]
}

Արձագանքման դաշտեր

Դաշտային Տեսակ Նկարագրություն
«messagelistId» ամբողջ թիվ Հաղորդագրությունների ցանկի եզակի նույնացուցիչ
«messageId» լարային Եզակի նույնացուցիչ յուրաքանչյուր հաղորդագրության համար
«կարգավիճակ» լարային Հաղորդագրության կարգավիճակը՝ «ընդունված», «մերժված», «ձախողված»
«մասեր» ամբողջ թիվ Հաղորդագրության մասերի քանակը (SMS-ի համար)
«customerMessageId» լարային Ձեր ներքին նույնացուցիչը (եթե տրված է)
«դեպի» լարային Ստացողի հեռախոսահամարը

Հաղորդագրությունների տեսակները

SMS

Պարզ տեքստային հաղորդագրություններ.

{
  "from": "YourSender",
  "to": "+380XXXXXXXXX",
  "type": "sms",
  "text": "Your SMS message text"
}

Viber Promo

Գովազդային հաղորդագրություններ հարուստ լրատվամիջոցներով.

{
  "from": "YourSender",
  "to": "+380XXXXXXXXX",
  "type": "viber_promo",
  "text": "Check out our new product!",
  "messageData": {
    "image": "https://example.com/image.jpg",
    "button": {
      "text": "View Product",
      "url": "https://example.com/product"
    }
  }
}

Viber գործարք

Գործարքների մասին ծանուցումներ.

{
  "from": "YourSender",
  "to": "+380XXXXXXXXX",
  "type": "viber_trans",
  "text": "Your order #12345 has been confirmed"
}

Viber OTP

Միանգամյա գաղտնաբառի ծանուցումներ.

{
  "from": "YourSender",
  "to": "+380XXXXXXXXX",
  "type": "viber_otp",
  "messageData": {
    "code": "123456",
    "validity": 300
  }
}

Սխալների մշակում

HTTP կարգավիճակի կոդերը

Կոդ Նկարագրություն
200 Հայցը հաջողված է
400 Սխալ հարցում - անվավեր պարամետրեր
401 Չլիազորված - նույնականացումը ձախողվեց
429 Չափազանց շատ հարցումներ. տոկոսադրույքի սահմանաչափը գերազանցվել է
500 Ներքին սերվերի սխալ

Սխալի պատասխան

{
  "error": {
    "code": "INVALID_RECIPIENT",
    "message": "Invalid phone number format"
  }
}

Լավագույն պրակտիկա

Հեռախոսահամարի ձևաչափ

Հեռախոսահամարների համար միշտ օգտագործեք E.164 ձևաչափը.

  • ✅ Ճիշտ է՝ «+380XXXXXXXXX»:
  • ❌ Սխալ է՝ «380XXXXXXXXX», «0XXXXXXXXX»:

Հաղորդագրության տեքստ

  • Պահպանեք SMS 160 նիշից ցածր՝ բազմաթիվ մասերից խուսափելու համար
  • Օգտագործեք UTF-8 կոդավորումը միջազգային նիշերի համար
  • Փորձարկեք հատուկ նիշերը զանգվածային ուղարկելուց առաջ

TTL (Ապրելու ժամանակը)

  • Սահմանեք համապատասխան TTL ժամանակի զգայուն հաղորդագրությունների համար
  • OTP հաղորդագրություններ՝ 300-600 վայրկյան (5-10 րոպե)
  • Գովազդային հաղորդագրություններ՝ 3600-86400 վայրկյան (1-24 ժամ)

Հաճախորդի հաղորդագրության ID

  • Յուրաքանչյուր հաղորդագրության համար օգտագործեք եզակի նույնացուցիչներ
  • Օգնում է հետևել և կարգաբերել
  • Օգտակար է ձեր համակարգի գրառումների հետ փոխկապակցելու համար

Գնահատման սահմանափակումներ

Կապվեք ձեր հաշվի կառավարչի հետ՝

  • Հաղորդագրություններ մեկ վայրկյանում
  • Օրական հաղորդագրություններ
  • Միաժամանակյա կապեր

Հաջորդ քայլերը