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

GET/tcr/v2/campaignBuilder/brand/{brand_id}/usecase/{usecase}

Διαβάστε τις απαιτήσεις καμπάνιας μιας επωνυμίας

Διαβάστε τα όρια υπο-περιπτώσεων χρήσης, την επιλεξιμότητα φορέων κινητής και τις απαιτήσεις μηνυμάτων της επιλεγμένης περίπτωσης χρήσης πριν προετοιμάσετε μια καταχώριση καμπάνιας.

Σε αυτή τη σελίδα
  1. Διατηρήστε την επωνυμία και την περίπτωση χρήσης μαζί
  2. Διαβάστε τις τρέχουσες απαιτήσεις
  3. Εφαρμόστε τις απαιτήσεις των επιλεγμένων φορέων συνδυαστικά
  4. Προετοιμάστε δείγματα και αποκρίσεις προς συνδρομητές
  5. Ελέγξτε πριν από οποιοδήποτε αίτημα καταχώρισης
  6. Χειριστείτε μια αποτυχημένη αναζήτηση απαιτήσεων
  7. Αίτημα
  8. Απόκριση
  9. Σφάλματα
  10. Διαθεσιμότητα και παρενέργειες

Διατηρήστε την επωνυμία και την περίπτωση χρήσης μαζί

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

Διαβάστε τις τρέχουσες απαιτήσεις

Απαιτήσεις που χρησιμοποιεί η τρέχουσα φόρμα καμπάνιας
ΠεδίοΠώς το χρησιμοποιεί η πύλη
minSubUsecases / maxSubUsecasesΕλάχιστος και μέγιστος αριθμός υπο-περιπτώσεων χρήσης για αυτήν την επιλογή. Επιλέξτε τιμές από τον κατάλογο έγκυρων υπο-περιπτώσεων χρήσης αντί για ελεύθερο κείμενο.
mnoMetadataΑπαιτήσεις ανά φορέα κινητής, με κλειδί το αναγνωριστικό φορέα. Χρησιμοποιήστε αναγνωριστικά που υπάρχουν στην τρέχουσα απόκριση για την επιλογή φορέων.
mnoSupport / qualifyΥποστήριξη και καταλληλότητα φορέα. Η πύλη εξαιρεί τους φορείς που επισημαίνονται ρητά ως false σε οποιοδήποτε από τα δύο πεδία και απαιτεί τουλάχιστον έναν επιλέξιμο επιλεγμένο φορέα.
minMsgSamplesΑπαιτούμενος αριθμός δειγμάτων για έναν φορέα. Η πύλη απαιτεί τουλάχιστον ένα μη κενό δείγμα και καλύπτει το υψηλότερο ελάχιστο μεταξύ των επιλέξιμων επιλεγμένων φορέων.
reqSubscriberOptin / reqSubscriberOptout / reqSubscriberHelpΑπαιτούμενες δηλώσεις συνδρομητή. Όπου απαιτείται, η αντίστοιχη δήλωση πρέπει να είναι true. Οι ενεργοποιημένες δηλώσεις χρειάζονται επίσης τα πεδία λέξεων-κλειδιών και μηνύματος απόκρισης.
noEmbeddedLink / noEmbeddedPhoneΠεριορισμοί για ενσωματωμένους συνδέσμους ή αριθμούς τηλεφώνου. Η πύλη απορρίπτει μια δηλωμένη δυνατότητα εάν ένας επιλέξιμος επιλεγμένος φορέας την απαγορεύει.

Εφαρμόστε τις απαιτήσεις των επιλεγμένων φορέων συνδυαστικά

Οι απαιτήσεις των φορέων μπορεί να διαφέρουν. Όταν δεν παρέχεται ρητή λίστα φορέων, η πύλη λαμβάνει υπόψη όλα τα μεταδεδομένα φορέων της απόκρισης. Μια μη κενή λίστα περιορίζει τους ελέγχους στα επιλεγμένα αναγνωριστικά. Μην χρησιμοποιείτε μόνο τον αριθμό δειγμάτων ή τις δηλώσεις του πρώτου φορέα. Επιλέξτε φορείς από την απόκριση, ελέγξτε την υποστήριξη και την καταλληλότητα, καλύψτε το υψηλότερο ισχύον ελάχιστο δειγμάτων και ικανοποιήστε τις απαιτούμενες δηλώσεις εγγραφής (opt-in), διαγραφής (opt-out) και βοήθειας σε ολόκληρη αυτήν την επιλογή. Η πύλη απορρίπτει επιλεγμένα αναγνωριστικά φορέων που δεν υπάρχουν στην τρέχουσα απόκριση και απορρίπτει μια επιλογή χωρίς κανέναν επιλέξιμο φορέα.

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

Προετοιμάστε δείγματα και αποκρίσεις προς συνδρομητές

Η τρέχουσα φόρμα καμπάνιας χρησιμοποιεί τα πεδία sample1 έως sample5 για δείγματα μηνυμάτων. Εάν οι απαιτήσεις δεν μπορούν να καλυφθούν εντός της διαθέσιμης φόρμας, σταματήστε και επιλύστε την επιλογή με την υποστήριξη. Για μια ενεργοποιημένη δήλωση συνδρομητή, παρέχετε τις αντίστοιχες λέξεις-κλειδιά και το κείμενο απόκρισης: optinKeywords/optinMessage, optoutKeywords/optoutMessage και helpKeywords/helpMessage. Διατηρήστε τα δείγματα συνεπή με την επιλεγμένη περίπτωση χρήσης και την πραγματική επικοινωνία με τους πελάτες.

Ελέγξτε πριν από οποιοδήποτε αίτημα καταχώρισης

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

Χειριστείτε μια αποτυχημένη αναζήτηση απαιτήσεων

Εάν το αίτημα αποτύχει, επιστρέψει μη αναμενόμενο JSON ή δεν αντιστοιχεί στην επιλεγμένη περίπτωση χρήσης, διατηρήστε τη φόρμα ημιτελή και επιτρέψτε στον πελάτη να δοκιμάσει ξανά αφού επιλυθεί το σφάλμα. Μην αντικαθιστάτε μη διαθέσιμες απαιτήσεις με κενό αντικείμενο και μην υποθέτετε ότι τα ελλείποντα δεδομένα σημαίνουν απουσία απαιτήσεων. Τηρείτε την κεφαλίδα Retry-After και χρησιμοποιείτε backoff για όρια ρυθμού αιτημάτων και αποτυχίες διαθεσιμότητας.

Αίτημα

Χρησιμοποιήστε έναν ενεργοποιημένο λογαριασμό 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/usecase/$USECASE"
Παράμετροι διαδρομής
ΌνομαΤύποςΑπαιτείταιΠεριγραφή
brand_idstringΝαιΤο αναγνωριστικό επωνυμίας του μητρώου που συνδέεται με τον αυθεντικοποιημένο λογαριασμό σας MultiTEL. Χρησιμοποιήστε το αναγνωριστικό επωνυμίας, όχι τοπικό αναγνωριστικό γραμμής βάσης δεδομένων, αναγνωριστικό καμπάνιας ή ΑΦΜ επιχείρησης. Κωδικοποιήστε το ως ένα ενιαίο τμήμα διαδρομής URL.
usecasestringΝαιΗ μηχαναγνώσιμη τιμή usecase που επιλέχθηκε από τη λίστα καταλληλότητας της ίδιας επωνυμίας. Διατηρήστε τα πεζά και κεφαλαία της. Μην στέλνετε μεταφρασμένη ετικέτα εμφάνισης. Κωδικοποιήστε την ως ένα ενιαίο τμήμα διαδρομής URL.

Απόκριση

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

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

{
  "usecase": "2FA",
  "minSubUsecases": 0,
  "maxSubUsecases": 0,
  "mnoMetadata": {
    "12345": {
      "mnoSupport": true,
      "qualify": true,
      "minMsgSamples": 1,
      "reqSubscriberOptin": true,
      "reqSubscriberOptout": true,
      "reqSubscriberHelp": true,
      "noEmbeddedLink": false,
      "noEmbeddedPhone": false
    }
  }
}

Σφάλματα

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

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

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