Φόρτωση καταλόγων για την καταχώριση υπηρεσιών μηνυμάτων

Φορτώστε τις επιλογές πριν δημιουργήσετε μια φόρμα καταχώρισης

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

Επιλέξτε έναν κατάλογο

Χειριστείτε απευθείας την απόκριση TCR

Το σώμα της απόκρισης προέρχεται απευθείας από το API του TCR. Σε αντίθεση με πολλά παλαιότερα τελικά σημεία /v3, δεν περιλαμβάνει πρόσθετο περίβλημα status/response. Ελέγξτε την κατάσταση HTTP πριν ερμηνεύσετε την απόκριση. Ένας κατάλογος μπορεί να περιέχει ετικέτες συμβολοσειρών ή δομημένους ορισμούς, επομένως μην υποθέτετε ότι κάθε τιμή έχει τα ίδια πεδία. Αν το αίτημα HTTP επιτύχει αλλά το σώμα δεν είναι έγκυρο JSON με την αναμενόμενη δομή, αναφέρετε αποτυχία αναζήτησης αντί να το αντικαταστήσετε σιωπηρά με μια κενή λίστα.

Διαχωρίστε τις επιλογές των καταλόγων από την επιλεξιμότητα και την τιμολόγηση

Ένας γενικός κατάλογος περιπτώσεων χρήσης δεν σας πληροφορεί για ποιες περιπτώσεις χρήσης πληροί τις προϋποθέσεις μια συγκεκριμένη επωνυμία. Η τρέχουσα πύλη εκτελεί αναζήτηση επιλεξιμότητας ειδικά για την επωνυμία πριν από τη δημιουργία καμπάνιας και ελέγχει τις απαιτήσεις των επιλεγμένων τηλεπικοινωνιακών παρόχων. Ομοίως, τα μεταδεδομένα χρεώσεων ενός προμηθευτή δεν αποτελούν την τελική τιμή λιανικής του λογαριασμού. Εξετάστε ξεχωριστά την τιμή που ισχύει για τον λογαριασμό και τους όρους καταχώρισης. Η φόρτωση ενός καταλόγου δεν εγκρίνει επωνυμία, καμπάνια ή αριθμό μηνυμάτων.

Χειριστείτε τους μη διαθέσιμους καταλόγους

Διατηρήστε τα στοιχεία που έχει εισαγάγει ο πελάτης στη φόρμα αν αποτύχει μια αναζήτηση. Εμφανίστε το σφάλμα, τηρήστε το Retry-After όταν επιστρέφεται και αυξήστε σταδιακά το διάστημα μεταξύ των επαναπροσπαθειών. Μην επαναφορτώνετε συνεχώς όλους τους καταλόγους και μην αντιμετωπίζετε ένα σφάλμα ορίου ρυθμού αιτημάτων ή μεταφοράς ως έγκυρο κενό κατάλογο. Αυτό το αίτημα GET δεν απαιτεί κλειδί ιδιοδυναμίας και δεν αναπαράγεται από τον χώρο αποθήκευσης ιδιοδυναμίας των πράξεων μεταβολής.

Αίτημα

Χρησιμοποιήστε έναν ενεργοποιημένο λογαριασμό API μέσω HTTPS από επιτρεπόμενη διεύθυνση IP προέλευσης. Η τρέχουσα διαδρομή υποστηρίζει την πολιτική ελέγχου ταυτότητας του λογαριασμού, συμπεριλαμβανομένου του ελέγχου ταυτότητας Basic και των ενεργοποιημένων λογαριασμών API με διακριτικό κομιστή. Μη χρησιμοποιείτε διαπιστευτήρια του παρόχου.

Στείλτε αίτημα GET με ένα υποστηριζόμενο όνομα καταλόγου στη διαδρομή. Περάστε τα κατάλληλα φίλτρα καταλόγου στη συμβολοσειρά ερωτήματος. Δεν χρειάζεται σώμα αιτήματος.

curl --fail-with-body --silent --show-error \
  --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/tcr/v2/enum/usecase?validSubUsecase=true"

Απόκριση

Αυτή η διαδρομή TCR επιστρέφει απευθείας το σώμα του μητρώου μαζί με την κατάστασή του HTTP. Δεν χρησιμοποιεί το παλαιότερο περίβλημα v3 status.code/status.msg/response. Οι δομές των καταλόγων διαφέρουν: ορισμένοι αντιστοιχίζουν τιμές σε περιγραφικά αντικείμενα, ενώ άλλοι σε συμβολοσειρές. Διατηρήστε τα μηχανικώς αναγνώσιμα κλειδιά όταν υποβάλετε μια μεταγενέστερη φόρμα. Το συντομευμένο πλασματικό παράδειγμα usecase παρουσιάζει μια αντιστοίχιση με αντικείμενα ως τιμές, όχι έναν ενεργό κατάλογο ή ένα εγγυημένα πλήρες σχήμα. Ελέγξτε τόσο την κατάσταση HTTP όσο και την αναμενόμενη δομή JSON.

Ενδεικτική δομή απόκρισης· δεν περιλαμβάνει πραγματικά δεδομένα λογαριασμού ή τρέχουσα οικονομική προσφορά.

{
  "2FA": {
    "displayName": "Authentication",
    "description": "Example authentication use case"
  }
}

Σφάλματα

• 401: Ο έλεγχος ταυτότητας του λογαριασμού απέτυχε. Ελέγξτε το διαπιστευτήριο API, την κατάσταση ενεργοποίησης και τους ισχύοντες περιορισμούς διευθύνσεων IP προέλευσης.
• 400/404 και άλλα σφάλματα μητρώου: Μη έγκυρος ή μη διαθέσιμος κατάλογος ή φίλτρο. Η τρέχουσα διαδρομή διατηρεί την κατάσταση HTTP και το σώμα απόκρισης της ανάντη υπηρεσίας· δεν υπάρχει καθολικό περίβλημα σφαλμάτων v3.
• 429: Συμπληρώθηκε το όριο αιτημάτων του λογαριασμού ή το κοινόχρηστο όριο του παρόχου. Τηρήστε το Retry-After και επαναλάβετε την προσπάθεια αυξάνοντας σταδιακά το διάστημα μεταξύ των προσπαθειών.
• 502: Δεν ήταν δυνατή η επικοινωνία με το μητρώο. Η διαθεσιμότητα είναι άγνωστη· μην παρουσιάζετε κενές επιλογές ως επιτυχές αποτέλεσμα.
• 503: Ο μηχανισμός περιορισμού αιτημάτων ή η ανάντη υπηρεσία δεν είναι διαθέσιμος. Εξετάστε το σώμα και τυχόν κεφαλίδα Retry-After πριν επαναλάβετε την προσπάθεια.

Διαθεσιμότητα και παρενέργειες

• Αυτό το αίτημα GET καταλόγου δεν δημιουργεί επωνυμία ή καμπάνια, δεν υποβάλλει καταχώριση, δεν δεσμεύει πόρο και δεν επιβάλλει τέλος καταχώρισης στη διαδρομή που εξετάστηκε. Επικοινωνεί με τον πάροχο και γράφει εγγραφές ελέγχου αιτημάτων.
• Οι ορισμοί των καταλόγων και τυχόν μεταδεδομένα χρεώσεων του προμηθευτή δεν αποτελούν οικονομική προσφορά λιανικής προς τον πελάτη. Η τρέχουσα πύλη λαμβάνει ξεχωριστά τις τιμές λιανικής των καμπανιών· η παλαιότερη βοηθητική συνάρτηση getCampaignPrice και οι παλιές σημειώσεις τιμών των απαριθμήσεων δεν πρέπει να θεωρούνται η συμβατική βάση τιμολόγησης αυτής της διαδρομής.
• Μια υποστηριζόμενη εγγραφή καταλόγου δεν αποδεικνύει ότι μια συγκεκριμένη επωνυμία πληροί τις προϋποθέσεις για αυτή την περίπτωση χρήσης. Ολοκληρώστε τον έλεγχο επιλεξιμότητας της συγκεκριμένης επωνυμίας, τις δηλώσεις, τη συγκατάθεση και την εξέταση των τιμών του λογαριασμού πριν από ένα μεταγενέστερο αίτημα καταχώρισης.