Trimiterea unui SMS
Pentru trimiterea de mesaje, se va utiliza aceasta cerere care primește ca parametri informații despre SMS-ul de trimis. Raspunsul contine informatii despre operațiunea de trimitere a SMS-ului impreuna cu confirmarea de salvare sau mesaje de avertizare privind date incorecte sau incomplete.
API Request
Nume | Locatie | Tip date | Descriere |
---|---|---|---|
appkey | HEAD | CHAR(32) | Cheia de autentificare la API. String unic de identificare al clientului care acceseaza API. Ex: „7ffc8e7b19372b9a3b6c68a3bb0c59ad” |
msg | BODY | TEXT | Continut mesaj. Text care poate contine caractere utf8 (discritice, etc) |
des | BODY | TEXT | Numar destinatar (daca sunt mai multe, separate prin „;”, fara spatii intre numere) Exemplu: „0712345677;0712345678” |
typ | BODY | VARCHAR(20) | Tip mesaj (notificare, informare, avertizare, etc)) |
origin | BODY | VARCHAR(50) | Sursa trimiterii mesajului (originea). Ex: „MyApp” |
deviceid | BODY | 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 | BODY | TEXT | Nota: Numele destinatarului (in eventualitatea adaugarii in agenda). Ex: „Popescu Ion” |
sendAfter | BODY | DATETIME | Nota: Data de la care se poate incepe trimiterea mesajului (mesaj programat dupa data…) |
sendBefore | BODY | DATETIME | Nota: Data până la care se poate trimite mesajul (mesaj programat până la data…) |
Exemple (cod-sursă)
cURL
curl -X POST \ http://api.smssphere.com/v2.1/webapp/sms \ -H 'Content-Type: application/x-www-form-urlencoded' \ -H 'Postman-Token: cb0fba56-7816-4604-8c90-43d21d03e2c6' \ -H 'cache-control: no-cache' \ -H 'userKey: vqp3zg5wxrmjndnv' \ -d 'msg=Mesaj%20de%20%20bun%20venit%20la%20aplicatia%20SMSSphere!
&typ=Notificare&des=0700111222&origin=postman&deviceid=6e6a5bf083d15c81
&nam=Popescu%20Ion&undefined='
PHP
<?php $curl = curl_init(); curl_setopt_array($curl, array( CURLOPT_URL => "http://api.smssphere.com/v2.1/webapp/sms", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "POST", CURLOPT_POSTFIELDS => "msg=Mesaj%20de%20%20bun%20venit%20la%20aplicatia%20SMSSphere!
&typ=Notificare&des=0700111222&origin=postman&deviceid=6e6a5bf083d15c81
&nam=Popescu%20Ion&undefined=", CURLOPT_HTTPHEADER => array( "Content-Type: application/x-www-form-urlencoded", "Postman-Token: 888dd0c8-9723-449e-a1ca-d089901a61e6", "cache-control: no-cache", "userKey: vqp3zg5wxrmjndnv" ), )); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; }
Python
import requests url = "http://api.smssphere.com/v2.1/webapp/sms" payload = "msg=Mesaj%20de%20%20bun%20venit%20la%20aplicatia%20SMSSphere!
&typ=Notificare&des=0700111222&origin=postman&deviceid=6e6a5bf083d15c81
&nam=Popescu%20Ion&undefined=" headers = { 'userKey': "vqp3zg5wxrmjndnv", 'Content-Type': "application/x-www-form-urlencoded", 'cache-control': "no-cache", 'Postman-Token': "ce818659-baa4-48b8-9be2-64b5977da779" } response = requests.request("POST", url, data=payload, headers=headers) print(response.text)
Răspuns JSON - succes
{ "code": 0, "msg": "Mesaj gata de livrare", "exceptionCode": 0, "dataInfo": { "count": 1 }, "data": [ [ { "cod": "e79abb35653bf98b89f622ce33fcbdb3", "con": "Mesaj de bun venit la aplicatia SMSSphere! Trimis prin http://smssphere.com", "des": "0700111222" } ] ] }
Exemplu JSON - eroare
{ "code": -1, "exceptionCode": 10488, "msg": "Accesul la aplicație este suspendat. Probabil contul dvs nu este activ sau a fost șters [#10488]", "data": [] }
Selecția de mesaje (căutare) – noi si istoric
Aceastră intrare API vă permite să selectați mesaje din baza de date în baza unor filtre de căutare. Parametri de căutare includ variabile pentru filtrare asociate cu valori corespunzătoare, posibilitatea includerii tipului de căutare pentru fiecare filtru în parte, precum și limitarea rezultatelor
API Request
Pentru mesaje in asteptare (inca netrimise in reteaua GSM)
GET https://api.smssphere.com/v2.1/webapp/sms/pending(/:params+)+
Pentru istoricul de mesaje (preluate și analizate de aplicație)
GET https://api.smssphere.com/v2.1/webapp/sms/history(/:params+)+
Nume | Locatie | Tip date | Descriere |
---|---|---|---|
appkey | HEAD | CHAR(32) | Cheia de autentificare la API. String unic de identificare al clientului care acceseaza API. Ex: „7ffc8e7b19372b9a3b6c68a3bb0c59ad” |
/limit/{value} | GET | NUMERIC | Limiteaza numarul de rezultate la numarul dat (daca nu se trimite) |
/offset/{value} | GET | NUMERIC | Porneste selectia de la pozitia data |
[ /{COL_NAM}_t /{SRC_TYP} /{COL_NAM}_v /{COL_VAL} ] |
GET | TEXT |
grup de parametri (pot fi folositi in grup de cate 4 variabile dupa cum urmeaza): {COL_NAM}_t – numele coloanei din 3 caractere concatenat cu „_t” (t=type) |
origin | BODY | VARCHAR(50) | Sursa trimiterii mesajului (originea). Ex: „MyApp” |
deviceid | BODY | 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 | BODY | TEXT | Nota: Numele destinatarului (in eventualitatea adaugarii in agenda). Ex: „Popescu Ion” |
Exemplu:
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
Exemple (cod-sursă)
cURL
curl -X GET \
https://api.smssphere.com/v2.1/webapp/sms/pending/con_t/b/con_v/mesaj/limit/25/offset/0 \
-H 'Postman-Token: bcf29dbe-4001-4f6c-be4f-3d2a6f156660' \
-H 'cache-control: no-cache' \
-H 'userKey: 2p47d2q9sx5j7wph'
PHP
<?php $curl = curl_init(); curl_setopt_array($curl, array( CURLOPT_URL => "https://api.smssphere.com/v2.1/webapp/sms/pending/con_t/b/con_v/mesaj/limit/25/offset/0", CURLOPT_RETURNTRANSFER => true, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_POSTFIELDS => "", CURLOPT_HTTPHEADER => array( "Postman-Token: 8d2abe7b-c0cc-4dec-b229-e9a4afb05aa0", "cache-control: no-cache", "userKey: 2p47d2q9sx5j7wph" ), )); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; }
Python
import requests url = "https://api.smssphere.com/v2.1/webapp/sms/pending/con_t/b/con_v/mesaj/limit/25/offset/0" payload = "" headers = { 'userKey': "2p47d2q9sx5j7wph", 'cache-control': "no-cache", 'Postman-Token': "9b2126ba-f91f-48eb-8e05-5c64ce75bb54" } response = requests.request("GET", url, data=payload, headers=headers) print(response.text)
Răspuns JSON - succes
{
"code": 0,
"msg": "Înregistrări returnate: 1",
"exceptionCode": 0,
"dataInfo": {
"count": "1",
"limit": "25",
"offset": "0",
"filters": {
"con": [
"con",
"b",
"mesaj"
]
}
},
"data": [
{
"idm": "201",
"usk": "2p47d2q9sx5j7wph",
"ali": "",
"did": "",
"des": "0700111222",
"con": "Mesaj de bun venit la aplicatia SMSSphere! Trimis prin http://smssphere.com",
"sen": "WAIT",
"stt": "2019-03-15 12:39",
"del": "NOT_SENT",
"det": "2019-03-15 12:39",
"tin": "2019-03-15 12:39:17.525",
"mst": "Notificare",
"org": "webapp",
"chk": "2019-03-15 12:39",
"lkt": "",
"ins": "2019-03-15 12:39",
"upd": "2019-03-15 12:39",
"tup": "2019-03-15 12:39:17.525",
"nam": "0700111222",
"cam": "",
"sea": "2019-03-15 12:39:17",
"seb": "2019-04-14 12:39:17"
}
] }
Exemplu JSON - eroare
{ "code": -1, "exceptionCode": 10488, "msg": "Accesul la aplicație este suspendat. Probabil contul dvs nu este activ sau a fost șters [#10488]", "data": [] }