HTTP CSV API

SMS Gateway HTTP CSV rozhraní je určeno pro hromadné posílání/příjem zpráv do/z SMS brány.

Import

Import zpráv se provadí:

  • z webového prostředí
  • z libovolného programu odeslaním csv souboru na definovanou adresu

CSV soubor

CSV soubor může být vytvořen např. v excelu uložením do .csv formátu (oddělovač je středník) se dvěma sloupci: číslo;text Text nesmí obsahovat dikritiku.

Příklad importního souboru:

123456798;text sms 1
456789123;text sms 2
789456123;text sms 3

Definované parametry:

  • Název hromadné SMS (bulk_sms_name) – Po odeslání lze podle názvu s hromadnou SMS manipulovat v historii zpráv.
  • Gateway (gw_number) – označení fronty
  • CSV soubor (file) – soubor s csv daty
  • Interval odesílání – období pro odesílání sms
    • čas od (time_from)
    • čas do (time_to)
    • datum (send_date) (pokud nebude vyplněn, bude odesílání pokračovat další den)

Návratové kódy:

Při odesílání přímo server vrací dvě hodnoty oddělené novým řádkem:

  • code=SUCCESS/ERROR
  • description=popis chyby

Záznam komunikace:

POST /bulk-sms HTTP/1.1
Authorization: Basic aBcDeFgHiJ
Host: smsgw.lbox.cz
Content-Length: 840
Content-Type: multipart/form-data; boundary=---------------------------43308707919288613141300718809

070982de88281cc4005981dd319fe3ce
-----------------------------43308707919288613141300718809
Content-Disposition: form-data; name="name"

import 120228
-----------------------------43308707919288613141300718809
Content-Disposition: form-data; name="gw_number"

3
-----------------------------43308707919288613141300718809
Content-Disposition: form-data; name="time_from"

8:00
-----------------------------43308707919288613141300718809
Content-Disposition: form-data; name="time_to"

19:59
-----------------------------43308707919288613141300718809
Content-Disposition: form-data; name="send_date"

29.2.2012
-----------------------------43308707919288613141300718809
Content-Disposition: form-data; name="file"; filename="sms_seznam.csv"
Content-Type: text/csv

123456798;specialni akce...
456789123;specialni akce...
789456123;specialni akce...

-----------------------------43308707919288613141300718809--

HTTP/1.1 200 OK

code=SUCCESS
description=