Προγραμματιστές

GET/v3/lnp/project/{uniqueid}/status

Έλεγχος της κατάστασης ενός έργου φορητότητας

Δείτε τη σύνοψη του έργου και τις καταμετρήσεις ανά κατάσταση χωρίς να ανακτήσετε διαπιστευτήρια χρέωσης.

Σε αυτή τη σελίδα
  1. Πρόσβαση στον λογαριασμό και στο έργο
  2. Αίτημα
  3. Απόκριση
  4. Η σύνοψη δεν αποτελεί αποτέλεσμα που ισχύει για όλους τους αριθμούς
  5. Ερμηνεία της κατάστασης φορητότητας
  6. Σφάλματα και περιορισμοί
  7. Επιδράσεις

Πρόσβαση στον λογαριασμό και στο έργο

Χρησιμοποιήστε έναν ενεργοποιημένο λογαριασμό API μέσω HTTPS από επιτρεπόμενη διεύθυνση IP. Το έργο πρέπει να ανήκει σε αυτόν τον λογαριασμό και να μην έχει διαγραφεί. Χρησιμοποιήστε το μοναδικό αναγνωριστικό του έργου από τη ροή παραγγελίας φορητότητας, όχι το αριθμητικό αναγνωριστικό του στη βάση δεδομένων ούτε έναν αριθμό τηλεφώνου. Εφαρμόστε κωδικοποίηση URL στο αναγνωριστικό του έργου κατά τη δημιουργία ενός αιτήματος.

Αίτημα

curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/v3/lnp/project/$PROJECT_ID/status"

Αυτό το τελικό σημείο δεν διαβάζει σώμα αιτήματος, παραμέτρους σελιδοποίησης ή φίλτρο ημερομηνίας.

Απόκριση

Υποθετικό παράδειγμα απόκρισης.

{
  "status": {
    "code": 200,
    "msg": "Project Status"
  },
  "response": {
    "uniqueid": "PROJECT_EXAMPLE",
    "status": 2,
    "status_str": "Completed",
    "counts": {
      "total": 2,
      "pending": 0,
      "in_progress": 0,
      "completed": 1,
      "rejected": 1
    }
  }
}

Το εξωτερικό πεδίο status.code αναφέρει το αποτέλεσμα του API. Το ξεχωριστό πεδίο response.status είναι η σύνοψη φορητότητας που προκύπτει από τα δεδομένα του έργου. Μη συγχέετε τα δύο πεδία.

Η σύνοψη δεν αποτελεί αποτέλεσμα που ισχύει για όλους τους αριθμούς

Η σύνοψη επιλέγει In Progress αν έστω και ένας αριθμός έχει αυτή την κατάσταση· διαφορετικά επιλέγει, κατά σειρά προτεραιότητας, Pending, Completed ή Rejected. Αν δεν βρεθεί καμία αντίστοιχη γνωστή κατάσταση, χρησιμοποιεί την προεπιλογή Pending. Επομένως, ένα έργο που περιέχει τόσο αριθμούς με ολοκληρωμένη φορητότητα όσο και αριθμούς που έχουν απορριφθεί αναφέρει Completed, παρότι εξακολουθεί να περιέχει αριθμούς που έχουν απορριφθεί.

Ελέγχετε πάντα τις καταμετρήσεις και τη λίστα των επιμέρους αριθμών πριν θεωρήσετε ότι έχει ολοκληρωθεί ολόκληρο το έργο. counts.total περιλαμβάνει κάθε γραμμή αριθμού του έργου· οι υπόλοιποι μετρητές καλύπτουν μόνο τις τέσσερις γνωστές τιμές κατάστασης και το άθροισμά τους ενδέχεται να μη συμπίπτει με το σύνολο όταν υπάρχουν άλλες τιμές. Ένα έργο χωρίς αριθμούς αναφέρει μηδενικούς μετρητές και σύνοψη με κατάσταση Pending.

Ερμηνεία της κατάστασης φορητότητας

Γνωστές τιμές κατάστασης αριθμών
ΤιμήΕτικέτα
0Pending
1In Progress
2Completed
9Rejected

Διατηρείτε την αριθμητική κατάσταση και χειρίζεστε επίσης άγνωστες τιμές. Για άγνωστες ετικέτες χρησιμοποιείται η αποθηκευμένη τιμή, χωρίς να διασφαλίζεται η παροχή νέας ετικέτας. Μια αποθηκευμένη κατάσταση ολοκλήρωσης ή μια προγραμματισμένη ημερομηνία δεν αποτελεί από μόνη της έλεγχο της δρομολόγησης εισερχόμενων κλήσεων ή όλων των υπηρεσιών του αριθμού.

Σφάλματα και περιορισμοί

Ελέγξτε τόσο την απόκριση HTTP όσο και τα status.code/status.msg. Ένα έργο που δεν υπάρχει, έχει διαγραφεί ή δεν ανήκει στον λογαριασμό επιστρέφει κωδικό API 404 με μήνυμα ότι το έργο δεν βρέθηκε. Ισχύουν επίσης ο έλεγχος ταυτότητας και οι περιορισμοί για τη διεύθυνση IP προέλευσης. Τα παραδείγματα δεν εκτελούν πραγματικό αίτημα και μια επιτυχής απόκριση δεν αποδεικνύει ότι ένας πάροχος έχει αποδεχθεί ή ολοκληρώσει μια μεταφορά.

Επιδράσεις

Αυτό το τελικό σημείο διαβάζει τις αποθηκευμένες καταμετρήσεις του έργου. Στον χειριστή που εξετάστηκε, δεν υποβάλλει αίτημα μεταφοράς, δεν αλλάζει κατάσταση, δεν ξεκινά κλήση και δεν χρεώνει τον λογαριασμό. Δεν παρέχει περιοδικό έλεγχο του παρόχου σε πραγματικό χρόνο ούτε εγγραφή σε ειδοποιήσεις webhook.