Kompatibilità GMS API

SMSBAT jappoġġja saff ta' kompatibilità mal-GMS API. Dan jippermettilek temigra l-integrazzjonijiet eżistenti tiegħek iddisinjati għall-GMS direttament għal SMSBAT mingħajr ma jkollok bżonn timmodifika l-iskemi tar-rotot tal-messaġġi tiegħek, l-istrutturi tat-tagħbija, jew is-semmiegħa ta' callback.

Settings tal-Konnessjoni

Biex tgħaddi t-talbiet permezz ta' SMSBAT, aġġorna l-URL bażi u l-kredenzjali ta' awtentikazzjoni fl-integrazzjoni tiegħek:

Bażi URL: https://restapi.smsbat.com
Endpoint: POST /api/GMSMessage/send_message
Format tat-Talba: applikazzjoni/json
Awtentikazzjoni: Awtentikazzjoni Bażika HTTP (tuża l-kredenzjali tal-API SMSBAT tiegħek)

Talba Parametri

L-API tal-kompatibilità tal-GMS taċċetta oġġett JSON bil-parametri tal-ogħla livell li ġejjin:

Parametru	Tip	Meħtieġa	Deskrizzjoni
`numru_telefon`	spag	Iva	Numru tat-telefon tar-riċevitur f'format internazzjonali (eż., `380501234567`).
"tikketta"	spag	Iva	Isem tal-mittent irreġistrat / isem alfa.
"kanali"	firxa	Iva	Lista ta' kanali li trid tipprova, f'ordni ta' prijorità. Valuri appoġġjati: "viber", "sms", "push". Eż., `["viber", "sms"]`.
`għażliet_kanali`	oġġett	Iva	Mappa li fiha għażliet għal kull kanal attiv (ara hawn taħt).
`extra_id`	spag	Le	L-ID tal-messaġġ intern tiegħek fuq in-naħa tal-klijent.
`callback_url`	spag	Le	URL tal-endpoint fis-sistema tiegħek biex tirċievi callbacks tal-istatus tal-kunsinna.
`kodiċi_diviżjoni`	spag	Le	Identifikatur tal-kodiċi tad-diviżjoni fakultattiv (defaults għal "prinċipali").

Settings tal-Għażliet tal-Kanal

L-oġġett channel_options fih konfigurazzjonijiet speċifiċi għall-kanal.

Messaġġ ViberViber b'SMS FallbackMessaġġ SMSStħarriġ ViberViber CarouselMessaġġ Imbotta

Użat meta "viber" huwa elenkat fil-firxa "kanali".

Parametru	Tip	Meħtieġa	Deskrizzjoni
"test"	spag	Iva	Test tal-korp tal-messaġġ.
`ttl`	numru sħiħ	Iva	Time-To-Live f'sekondi.
`img`	spag	Le	URL HTTPS pubbliku tal-immaġni li trid tintwera.
"titlu"	spag	Le	Tikketta tat-test tal-buttuna.
"azzjoni"	spag	Le	URL tad-destinazzjoni meta l-buttuna tiġi kklikkjata.
`għażliet_istħarriġ`	firxa	Le	Array ta 'kordi (2 sa 5 oġġetti) biex jintwerew bħala għażliet ta' stħarriġ.
`oġġetti_karużell`	firxa	Le	Array ta 'oġġetti slide biex jintwerew bħala karużell Viber (ara l-istruttura fit-tab).

Eżempju ta' Talba Viber:

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

Jippermetti messaġġi Viber b'riżerva awtomatika ta 'SMS jekk il-kunsinna Viber tfalli fit-TTL.

Eżempju ta' Talba ta' Fallback:

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

Użat meta "sms" huwa elenkat fil-firxa "kanali".

Parametru	Tip	Meħtieġa	Deskrizzjoni
"test"	spag	Iva	Test tal-korp tal-messaġġ.
`alpha_name`	spag	Iva	Isem alfa tal-mittent.
`ttl`	numru sħiħ	Iva	Time-To-Live f'sekondi.
`ctr`	boolean	Le	Ippermetti r-rintraċċar tal-ikklikkja CTR fuq links fit-test ('veru'/'falz').

Eżempju ta' Talba għall-SMS:

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

Użat biex jinħolqu stħarriġ u stħarriġ Viber.

Twissija

Il-konfigurazzjoni tal-istħarriġ Viber għandu jkollha bejn 2 u 5 għażliet ġewwa survey_options.

Eżempju ta' Talba għal Stħarriġ:

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

Użat biex tibgħat kards tal-islajds tal-immaġini swipeable. Kull slide tappoġġja immaġni, titolu, u buttuni.

Eżempju ta' Talba għal Carousel:

href="#__codelineno-4-1">{ "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" } ] } } }

Użat meta "push" huwa elenkat fil-firxa "kanali".

Parametru	Tip	Meħtieġa	Deskrizzjoni
"titolu"	spag	Iva	Test tat-titolu tan-notifika push.
"test"	spag	Iva	Test tal-korp tal-messaġġ.
`ttl`	numru sħiħ	Iva	Time-To-Live f'sekondi.
`img`	spag	Le	URL HTTPS pubbliku tal-immaġni li trid tintwera.
"titlu"	spag	Le	Tikketta tat-test tal-buttuna.
"azzjoni"	spag	Le	URL tad-destinazzjoni meta l-buttuna tiġi kklikkjata.
`ctr`	boolean	Le	Ippermetti l-intraċċar tal-ikklikkja.

Eżempju ta' Talba Imbotta:

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

Format ta’ Rispons

L-endpoint jirritorna tweġibiet f'format JSON b'kodiċi tal-istatus HTTP 200 OK.

Rispons b'suċċess

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

Risposti għal Żbalji

Jekk il-validazzjoni jew l-ipproċessar ifallu, rispons ta' żball b''ErrorCode' mhux null u 'ErrorText' se jintbagħat lura.

Kanal/Għażla mhux appoġġjatGħadd ta' Għażla ta' Stħarriġ InvalidaIsem Alfa Mhux ReġistratŻball Intern fl-Ipproċessar

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

Format ta' Kunsinna ta' Callback

Jekk callback_url ġiet speċifikata fit-talba, SMSBAT jibgħat aġġornamenti tal-istatus tal-kunsinna bħala payload JSON POST lill-endpoint tiegħek.

Eżempju ta’ Talba għal Callback

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
}

Oqsma ta' Callback Deskrizzjoni

Qasam	Tip	Deskrizzjoni
"numru"	spag	Numru tat-telefon tar-riċevitur.
"ħin"	numru	Timestamp tal-avveniment f'millisekondi Unix.
"status"	numru	Identifikatur tal-istatus simplifikat (ara t-tabella tal-kodiċi tal-istatus).
"substatus"	numru	Identifikatur tal-istatus dettaljat (ara t-tabella tal-kodiċi tas-Substatus).
`hyber_status`	numru	Kodiċi tal-istatus intern SMSBAT dettaljat (ara t-tabella tal-Istatus Hyber).
`message_id`	spag	ID tal-messaġġ SMSBAT (GUID) iġġenerat malli jintbagħat.
`extra_id`	spag	ID tan-naħa tal-klijent ipprovduta fit-talba oriġinali.
`mibgħuta_via`	spag	Kanal li pproċessa l-messaġġ: `viber`, `sms`, jew `rcs`.
`matching_template_id`	numru	Status ta' tqabbil tal-mudell Viber (fejn applikabbli).

Mappings tal-Istatus

1. Status Simplifikat ('status')

Kodiċi	Tifsira
"1"	Messaġġ aċċettat jew qed jitwassal.
"2"	Messaġġ imwassal.
"3"	Żball fl-ipproċessar jew fil-kunsinna.

2. Status Dettaljat ('substatus')

Kodiċi	Tifsira
"12"	Aċċettati għall-ipproċessar.
"23"	Mogħtija.
"24"	Jidher/aqra.
"35"	Mhux ikkunsinnat fi ħdan TTL (Skaduta).
"36"	Żball fil-kunsinna.

3. Tip ta' Kanal (`sent_via`)

Kanal	Deskrizzjoni
"viber"	Status prodott mill-kanal Viber.
`sms`	Status prodott mill-kanal SMS.
`rcs`	Status prodott mill-kanal RCS.

4. Status SMSBAT dettaljat (`hyber_status`)

Kodiċi	Kanal	Status	Substatus	Tifsira
23033	"viber"	"2"	"23"	Messaġġ Viber imwassal.
24013	"viber"	"2"	"24"	Messaġġ Viber moqri mir-riċevitur (Seen).
36013	"viber"	"3"	"36"	żball intern Viber.
36023	"viber"	"3"	"36"	ID tas-servizz Viber mhux validu jew mhux disponibbli.
36033	"viber"	"3"	"36"	Dejta mhux valida tat-tagħbija ta' Viber.
36037	"viber"	"3"	"36"	URL tal-immaġni Viber twil wisq.
36038	"viber"	"3"	"36"	URL tal-immaġni Viber mhux validu.
36039	"viber"	"3"	"36"	Test Viber twil wisq.
36044	"viber"	"3"	"36"	Test Viber vojt.
36053	"viber"	"3"	"36"	Tip ta' messaġġ Viber mhux appoġġjat.
36063	"viber"	"3"	"36"	Parametri Viber invalidi.
36073	"viber"	"3"	"36"	Timeout tal-fornitur Viber.
36083	"viber"	"3"	"36"	Mittenti Viber imblukkat mir-riċevitur.
36093	"viber"	"3"	"36"	Ir-riċevitur mhuwiex irreġistrat bħala utent Viber.
36103	"viber"	"3"	"36"	Ma nstab l-ebda apparat Android/iOS b'appoġġ Viber.
36113	"viber"	"3"	"36"	Indirizz IP mhux awtorizzat għal Viber jibgħat.
36123	"viber"	"3"	"36"	Instab messaġġ Viber duplikat.
36143	"viber"	"3"	"36"	Żball fil-kontijiet Viber.
36153	"viber"	"3"	"36"	Messaġġ imblukkat mil-lista sewda tal-pjattaforma.
36163	"viber"	"3"	"36"	Żball intern fl-ipproċessar tal-pjattaforma Viber.
36173	"viber"	"3"	"36"	Tikketta Viber ħażina jew nieqsa.
36183	"viber"	"3"	"36"	Valur TTL Viber invalidu.
12011	`sms` / `rcs`	"1"	"12"	SMS/RCS aċċettati.
36011	`sms` / `rcs`	"1"	"12"	SMS/RCS waqt ir-rotta.
23011	`sms` / `rcs`	"2"	"23"	SMS/RCS imwassla.
35015	`sms` / `rcs`	"3"	"35"	SMS/RCS skada (mhux ikkunsinnat fi ħdan TTL).
36021	`sms` / `rcs`	"3"	"36"	Messaġġ SMS/RCS imħassar.
36031	`sms` / `rcs`	"3"	"36"	SMS/RCS ma jistgħux jitwasslu.
36041	`sms` / `rcs`	"3"	"36"	Stat mhux magħruf tal-kunsinna SMS/RCS.
36051	`sms` / `rcs`	"3"	"36"	Messaġġ SMS/RCS miċħud.