Ελέγξτε τις διαθέσιμες περιπτώσεις χρήσης καμπάνιας για μια επωνυμία

Επιλέξτε μια υπάρχουσα επωνυμία στον λογαριασμό σας

Ξεκινήστε με το αναγνωριστικό επωνυμίας του μητρώου που είναι ήδη συσχετισμένο με τον λογαριασμό σας στη MultiTEL. Αυτή η αναζήτηση δεν δημιουργεί επωνυμία ούτε συσχετίζει την επωνυμία κάποιου άλλου με τον λογαριασμό σας. Η τρέχουσα ροή εργασίας του πελάτη ελέγχει την κυριότητα πριν ζητήσει στοιχεία επιλεξιμότητας. Αν η αναζήτηση επιστρέψει 404, επαληθεύστε τον επιλεγμένο λογαριασμό και την επωνυμία αντί να χρησιμοποιήσετε ένα τοπικό αναγνωριστικό γραμμής.

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

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

Η πύλη αναμένει αυτή η απόκριση να είναι λίστα JSON. Αν λείπει, έχει εσφαλμένη μορφή ή αποτελεί σφάλμα, διατηρήστε τη φόρμα του πελάτη και εμφανίστε ένδειξη ότι δεν ήταν δυνατή η φόρτωση της επιλεξιμότητας. Μην την εκλαμβάνετε σιωπηρά ως έγκριση για μια προεπιλεγμένη περίπτωση χρήσης. Το μητρώο ενδέχεται να επιστρέψει επιπλέον πεδία πέρα από εκείνα του συντομευμένου παραδείγματος.

Φορτώστε τις απαιτήσεις για την επιλεγμένη περίπτωση χρήσης

Αφού ο πελάτης επιλέξει μια επιστρεφόμενη τιμή περίπτωσης χρήσης, στείλτε αίτημα στο /tcr/v2/campaignBuilder/brand/{brand_id}/usecase/{usecase} για την ίδια επωνυμία. Αυτή η απόκριση παρέχει όρια για τις υποπεριπτώσεις χρήσης και απαιτήσεις ανά πάροχο κινητής τηλεφωνίας. Χρησιμοποιήστε τη για να συλλέξετε δείγματα μηνυμάτων, συγκατάθεση και άλλες απαιτούμενες δηλώσεις. Η λίστα επιλεξιμότητας από μόνη της δεν αρκεί για την προετοιμασία μιας πλήρους εγγραφής καμπάνιας.

Εξετάστε χωριστά την τιμολόγηση του λογαριασμού

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

Ανανεώστε τα στοιχεία όταν αλλάζει η επωνυμία ή η περίπτωση χρήσης

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

Αίτημα

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

GET με το αναγνωριστικό της επωνυμίας στη διαδρομή του URL. Δεν απαιτείται σώμα αιτήματος.

curl --fail-with-body --silent --show-error \
  --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/tcr/v2/campaignBuilder/brand/$BRAND_ID"

Απόκριση

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

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

[
  {
    "usecase": "2FA"
  }
]

Σφάλματα

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

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

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