GMS API suderinamumas

SMSBAT palaiko suderinamumo sluoksnį su GMS API. Tai leidžia perkelti esamas GMS integracijas tiesiai į SMSBAT, nekeičiant pranešimų maršruto schemų, naudingos apkrovos struktūrų ar atgalinio skambučio klausytojų.

Ryšio nustatymai

Norėdami nukreipti užklausas per SMSBAT, integruodami atnaujinkite bazinį URL ir autentifikavimo kredencialus:

– Pagrindinis URL: „https://restapi.smsbat.com“. – Galinis taškas: „POST /api/GMSMessage/send_message“. – Užklausos formatas: „application/json“.

• Autentifikavimas: HTTP pagrindinis autentifikavimas (naudojami jūsų SMSBAT API kredencialai)

Prašyti parametrų

GMS suderinamumo API priima JSON objektą su šiais aukščiausio lygio parametrais:

Kanalo parinkčių nustatymai

Objekte „channel_options“ yra kanalui būdingų konfigūracijų.

=== “Viber” pranešimas

Naudojama, kai „viber“ yra „kanalų“ masyve.

| Parametras | Tipas | Reikalingas | Aprašymas |
| :--- | :--- | :--- | :--- |
| "tekstas" | styga | **Taip** | Pranešimo tekstas. |
| `ttl` | sveikasis skaičius | **Taip** | Laikas gyventi per kelias sekundes. |
| "img" | styga | Ne | Rodytino vaizdo viešas HTTPS URL. |
| "antraštė" | styga | Ne | Mygtuko teksto etiketė. |
| "veiksmas" | styga | Ne | Paskirties URL spustelėjus mygtuką. |
| `survey_options` | masyvas | Ne | Eilučių masyvas (nuo 2 iki 5 elementų), kad būtų rodomos kaip apklausos parinktys. |
| "carousel_items" | masyvas | Ne | Skaidrių objektų masyvas, skirtas rodyti kaip „Viber“ karuselė (žr. struktūrą skirtuke). |

**Viber užklausos pavyzdys:**
```json
{
  "phone_number": "380501234567",
  "tag": "MySender",
  "channels": ["viber"],
  "channel_options": {
    "viber": {
      "text": "Hello from SMSBAT!",
      "ttl": 60,
      "img": "https://www.example.com/image.png",
      "caption": "Open",
      "action": "https://www.example.com"
    }
  }
}
```

=== „Viber su SMS atsarginiu“

Įgalina „Viber“ pranešimų siuntimą su automatiniu SMS atsarginiu pranešimu, jei „Viber“ pristatymas nepavyksta TTL.

**Atsarginės užklausos pavyzdys:**
```json
{
  "phone_number": "380501234567",
  "tag": "MySender",
  "channels": ["viber", "sms"],
  "channel_options": {
    "viber": {
      "text": "Your order is ready!",
      "ttl": 60,
      "caption": "Details",
      "action": "https://www.example.com/order"
    },
    "sms": {
      "text": "Your order is ready: https://www.example.com/order",
      "alpha_name": "MySender",
      "ttl": 60,
      "ctr": false
    }
  }
}
```

{
  "phone_number": "380501234567",
  "tag": "MySender",
  "channels": ["sms"],
  "channel_options": {
    "sms": {
      "text": "Your verification code is 1234",
      "alpha_name": "MySender",
      "ttl": 60,
      "ctr": false
    }
  }
}

{
  "phone_number": "380501234567",
  "tag": "MySender",
  "channels": ["viber"],
  "channel_options": {
    "viber": {
      "text": "Please rate our service:",
      "ttl": 60,
      "survey_options": [
        "Excellent",
        "Good",
        "Bad"
      ]
    }
  }
}

=== „Viber karuselė“

Naudojamas braukiamoms vaizdo skaidrių kortelėms siųsti. Kiekviena skaidrė palaiko vaizdą, pavadinimą ir mygtukus.

**Karuselės užklausos pavyzdys:**
```json
{
  "phone_number": "380501234567",
  "tag": "MySender",
  "channels": ["viber"],
  "channel_options": {
    "viber": {
      "text": "Choose an offer",
      "ttl": 60,
      "carousel_items": [
        {
          "title": "Offer 1",
          "image_url": "https://www.example.com/offer-1.png",
          "primary_label": "Open",
          "primary_url": "https://www.example.com/offer-1",
          "secondary_label": "More",
          "secondary_url": "https://www.example.com/offers"
        },
        {
          "title": "Offer 2",
          "image_url": "https://www.example.com/offer-2.png",
          "primary_label": "Open",
          "primary_url": "https://www.example.com/offer-2"
        }
      ]
    }
  }
}
```

{
  "phone_number": "380501234567",
  "tag": "MySender",
  "channels": ["push"],
  "channel_options": {
    "push": {
      "title": "Order update",
      "text": "Your order is ready for pickup!",
      "ttl": 60,
      "img": "https://www.example.com/push.png",
      "caption": "Open",
      "action": "https://www.example.com/order",
      "ctr": false
    }
  }
}

Atsakymo formatas

Galutinis taškas pateikia atsakymus JSON formatu su būsenos kodu „HTTP 200 OK“.

Sėkmingas atsakymas

{
  "MessageId": "6f0d5e28-7f3a-4df3-91a2-3d58d9e09b9a",
  "ErrorCode": null,
  "ErrorText": null
}

Klaidų atsakymai

Jei patvirtinimas arba apdorojimas nepavyks, bus grąžintas klaidos atsakas su ne nuliu „ErrorCode“ ir išsamiu „ErrorText“.

{
  "MessageId": "00000000-0000-0000-0000-000000000000",
  "ErrorCode": 10221,
  "ErrorText": "This type of Message is not supported by the system"
}

{
  "MessageId": "00000000-0000-0000-0000-000000000000",
  "ErrorCode": 10221,
  "ErrorText": "There can be from 2 to 5 survey options."
}

{
  "MessageId": "00000000-0000-0000-0000-000000000000",
  "ErrorCode": 400,
  "ErrorText": "Cannot send to international number: alpha name 'ALPHA' is not registered."
}

{
  "MessageId": "00000000-0000-0000-0000-000000000000",
  "ErrorCode": 500,
  "ErrorText": "Internal server error."
}

Atšaukimo pristatymo formatas

Jei užklausoje buvo nurodytas „callback_url“, SMSBAT siunčia pristatymo būsenos naujinius kaip JSON POST naudingą apkrovą į jūsų galutinį tašką.

Atskambinimo užklausos pavyzdys

POST /your-callback-endpoint HTTP/1.1
Host: yoursystem.com
Content-Type: application/json

{
  "number": "380501234567",
  "time": 1719237600000,
  "status": 2,
  "substatus": 23,
  "hyber_status": 23033,
  "message_id": "6f0d5e28-7f3a-4df3-91a2-3d58d9e09b9a",
  "extra_id": "ORDER-12345",
  "sent_via": "viber",
  "matching_template_id": 0
}

Atšaukimo laukų aprašymas

Būsenos atvaizdai

1. Supaprastinta būsena (“status”)

2. Išsami būsena (“substatus”)

3. Kanalo tipas (sent_via)

4. Išsami SMSBAT būsena (“hyber_status”)