Τεκμηρίωση REST API
Κάντε το πρώτο σας αίτημα API στο MultiTEL
Ξεκινήστε με ένα αίτημα μόνο ανάγνωσης, κατανοήστε την απόκριση και έπειτα επιλέξτε την αναφορά για την υπηρεσία που θέλετε να αναπτύξετε.
Επιλέξτε το API και το διαπιστευτήριο μαζί
Οι εγκεκριμένοι λογαριασμοί για Προγραμματιστές & Αυτοματισμό, Επιχειρήσεις και Παρόχους επικοινωνιών μπορούν να ενσωματώσουν ενεργοποιημένες υπηρεσίες. Ένας μεμονωμένος προγραμματιστής δεν χρειάζεται να προσποιείται ότι είναι εταιρεία. Τα SMS/MMS εφαρμογών απαιτούν την αντίστοιχη έγκριση αποστολής και εγγραφή. Η υπηρεσία για Ιδιώτες & οικογένειες δεν παρέχει API έναρξης αποστολής μηνυμάτων προσβάσιμο στους πελάτες.
| Οικογένεια API | Βασική διεύθυνση URL | Έλεγχος ταυτότητας και αποτέλεσμα |
|---|---|---|
| Επικοινωνίες v3 | https://api.multitel.net/v3 | Εγκεκριμένα διαπιστευτήρια Basic· μόνο επιλέξιμα παρεχόμενα διακριτικά για λειτουργίες που τα υποστηρίζουν. JSON status και response. |
| Καταχώριση έκτακτης ανάγκης | https://api.multi.tel/emergency | Εγκεκριμένα διαπιστευτήρια Basic ή ειδικά παρεχόμενη πρόσβαση bearer. JSON code, message και data. |
| Ενοποιήσεις REST της πύλης | Ο κεντρικός υπολογιστής και η λειτουργία εμφανίζονται στην αναφορά προγραμματιστή του λογαριασμού σας | Χρησιμοποιήστε το τεκμηριωμένο διαπιστευτήριο, τα πεδία εφαρμογής και το σχήμα αυτής της λειτουργίας. Τα αιτήματα συνεδρίας προγράμματος περιήγησης αποτελούν ξεχωριστή επιφάνεια. |
Ορίστε τα MULTITEL_API_USERNAME και MULTITEL_API_PASSWORD μέσω της διαμόρφωσης μυστικών του διακομιστή σας πριν χρησιμοποιήσετε τα παραδείγματα. Μην τα ενσωματώνετε ποτέ σε δημόσια JavaScript προγράμματος περιήγησης, διευθύνσεις URL ή έλεγχο πηγαίου κώδικα. Τα ειδικά διαπιστευτήρια διαχειρίζονται στις ρυθμίσεις ενοποίησης API.
Πρώτο αίτημα: διαβάστε το υπόλοιπό σας
Αυτή η ανάγνωση δεν αγοράζει υπηρεσία ούτε δημιουργεί κλήση ή μήνυμα.
curl --fail-with-body \
--user "$MULTITEL_API_USERNAME:$MULTITEL_API_PASSWORD" \
--header "Accept: application/json" \
"https://api.multitel.net/v3/getbalance"Το Communications v3 API επιστρέφει ένα αποτέλεσμα εφαρμογής μέσα στο σώμα JSON. Ελέγξτε την κατάσταση HTTP και το status.code πριν διαβάσετε το response· μια απορριφθείσα αίτηση μπορεί να μην έχει αντικείμενο απόκρισης. Οι τιμές κωδικών μπορεί να είναι συμβολοσειρές ή αριθμοί.
{
"status": {
"code": 200,
"msg": ""
},
"response": {
"balance": "25.0000",
"currency": "USD",
"terms": "Prepaid"
}
}Αυτό είναι ένα φανταστικό παράδειγμα, όχι το υπόλοιπο του λογαριασμού. Αντιμετωπίστε τις χρηματικές τιμές ως δεκαδικά ποσά. Διατηρήστε το μήνυμα απόκρισης του διακομιστή κατά τη διάγνωση μιας απορριφθείσας αίτησης, αφού αφαιρέσετε τα διαπιστευτήρια.
Χρησιμοποιήστε σωστά τα δεδομένα χρέωσης
Η απόκριση υπολοίπου περιέχει το τρέχον υπόλοιπο, το νόμισμα και τους όρους πληρωμής. Δεν δίνει το κόστος μιας μελλοντικής κλήσης ούτε ένα πλήρες τιμολόγιο. Χρησιμοποιήστε τις αντίστοιχες λειτουργίες τιμολογίων και χρήσης για αυτά τα ερωτήματα. Οι υπάρχοντες αριθμοί μπορεί να έχουν διαφορετικά προγράμματα από τον σημερινό κατάλογο.
Επιλέξτε την επόμενη ενοποίησή σας
REST API αναζήτησης δρομολόγησης LRN
Αναζητήστε τον αριθμό δρομολόγησης και τις διαθέσιμες πληροφορίες φορέα για έναν τηλεφωνικό αριθμό της Βόρειας Αμερικής με σταθερή τιμή.
Διαβάστε τον οδηγό ενοποίησης →REST API τηλεφωνικών αριθμών
Ανακαλύψτε διαθέσιμες χώρες και αριθμούς, εξετάστε την πλήρη προσφορά και διαχειριστείτε τους αριθμούς που κατέχετε.
Διαβάστε τον οδηγό ενοποίησης →REST API για SMS και MMS
Στείλτε εγκεκριμένα μηνύματα εφαρμογής και διαχειριστείτε την αποδοχή, τα συμβάντα παράδοσης, την τμηματοποίηση και τις χρεώσεις.
Διαβάστε τον οδηγό ενοποίησης →REST API κλήσεων έκτακτης ανάγκης
Καταχωρίστε έναν αριθμό και μια διεύθυνση υπηρεσίας, παρακολουθήστε την κατάσταση ενεργοποίησής της και διατηρείτε την εγγραφή ενημερωμένη όταν αλλάζει η τοποθεσία.
Διαβάστε τον οδηγό ενοποίησης →REST API λογαριασμού και χρέωσης
Διαβάστε το υπόλοιπο και τις πληροφορίες χρέωσης που είναι διαθέσιμες στην εγκεκριμένη ενσωμάτωσή σας.
Διαβάστε τον οδηγό ενοποίησης →Αναζητήσεις CNAM και δρομολόγησης
Διαβάστε ονόματα καλούντων, κατανοήστε τα επίπεδα αναζήτησης και χρησιμοποιήστε πληροφορίες δρομολόγησης αριθμών.
Αναφορά CNAM REST →Φιλοξενούμενο PBX
Ξεκινήστε με τα διαθέσιμα πακέτα υπηρεσίας και τον tenant που σκοπεύετε να ρυθμίσετε.
API πακέτων υπηρεσίας φιλοξενούμενου PBX →Διαχείριση σφαλμάτων και επαναλήψεων
- Αποτυχία ελέγχου ταυτότητας ή δικαιωμάτων
- Ελέγξτε την κατάσταση ενεργοποίησης του διαπιστευτηρίου API, την επιτρεπόμενη υπηρεσία και τον περιορισμό IP προέλευσης. Ένα cookie συνεδρίας πύλης δεν αποτελεί διαπιστευτήριο ενοποίησης.
- Ανεπαρκές υπόλοιπο ή μη εκπληρωμένη έγκριση
- Τακτοποιήστε το υπόλοιπο του λογαριασμού, την έγκριση αποστολής ή την απαίτηση εγγράφων πριν επαναλάβετε τη λειτουργία.
- Χωρίς αποτέλεσμα
- Διαχειριστείτε το κενό απόθεμα ή ένα όνομα καλούντος που λείπει ως συνηθισμένο αποτέλεσμα. Μην υποθέτετε ότι ένας συντακτικά έγκυρος αριθμός διαθέτει κάθε υπηρεσία.
- Λήξη χρονικού ορίου δικτύου ή αποτυχία υπηρεσίας
- Για αναγνώσεις, χρησιμοποιήστε περιορισμένο αριθμό επαναλήψεων με σταδιακά αυξανόμενη καθυστέρηση. Για αγορά, αποστολή ή εγγραφή, ελέγξτε πρώτα την κατάσταση της λειτουργίας· η επανάληψη ενός αποδεκτού αιτήματος μπορεί να διπλασιάσει μια χρεώσιμη ενέργεια.
Η υποστήριξη ταυτοδυναμίας ανήκει σε κάθε οικογένεια API. Το API έκτακτης ανάγκης υποστηρίζει κλειδιά επανάληψης· αυτό δεν καθιστά τα αυθαίρετα αιτήματα v3 ταυτοδύναμα. Διατηρήστε χρονικές σημάνσεις, επιστρεφόμενα αναγνωριστικά και ανωνυμοποιημένες αποκρίσεις για την υποστήριξη.
Συνεχίστε με την αναφορά του λογαριασμού σας
Η αναφορά μετά τη σύνδεση φιλτράρει τις λειτουργίες ανάλογα με τα δικαιώματά σας και τις ενεργοποιημένες υπηρεσίες. Χρησιμοποιήστε ακριβώς τον κεντρικό υπολογιστή (host), τον τύπο διαπιστευτηρίων, τα πεδία αιτήματος και το σχήμα απόκρισης που εμφανίζονται εκεί. Οι κονσόλες μπορούν να εκτελέσουν πραγματικές λειτουργίες, συμπεριλαμβανομένων αγορών και μηνυμάτων.