Gms

Përputhshmëria e # GMS API

SMSBAT mbështet një shtresë përputhshmërie me GMS API. Kjo ju lejon të migroni integrimet tuaja ekzistuese të krijuara për GMS direkt në SMSBAT pa pasur nevojë të modifikoni skemat tuaja të rrugëtimit të mesazheve, strukturat e ngarkesës ose dëgjuesit e kthimit të thirrjeve.

Cilësimet e lidhjes

Për të drejtuar kërkesat përmes SMSBAT, përditësoni URL-në bazë dhe kredencialet e vërtetimit në integrimin tuaj:

URL bazë: https://restapi.smsbat.com
Pika e fundit: POST /api/GMSMessage/send_message
**Formati i kërkesës: ** application/json
Vërtetimi: Autentifikimi bazë HTTP (përdor kredencialet tuaja të SMSBAT API)

Parametrat e kërkesës

API i përputhshmërisë GMS pranon një objekt JSON me parametrat e mëposhtëm të nivelit të lartë:

Parametri	Lloji	Kërkohet	Përshkrimi
`numri_telefonit`	varg	Po	Numri i telefonit të marrësit në format ndërkombëtar (p.sh., `380501234567`).
`etiketë`	varg	Po	Emri i regjistruar i dërguesit / emri alfa.
`kanale`	grup	Po	Lista e kanaleve për të provuar, sipas renditjes së përparësisë. Vlerat e mbështetura: `viber`, `sms`, `push`. P.sh., `[“viber”, “sms”]”.
‘opsionet_kanali’	objekt	Po	Harta që përmban opsione për çdo kanal aktiv (shih më poshtë).
`ekstra_id`	varg	Jo	ID-ja juaj e brendshme e mesazhit nga ana e klientit.
”url_kthimi i thirrjes”	varg	Jo	URL-ja e pikës fundore në sistemin tuaj për të marrë kthime të statusit të dorëzimit.
”kodi_ndarje”	varg	Jo	Identifikuesi opsional i kodit të ndarjes (i parazgjedhur në “kryesor”).

Cilësimet e opsioneve të kanalit

Objekti options_channel përmban konfigurime specifike për kanalin.

Përdoret kur “viber” është i listuar në grupin e “kanaleve”.

Parametri	Lloji	Kërkohet	Përshkrimi
`tekst`	varg	Po	Teksti i trupit të mesazhit.
`ttl`	numër i plotë	Po	Koha për të jetuar në sekonda.
`img`	varg	Jo	URL-ja publike HTTPS e imazhit për t’u shfaqur.
‘titra’	varg	Jo	Etiketa e tekstit të butonit.
`veprim`	varg	Jo	URL-ja e destinacionit kur klikohet butoni.
`opsionet e_anketës`	grup	Jo	Një grup vargjesh (2 deri në 5 artikuj) për t’u shfaqur si opsione anketimi.
`artikuj_carousel`	grup	Jo	Gama e objekteve rrëshqitëse për t’u shfaqur si një karusel Viber (shih strukturën në skedën).

** Shembull i kërkesës 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"
    }
  }
}

Aktivizon mesazhet Viber me një kthim automatik SMS nëse dërgimi i Viber dështon brenda TTL.

** Shembull i kërkesës së kthimit:**

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

Përdoret kur “sms” është i listuar në grupin “kanalet”.

Parametri	Lloji	Kërkohet	Përshkrimi
`tekst`	varg	Po	Teksti i trupit të mesazhit.
`alfa_emri`	varg	Po	Emri alfa i dërguesit.
`ttl`	numër i plotë	Po	Koha për të jetuar në sekonda.
`ctr`	boolean	Jo	Aktivizo gjurmimin e klikimeve CTR në lidhjet në tekst (`true`/`false`).

** Shembull i kërkesës SMS:**

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

Përdoret për të krijuar sondazhe dhe sondazhe në Viber.

Warning

Konfigurimi i sondazhit të Viber duhet të ketë ndërmjet 2 dhe 5 opsione brenda “opsioneve_survey”.

Shembull i kërkesës për anketë:

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

Përdoret për të dërguar karta rrëshqitëse të imazhit. Çdo rrëshqitje mbështet imazhin, titullin dhe butonat.

** Shembull i kërkesës së karuselit:**

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

Përdoret kur “shtytja” është e listuar në grupin e “kanaleve”.

Parametri	Lloji	Kërkohet	Përshkrimi
”titulli”	varg	Po	Teksti i titullit të njoftimit shtytës.
`tekst`	varg	Po	Teksti i trupit të mesazhit.
`ttl`	numër i plotë	Po	Koha për të jetuar në sekonda.
`img`	varg	Jo	URL-ja publike HTTPS e imazhit për t’u shfaqur.
‘titra’	varg	Jo	Etiketa e tekstit të butonit.
`veprim`	varg	Jo	URL-ja e destinacionit kur klikohet butoni.
`ctr`	boolean	Jo	Aktivizo gjurmimin e klikimeve.

** Shembull i kërkesës për shtytje:**

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

Formati i përgjigjes

Pika përfundimtare kthen përgjigjet në format JSON me një kod statusi HTTP 200 OK.

Përgjigje e suksesshme

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

Përgjigjet e gabimit

Nëse vërtetimi ose përpunimi dështon, do të kthehet një përgjigje gabimi me një ‘ErrorCode’ jo null dhe ‘ErrorText’ të detajuar.

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

Formati i dorëzimit të kthimit të telefonatës

Nëse “callback_url” ishte specifikuar në kërkesë, SMSBAT dërgon përditësime të statusit të dorëzimit si ngarkesë JSON POST në pikën tuaj fundore.

Shembull i kërkesës për kthimin e thirrjes

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
}

Përshkrimi i fushave të kthimit të thirrjes

Fusha	Lloji	Përshkrimi
’numri’	varg	Numri i telefonit të marrësit.
`koha`	numri	Vula kohore e ngjarjes në Unix milisekonda.
”statusi”	numri	Identifikues i thjeshtuar i statusit (shih tabelën e kodit të statusit).
`nënstatus`	numri	Identifikuesi i detajuar i statusit (shih tabelën e kodit të nënstatusit).
“status_hiber”	numri	Kodi i detajuar i statusit të brendshëm SMSBAT (shih tabelën e statusit të Hyber).
`id_mesazhi`	varg	ID-ja e mesazhit SMSBAT (GUID) u krijua gjatë dërgimit.
`ekstra_id`	varg	ID-ja e klientit është dhënë në kërkesën origjinale.
`dërguar_përmes`	varg	Kanali që përpunoi mesazhin: `viber`, `sms` ose `rcs`.
`përputhja_template_id`	numri	Statusi i përputhjes së shabllonit Viber (aty ku është e aplikueshme).

Hartëzimi i statusit

1. Statusi i thjeshtuar (‘status’)

Kodi	Kuptimi
`1`	Mesazhi u pranua ose po dorëzohet.
`2`	Mesazhi u dorëzua.
`3`	Gabim gjatë përpunimit ose dërgimit.

2. Statusi i detajuar (`nënstatus`)

Kodi	Kuptimi
`12`	Pranohet për përpunim.
`23`	Dorëzuar.
`24`	Shikuar/lexuar.
`35`	Nuk dorëzohet brenda TTL (Skaduar).
`36`	Gabim në dorëzim.

3. Lloji i kanalit (`dërguar_përmes`)

Kanali	Përshkrimi
`viber`	Statusi i prodhuar nga kanali Viber.
`sms`	Statusi i prodhuar nga kanali SMS.
`rcs`	Statusi i prodhuar nga kanali RCS.

4. Statusi i detajuar i SMSBAT (‘status_hyber’)

Kodi	Kanali	Statusi	Nënstatusi	Kuptimi
23033	`viber`	`2`	`23`	Mesazhi në Viber u dërgua.
24013	`viber`	`2`	`24`	Mesazhi Viber i lexuar nga marrësi (shihet).
36013	`viber`	`3`	`36`	Gabim i brendshëm në Viber.
36023	`viber`	`3`	`36`	ID e pavlefshme ose e padisponueshme e shërbimit Viber.
36033	`viber`	`3`	`36`	Të dhëna të pavlefshme të ngarkesës në Viber.
36037	`viber`	`3`	`36`	URL-ja e imazhit të Viber është shumë e gjatë.
36038	`viber`	`3`	`36`	URL e pavlefshme e imazhit Viber.
36039	`viber`	`3`	`36`	Teksti në Viber është shumë i gjatë.
36044	`viber`	`3`	`36`	Teksti bosh në Viber.
36053	`viber`	`3`	`36`	Lloji i mesazhit Viber i pambështetur.
36063	`viber`	`3`	`36`	Parametrat e pavlefshëm të Viber.
36073	`viber`	`3`	`36`	Koha e fundit e ofruesit të Viber.
36083	`viber`	`3`	`36`	Dërguesi Viber është bllokuar nga marrësi.
36093	`viber`	`3`	`36`	Marrësi nuk është i regjistruar si përdorues i Viber.
36103	`viber`	`3`	`36`	Nuk u gjet asnjë pajisje Android/iOS me mbështetje Viber.
36113	`viber`	`3`	`36`	Adresa IP e paautorizuar për dërgimin e Viber.
36123	`viber`	`3`	`36`	U zbulua një mesazh i kopjuar në Viber.
36143	`viber`	`3`	`36`	Gabim faturimi në Viber.
36153	`viber`	`3`	`36`	Mesazhi u bllokua nga lista e zezë e platformës.
36163	`viber`	`3`	`36`	Gabim i brendshëm i përpunimit të platformës Viber.
36173	`viber`	`3`	`36`	Etiketa e gabuar ose mungon Viber.
36183	`viber`	`3`	`36`	Vlera e pavlefshme TTL e Viber.
12011	`sms` / `rcs`	`1`	`12`	SMS/RCS pranohet.
36011	`sms` / `rcs`	`1`	`12`	SMS/RCS në rrugë.
23011	`sms` / `rcs`	`2`	`23`	Dërguar SMS/RCS.
35015	`sms` / `rcs`	`3`	`35`	SMS/RCS ka skaduar (nuk është dorëzuar brenda TTL).
36021	`sms` / `rcs`	`3`	`36`	Mesazhi SMS/RCS u fshi.
36031	`sms` / `rcs`	`3`	`36`	SMS/RCS nuk mund të dërgohet.
36041	`sms` / `rcs`	`3`	`36`	Status i panjohur i dërgimit të SMS/RCS.
36051	`sms` / `rcs`	`3`	`36`	Mesazhi SMS/RCS u refuzua.

Search Results

Gms

Cilësimet e lidhjes

Parametrat e kërkesës

Cilësimet e opsioneve të kanalit

Formati i përgjigjes

Përgjigje e suksesshme

Përgjigjet e gabimit

Formati i dorëzimit të kthimit të telefonatës

Shembull i kërkesës për kthimin e thirrjes

Përshkrimi i fushave të kthimit të thirrjes

Hartëzimi i statusit

1. Statusi i thjeshtuar (‘status’)

2. Statusi i detajuar (nënstatus)

3. Lloji i kanalit (dërguar_përmes)

4. Statusi i detajuar i SMSBAT (‘status_hyber’)

2. Statusi i detajuar (`nënstatus`)

3. Lloji i kanalit (`dërguar_përmes`)