Comanda SMS/SEND

04 Septembrie 2022

Comanda "sms/send" se utilizează pentru a transmite un mesaj sms către un destinatar. Se poate utiliza pentru a implementa funcții click2sms din aplicații externe sistemului Accolades (de exemplu aplicații CRM).

După finalizarea procesului de transmisie a mesajului serverul Accolades poate notifica un server extern, printr-o cerere http, cu privire la statusul transmisiei (a fost trimis / a apărut o eroare).

Structură comanda

Pentru a se rula comanda trebuie realizată o cerere la adresa:

https://client.voipit.ro/<numarCont>/sms/send

Se vor transmite prin POST următorii parametrii:

password: parola asociată contului;
phoneNumber: numărul de telefon către care se va transmite mesajul (destinatarul).
message: mesajul care se va transmite destinatatului.
sendResultTo: (optional) un URL către care serverul Accolades va transmite o notificare cu statusul mesajului (trimis / eroare), după finalizarea procesului de transmisie.
messageId: (opțional) un id (text) care se va transmite în pachetul cu notificarea despre statusul mesajului.

Răspuns server

Dacă cererea este realizată corect, atunci serverul va răspunde cu un pachet JSON de forma:

{ "type" : "ok" }

Notificare status

Dacă parametrul "sendResultTo" este definit (și are o valoare) atunci, după finalizarea procesului de transmisie serverul Accolades va inițializa o cerere http(s) către serverul indicat, unde se vor transmite următorii parametrii:

apiName: ("sms") denumirea api-ului care a generat notificarea (se poate utiliza pentru a putea diferenția mesajele transmise de diversele sisteme API Accolades, în cazul în care acestea se proceseaza se acelasi script de pe serverul unui client);
type: ("deliveryReport") tipul pachetului transmis, relativ la acest api;
status: ("sent" sau "error") rezultatul procesului de transmisie: sent (mesajul a fost trimis) sau error (a aparut o eroare la transmisie);
id: (text) id-ul mesajului, asa cum a fost furnizat în cererea inițială (dacă cererea inițială nu a conținut un id, atunci parametrul va fi gol).
errorMessage: (text) (doar în cazul unei erori) descrierea erorii apărute, pentru cazul în care mesajul sms nu a putut fi transmis.