RESTful SMS API v.2 για επικοινωνία με το SMS Gateway
Στη σελίδα αυτή περιγράφονται οι διαθέσιμες λειτουργίες που παρέχονται για την επικοινωνία με το sms gateway.
To HTTP API σας επιτρέπει να προσθέσετε εύκολα στις εφαρμογές σας την δυνατότητα αποστολής SMS χρησιμοποιώντας το πρωτόκολλο HTTP.
Γενικά
Το πρόγραμμα κάνει μια HTTP GET κλήση στο SMSCenter.gr HTTP interface παρέχοντας την λίστα με τις απαραίτητες παραμέτρους. Το SMSCenter.gr απαντάει στην κλήση όπως περιγράφεται στη συνέχεια.
Σημειώστε οτι ο διαχωριστικός χαρακτήρας στα επιστρεφόμενα δεδομένα της κλήσης status είναι η κάθετος, '|', (ASCII 124).
Όλες οι παράμετροι θα πρέπει να είναι με κωδικοποίηση UTF-8 και URL-encoded, όπως περιγράφεται στα παραδείγματα κώδικα παρακάτω.
Απαντήσεις κλήσεων API
Το API απαντάει σε όλες τις κλήσεις ανάλογα με την τιμή της παραμέτρου type. Οι τιμές που δέχεται η παράμετρος type είναι: v2, json και xml.
Παραδείγματα απαντήσεων για την κλήση της εντολής key/get:
URL: https://static.smscenter.gr/api/key/get?username=[username]&password=[password]&type=...
...&type=v2
Επιστρέφει:
6fe2dd9c06df83
...&type=json
Επιστρέφει:
{
"status" : "1",
"key" : "6fe2dd9c06df83",
"remarks" : "Success"
}
...&type=xml
Επιστρέφει:
<response>
<status>1</status>
<key>6fe2dd9c06ff83</key>
<remarks>Success</remarks>
</response>
Δοκίμασέ το (key/get)
https://static.smscenter.gr/api/key/get?username=&password=&type=
Ακολουθεί περιγραφή των διαθέσιμων εντολών.
API Key
Το API Key αντικαθιστά τα username και password για όλες τις κλήσεις του API. Αν θέλετε μπορείτε να χρησιμοποιείτε τις παραμέτρους username και password αλλά συνιστούμε να χρησιμοποιείτε το API Key για λόγους ασφάλειας.
Το API Key το παίρνετε μια φορά με την εντολή key/get και το χρησιμοποιείτε για όλες σας τις κλήσεις αντί να δίνετε τις παραμέτρους username και password. Αν χρειαστεί να αλλάξετε το API Key, μπορείτε να το κάνετε με την εντολή key/reset.
Οι εντολές key/get και key/reset είναι οι μόνες που απαιτούν την χρήση username και password.
Μόλις πάρετε το API Key μπορείτε να το χρησιμοποιείτε για όλες τις άλλες κλήσεις του API.
Δοκίμασέ το (key/get)
https://static.smscenter.gr/api/key/get?username=&password=&type=
Δοκίμασέ το (key/reset)
https://static.smscenter.gr/api/key/reset?username=&password=&type=
Επιστρέφουν
...&type=v2
Επιστρέφει:
6fe2dd9c06df83
...&type=json
Επιστρέφει:
{
"status" : "1",
"key" : "6fe2dd9c06df83",
"remarks" : "Success"
}
...&type=xml
Επιστρέφει:
<response>
<status>1</status>
<key>6fe2dd9c06ff83</key>
<remarks>Success</remarks>
</response>
Αποστολή SMS
URL: https://static.smscenter.gr/api/sms/send?key=[API Key]
Παράμετροι
| Παράμετρος | Περιγραφή | Παρουσία |
|---|---|---|
text |
Κείμενο του μηνύματος. Πρέπει να είναι URL encoded | Υποχρεωτικό |
to |
Αριθμός κινητού τηλεφώνου του παραλήπτη του μηνύματος. Πχ: 306944777888 | Υποχρεωτικό |
from |
Αποστολέας του μηνύματος (για αλφαριθμητικούς μέχρι 11 χαρακτήρες, για αριθμητικούς μέχρι 16 ψηφία. Για αποστολή σε Ελληνικά δίκτυα επιτρέπονται μόνο οι αλφαριθμητικοί αποστολείς) | Προαιρετικό |
flash |
True για αποστολή Flash sms | Προαιρετικό |
ucs |
True για αποστολή του μηνύματος με κωδικοποίηση UCS | Προαιρετικό |
timestamp |
Η ώρα που θα γίνει η αποστολή σε μορφή Unix Epoch timestamp | Προαιρετικό |
type |
Τύπος της απάντησης του API, μπορεί να είναι v2, json ή xml |
Προαιρετικό |
Επιστρέφει
...&type=v2
Επιστρέφει:
1234567890
...&type=json
Επιστρέφει:
{
"status" : "1",
"id" : "1234567890",
"balance" : "1234",
"remarks" : "Success"
}
...&type=xml
Επιστρέφει:
<response>
<status>1</status>
<id>1234567890</id>
<balance>1234</balance>
<remarks>Success</remarks>
</response>
| Περιγραφή | |
|---|---|
status |
1 για επιτυχημένη αποστολή, διαφορετικά η αποστολή απέτυχε |
id |
Ο κωδικός του μηνύματος (ή 0 σε αποτυχία), οι αναφορές παράδοσης δίνονται με βάση αυτόν |
balance |
Το υπόλοιπο του λογαριασμού |
remarks |
Σχόλια για το αποτέλεσμα της κλήσης |
Δοκίμασέ το (sms/send)
https://static.smscenter.gr/api/sms/send?key=&to=&from=&text=Hello&type=