Documentație API SMSSphere 2.1 (5.11.2018)

Lista de cereri suportate de serviciul de date API SMSSphere 2.1 este redată în continuare. Aceasta conține intrări (cereri HTTP) care pot fi utilizate de programatori pentru dezvoltarea de aplicații care folosesc serviciile SMSSphere. Conectarea la interfața API se face prin cheia unică appkey care poate fi furnizată la cerere dezvoltatorilor. Această cheie este obligatorie și trebuie transmisă prin header-ul HTTP împreună cu celelalte date ale cererii.

Trimiterea de mesaje - https://api.smssphere.com/v2.1/webapp/sms
Trimiterea de mesaje se face cu cererea HTTP/1.1 sau 2.0:
POST https://api.smssphere.com/v2.1/webapp/sms
------------------------------------------------------------

HEADERS
appkey: CHAR(32)
    Cheia de autentificare la API. String unic de identificare al clientului care acceseaza API.
    Ex: "7ffc8e7b19372b9a3b6c68a3bb0c59ad"
------------------------------------------------------------
BODY (continutul variabilelor este notat intre ghilimele in mod exemplificativ). Parametri marcati cu * sunt obligatorii
------------------------------------------------------------
* msg: TEXT
    Continut mesaj. Text care poate contine caractere utf8 (discritice, etc)

* des: TEXT
    Numar destinatar (daca sunt mai multe, separate prin ";", fara spatii intre numere)
Exemplu: "0712345677;0712345678" 

- typ: VARCHAR(20)
    Tip mesaj (notificare, informare, avertizare, etc))

- origin: VARCHAR(50)
    Sursa trimiterii mesajului (originea)
    Ex: "MyApp"
- deviceid: VARCHAR(16)
    Id-ul de dispozitiv prin care se va trimite (ramane gol daca nu conteaza; in acest caz un dispozitiv din lista de dispozitive va prelua mesajul)
    Ex: "114296c90638968b"

- nam: TEXT
    Nota: Numele destinatarului (in eventualitatea adaugarii in agenda)
    Ex: "Popescu Ion"

------------------------------------------------------------
Exemplu folosing extensia CURL:

curl --request POST \
  --url http://api.smssphere.com/v2.1/webapp/sms \
  --header 'appkey: 7ffc8e7b19372b9a3b6c68a3bb0c59ad' \
  --data 'msg=Test%20message%20content&typ=Informare&des=0712345677%3B0712345678&origin=postman&deviceid=114296c90638968b&nam=Popescu%20Ion'
Preluarea mesajelor in asteptare - https://api.smssphere.com/v2.1/webapp/sms/pending(/:params+)+
Preluarea de mesaje in asteptare (PENDING messages) HTTP/1.1 sau 2.0:
GET https://api.smssphere.com/v2.1/webapp/sms/pending(/:params+)+
------------------------------------------------------------

HEADERS
appkey: CHAR(32)
    Cheia de autentificare la API. String unic de identificare al clientului care acceseaza API.
    Ex: "7ffc8e7b19372b9a3b6c68a3bb0c59ad"

LINK:
    Parametri din link sunt cei care determina eventuale filtrari sau limitari. Acestia se trimit in perechi de tip NUME / VALOARE
    Lista de parametri acceptati este:
-   [/limit/{NUMERIC}]
        Limiteaza numarul de rezultate la numarul dat (daca nu se trimite)
-   [/offset/{NUMERIC}]
        Porneste selectia de la pozitia data
-   [/{COLUMN_NAME}_t/{SEARCH_TYPE}/{COLUMN_NAME}_v/{COLUMN_VALUE}
    unde 
        {COLUMN_NAME}_t - numele coloanei din 3 caractere concatenat cu "_t" (t=type)
        {SEARCH_TYPE} - tipul de cautare (poate lua una dintre valorile descrise mai jos):
        {COLUMN_NAME}_v - numele coloanei din 3 caractere concatenat cu "_v" (v=value)
        {COLUMN_VALUE} - valoarea de filtrat (string urlencodat)

Exemplu 1:
    https://api.smssphere.com/v2.1/webapp/sms/pending/ali_t/b/ali_v/Lenovo/limit/10/offset/0

In acest link se trimit urmatoarele grupuri:
/ali_t/b
    filtrul cu numele "ali" este de tip "b", adica "begin with" (incepe cu)
/ali_v/Lenovo
    filtrul cu numele "ali" primeste valoarea "Lenovo". Impreuna cu perechea anterioara se formeaza
    un filtru care se traduce astfel: filtrul "ali" (prescurtare pentru "alias dispozitiv", sa inceapa cu "Lenovo")
/limit/10
    limita de 10 rezultate
/offset/0
    preia rezultate incepand cu pozitia 0 (de la inceput)

Numele de filtre pot fi:
    'idm' => id de mesaj,
    'usk' => cheie de utilizator,
    'ali' => alias de dispozitiv,
    'did' => ID de dispozitiv,
    'des' => destinatar mesaj,
    'con' => continut mesaj,
    'sen' => status receptie app android,
    'stt' => timp modificare status receptie app android,
    'del' => status trimitere in retea GSM,
    'det' => timp modificare status trimitere in retea GSM,
    'tin' => timp adaugare mesaj in DB,
    'mst' => tip mesaj,
    'org' => origine,
    'chk' => data verificarii/consultarii de APK,
    'lkt' => timp blocare de catre APK,
    'ins' => timp inserare mesaj, forma scurta,
    'tin' => timp inserare mesaj,
    'upd' => timp actualizare mesaj,
    'tup' => timp actualizare mesaj, forma scurta,
    'nam' => nume destinatar,
    'cam' => nume campanie,
    'sea' => data trimitere dupa,
    'seb' => data trimitere inainte de

------------------------------------------------------------
BODY (continutul variabilelor este notat intre ghilimele in mod exemplificativ). Parametri marcati cu * sunt obligatorii

------------------------------------------------------------ ------------------------------------------------------------
Exemplu folosing extensia CURL: 

curl -X GET \
  https://api.smssphere.com/v2.1/webapp/sms/pending/ali_t/b/ali_v/Lenovo \
  -H 'Postman-Token: 77f2b1e2-9215-4e26-b9c9-dc230676179f' \
  -H 'appkey: 7ffc8e7b19372b9a3b6c68a3bb0c59ad' \
  -H 'cache-control: no-cache'