Η αποστολή SMS μέσω HTTP API (JSON) είναι μια εναλλακτική - πιο ευέλικτη μέθοδος επικοινωνίας του site σας ή της εφαρμογής σας, με την πλατφόρμα του Liveall.eu.
Η χρήση αυτού του API είναι περίπου η ίδια όπως του βασικού HTTP API, με τη διαφορά ότι:
Για την αποστολή μέσω HTTP API, χρησιμοποιείτε το παρακάτω URL με POST requests:
https://sms.liveall.eu/apiext/Sendout/SendJSMS
Οι μεταβλητές που μπορείτε να χρησιμοποιήσετε είναι οι παρακάτω:
Μεταβλητή | Περιγραφή |
---|---|
apitoken | Ένα μοναδικό hash code που δημιουργείται αυτόματα για κάθε λογαριασμό και αποτελεί την ταυτότητά σας για κάθε request. Τον κωδικό αυτό μπορείτε να τον βρείτε στο λογαριασμό σας και στην web εφαρμογή. |
senderid | Όνομα αποστολέα. Μέγιστο πλάτος 11 λατινικούς χαρακτήρες. |
sendon [optional] |
(ΠΡΟΕΡΑΙΤΙΚΟ) - Χρονοπρογραμματισμός - Η μεταβλητή αυτή είναι τύπου unsigned integer και ορίζετε την ημερομηνία και ώρα που θέλετε να σταλεί το SMS. Η ώρα και ημερομηνία είναι τύπου unix timestamp και περισσότερα μπορείτε να βρείτε στο παρακάτω link: https://dev.mysql.com/doc/refman/5.5/en/date-and-time-functions.html#function_unix-timestamp Έτσι, πχ. αν θέλουμε να ορίσουμε σαν ημερομηνία αποστολής την 2016-07-06 12:17:45, η τιμή που θα δώσουμε είναι η: 1467796665 |
pricecat [optional] | Με αυτή τη μεταβλητή επιλέγετε μεταξύ κανονικής τιμολογιακής κατηγορίας - route και εναλλακτικών τιμ. κατηγοριών (πχ. low cost routing). Αν ορίσετε 0 ή δεν συμπεριλάβετε καθόλου αυτή την παράμετρο, το σύστημα θα στέλνει με την κανονική τιμή. Αν ορίσετε 1, το σύστημα θα στέλνει με την low cost τιμή. Οι προορισμοί που υποστηρίζουν low cost φαίνονται στον τιμοκατάλογο του site και στη σελίδα με τις πληροφορίες σχετικά με τις τιμολογιακές κατηγορίες. |
messages |
Αυτό είναι ένας πίνακας από objects, τα οποία έχουν τα παρακάτω properties:
|
Ενδεικτικά, ο παρακάτω κώδικας επεικονίζει ένα πιθανό payload σε JSON μορφή, ώστε να στείλουμε SMS σε 3 αριθμούς, με διαφορετικό κείμενο στον καθένα, με μία μόνο WEB κλήση.
{ "apitoken": "7ace3e49cae13ae4f5ccb8a6a8a0d6a8fe120aa82ae46ad6ee4c9d86357c5d52", "senderid": "mySender", "messages": [ { "destination": "306912345678", "message": "Test message A" }, { "destination": "306912345677", "message": "Test message B" }, { "destination": "306912345676", "message": "Test message C" } ] }
Σημειώστε πως η κλήση του web-service, πρέπει να γίνει με Content-Type: application/json
Σε περίπτωση σφάλματος, η μορφή του αποτελέσματος θα είναι κάτι σαν το παρακάτω:
{ "success": false, "OperationErrors": [ { "errorCode": 13, "errorMessage": "Invalid destination number", "SMSErrorType": 3, "valueOfError": "3069" } ], "SubmissionID": 0, "data": null }
Και σε περίπτωση επιτυχίας, το web-service θα σας επιστρέψει κάτι σαν το παρακάτω:
{ "success": true, "OperationErrors": null, "SubmissionID": 0, "data": [ { "destination": "306912345678", "smsid": 20818588 }, { "destination": "306912345677", "smsid": 20818589 }, { "destination": "306912345676", "smsid": 20818590 } ] }
Τα πεδία που πρέπει να ελέγχουμε τις τιμές αυτών είναι:
Τα υπόλοιπα properties που πιθανόν να σας επιστρέφονται, παρακαλώ αγνοήστε τα.
Για την αποστολή Viber message μέσω HTTP API, χρησιμοποιείτε το παρακάτω URL με POST requests:
https://sms.liveall.eu/apiext/Sendout/SendIM
Οι μεταβλητές που μπορείτε να χρησιμοποιήσετε είναι οι παρακάτω:
Μεταβλητή | Περιγραφή |
---|---|
apitoken - [string] | Ένα μοναδικό hash code που δημιουργείται αυτόματα για κάθε λογαριασμό και αποτελεί την ταυτότητά σας για κάθε request. Τον κωδικό αυτό μπορείτε να τον βρείτε στο λογαριασμό σας και στην web εφαρμογή. |
im_type - [string] | Ο τύπος του μηνύματος. Υπάρχουν 2 επιλογές: α) IM για αποστολή Viber μηνύματος και IM_SMSFB για αποστολή Viber μηνύματος, αλλά στην περίπτωση που ο τηλ. αριθμός δεν είναι και Viber αριθμός, το σύστημα θα στείλει SMS με αποστολέα και κείμενο που ορίζουμε στις παρακάτω μεταβλητές. |
im_sender_name - [string] | Το όνομα (sender name) του αποστολέα για το Viber - Προσοχή! Πρέπει να έχει ήδη εγκριθεί το sender name για το λογαριασμό σας. |
im_text - [string] | Το κείμενο του Viber μηνύματος. Το μέγιστο μήκος είναι 1000 χαρακτήρες. |
destinations - [array] | Ο πίνακας με τα τηλεφωνικά νούμερα που θέλουμε να παραδωθούν τα SMS ή Viber. |
im_image_urls - [array: optional] | Πίνακας με τα url από τις εικόνες που μπορεί να έχει το Viber μήνυμα. Για το Viber ΜΟΝΟ ΜΙΑ επιτρέπεται. |
im_actions - [array: optional] | Πίνακας με τα actions (κουμπί που σε οδηγεί σε κάποιο site), που μπορεί να περιέχει το Viber μήνυμα (Μόνο ένα action). Το κάθε object έχει 2 properties: i) caption: που είναι το caption από το κουμπί που θα εμφανίζεται και ii) url: που είναι το url που θα ανοίγει ο browser όταν ο παραλήπτης κάνει click στο κουμπί. |
senderid - [string: optional] | Όνομα αποστολέα για το SMS (αν έχετε δώσει την τιμή IM_SMSFB στη μεταβλητή im_type). Μέγιστο πλάτος 11 λατινικούς χαρακτήρες. |
pricecat - [integer: optional] | Με αυτή τη μεταβλητή επιλέγετε μεταξύ κανονικής τιμολογιακής κατηγορίας για το SMS - route και εναλλακτικών τιμ. κατηγοριών (πχ. low cost routing). Αν ορίσετε 0 ή δεν συμπεριλάβετε καθόλου αυτή την παράμετρο, το σύστημα θα στέλνει με την κανονική τιμή. Αν ορίσετε 1, το σύστημα θα στέλνει με την low cost τιμή. Οι προορισμοί που υποστηρίζουν low cost φαίνονται στον τιμοκατάλογο του site και στη σελίδα με τις πληροφορίες σχετικά με τις τιμολογιακές κατηγορίες. |
sms_text - [string: optional] | Το κείμενο του SMS (αν έχετε δώσει την τιμή IM_SMSFB στη μεταβλητή im_type). |
Ενδεικτικά, ο παρακάτω κώδικας επεικονίζει ένα πιθανό payload σε JSON μορφή, ώστε να στείλουμε Viber μήνυμα σε 2 αριθμούς, με μία μόνο WEB κλήση.
{ "apitoken": "a5c0210a8d0c336940761703c76ce73ea5130df5fb1d036737b9f2ddeb639d99", "im_type": "IM", "im_sender_name": "www.yoursite.com", "im_text": "001 - This is a test Viber msg", "im_image_urls": [ "https://www.liveall.eu/images/httpapi-json.png" ], "im_actions": [{ "caption": "Visit Us", "url": "https://www.liveall.eu/" }], "destinations": [ "306912345678", "306923456789" ] }
ή αν θέλουμε να στείλουμε Viber μήνυμα με Fallback σε SMS μπορούμε να στείλουμε web κλήση όπως παρακάτω:
{ "apitoken": "a5c0210a8d0c336940761703c76ce73ea5130df5fb1d036737b9f2ddeb639d99", "senderid": "Liveall.eu", "sms_text": "SMS text goes here!", "im_type": "IM_SMSFB", "im_sender_name": "www.yoursite.com", "im_text": "001 - This is a test Viber msg", "im_image_urls": [ "https://www.liveall.eu/images/httpapi-json.png" ], "im_actions": [{ "caption": "Visit Us", "url": "https://www.liveall.eu/" }], "destinations": [ "306912345678", "306923456789" ] }
Σημειώστε πως η κλήση του web-service, πρέπει να γίνει με Content-Type: application/json
Σε περίπτωση σφάλματος, η μορφή του αποτελέσματος θα είναι κάτι σαν το παρακάτω:
{ "success": false, "OperationErrors": [ { "errorCode": 56, "errorMessage": "Sender id for IM is not approved", "SMSErrorType": 4, "valueOfError": "" } ], "SubmissionID": 0, "data": null }
Και σε περίπτωση επιτυχίας, το web-service θα σας επιστρέψει κάτι σαν το παρακάτω:
{ "success": true, "OperationErrors": null, "SubmissionID": 0, "data": [ 11271180, 11271181 ] }
Τα πεδία που πρέπει να ελέγχουμε τις τιμές αυτών είναι:
Τα υπόλοιπα properties που πιθανόν να σας επιστρέφονται, παρακαλώ αγνοήστε τα.