code.uoa.gr

API Reference της υπηρεσίας SMS Notifications

Endpoint: https://ws.gunet.gr/?service=sms&key=API_KEY

  1. send()
  2. send_by_uid()
  3. check_uid()

Method “send” — Αποστολή ειδοποίησης με παράμετρο αριθμό κινητού

Αυτή η method επιτρέπει αποστολή σε οποιονδήποτε αριθμό κινητού και είναι διαθέσιμη μόνο εάν το API key σας είναι εξουσιοδοτημένο.

Παράμετροι:

  • number: Αριθμός τηλεφώνου (μόνο ελληνικοί αριθμοί, 10 ψηφία)
  • message: Μήνυμα (UTF-8 string)
  • simulate: boolean (προαιρετικό, default τιμή: false)
  • log_id: string ή null (προαιρετικό, default τιμή: null)

Παράδειγμα

{
    "jsonrpc":"2.0",
    "method":"send",
    "params":
        {
            "number":"691111111",
            "message":"Hello World"
    },
    "id":1
}

{"result":null, "id":"1","jsonrpc":"2.0"}

Method “send_by_uid” — Αποστολή ειδοποίησης με παράμετρο το username

Παράμετροι:

  • uid: Όνομα χρήστη
  • message: Μήνυμα (UTF-8 string)
  • institution: Ίδρυμα (π.χ. uoa, ntua) *
  • simulate: boolean (προαιρετικό, default τιμή: false)
  • log_id: string ή null (προαιρετικό, default τιμή: null)

Το institution είναι προαιρετικό: εάν το API key είναι συνδεδεμένο με ένα συγκεκριμένο ίδρυμα, η αναζήτηση θα γίνεται πάντοτε σε αυτό το ίδρυμα.

Το simulate είναι προαιρετικό: εάν τεθεί true, τότε θα γίνει μεν ο έλεγχος για username και ύπαρξη αριθμού κινητού, αλλά το μήνυμα δε θα αποσταλλεί. Χρήσιμο για development ή δοκιμές χωρίς να πραγματοποιείται έλεγχος quotas ή billing.

Το log_id είναι προαιρετικό. Προορίζεται μόνο εάν η υπηρεσία σας δέχεται εισερχόμενα SMS από την αντίστοιχη (μελλοντική) υπηρεσία της GUnet. Σε αυτό το argument μπορείτε να θέσετε το id του μηνύματος που λήφθηκε, όπως αυτό ήρθε από την υπηρεσία εισερχόμενων μηνυμάτων. Σε αυτήν την περίπτωση δημιουργείται ένας συσχετισμός με το μήνυμα-απάντηση που στέλνετε, καθαρά για διαχειριστικούς λόγους.

Παράδειγμα

{
    "jsonrpc":"2.0",
    "method":"send_by_uid",
    "params":
        {
            "uid":"nipapado",
            "message":"Hello World"
    },
    "id":1
}

{"result":null, "id":"1","jsonrpc":"2.0"}

Method “check_uid” — Έλεγχος αν ένας χρήστης μπορεί να λάβει SMS

Ελέγχει αν ένα όνομα χρήστη είναι έγκυρο, και ταυτόχρονα ο χρήστης μπορεί να λάβει SMS (π.χ. έχει δηλώσει το κινητό του).

Παράμετροι:

  • uid: Όνομα χρήστη
  • institution: Ίδρυμα (π.χ. uoa, ntua) *

* προαιρετικό: εάν το API key είναι συνδεδεμένο με ένα συγκεκριμένο ίδρυμα, η αναζήτηση θα γίνεται πάντοτε σε αυτό το ίδρυμα.


Αποτελέσματα των Παραπάνω Κλήσεων (Responses)

  • Στις κλήσεις των send send_by_uid: Εάν το μήνυμα στάλθηκε επιτυχώς, ένα standard JSON-RPC Response με κενό (null) message.
    Παράδειγμα:
    {"result":null, "id":"1","jsonrpc":"2.0"}

  • Στην κλήση της check_uid: Εάν ο χρήστης υπάρχει και μπορεί να λάβει sms, boolean true.
    Παράδειγμα:
    {"result":true, "id":"1","jsonrpc":"2.0"}

  • Εάν υπήρχε κάποιο σφάλμα ή αποτυχία, ένα standard JSON-RPC Response που περιέχει JSON-RPC Error Object.
    Οι κωδικοί λαθών μπορεί να είναι:
    • -32602: Άκυρη παράμετρος (δείτε το μήνυμα για περισσότερες πληροφορίες)
    • -32000: Γενικό λάθος (δείτε το μήνυμα για περισσότερες πληροφορίες)
    • -32001: Λάθος username χρήστη
    • -32002: Το username είναι μεν έγκυρο, αλλά δεν υπάρχει καταχωρημένος αριθμός κινητού για αυτόν τον χρήστη
    • -32003: Έχετε υπερβεί κάποιο όριο χρήσης της υπηρεσίας (quota). (Δείτε το μήνυμα για περισσότερες πληροφορίες)

    Παράδειγμα:
    {"error":
    {"code":-32602,
     "message":"Invalid Mobile number; must be 10 digits",
     "data":{}
    },
 "id":"1","jsonrpc":"2.0"}