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

POST/tcr/v2/campaignBuilder

Καταχωρίστε μια καμπάνια 10DLC

Υποβάλετε μια επιλέξιμη καμπάνια και διακρίνετε την καταχώριση στο μητρώο από την ενεργοποίηση φορέα και την ετοιμότητα αποστολής.

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

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

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

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

Διατηρήστε χωριστά το δοκιμαστικό περιβάλλον και την παραγωγή

Για δοκιμαστική άσκηση, χρησιμοποιήστε τη δική σας εικονική επωνυμία και μια τρέχουσα περίπτωση χρήσης για την οποία αυτή είναι επιλέξιμη. Χρησιμοποιήστε το TRIAL μόνο όταν προσφέρεται από αυτόν τον έλεγχο επιλεξιμότητας. Η πύλη ελέγχει ότι η επιλεγμένη επωνυμία και το περιβάλλον καμπάνιας συμφωνούν. Ένα άμεσο αίτημα API δεν εκτελεί για εσάς την πλήρη επικύρωση του οδηγού της πύλης, οπότε διατηρήστε αυτόν τον διαχωρισμό στην ενοποίησή σας.

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

Υποβάλετε το JSON καμπάνιας

Προετοιμάστε το campaign.json με τις επιλέξιμες τιμές σας. Το R000000 σημαίνει χωρίς μεταπωλητή. Χρησιμοποιήστε το μόνο όταν αυτή είναι η προβλεπόμενη διαμόρφωση. Για την κανονική διαμόρφωση μεταπωλητή MultiTEL, λάβετε το επιτρεπόμενο αναγνωριστικό μεταπωλητή MultiTEL LLC από τη συλλογή μεταπωλητών του λογαριασμού σας ή από τη ροή προετοιμασίας της πύλης, αντί να ενσωματώσετε σταθερά το αναγνωριστικό κάποιου άλλου.

curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
  'https://api.multitel.net/tcr/v2/reseller?companyName=MultiTEL%20LLC&recordsPerPage=500'

Το ακόλουθο JSON απεικονίζει μια δοκιμαστική καμπάνια για δική σας εικονική επωνυμία. Αντικαταστήστε την επωνυμία, την περίπτωση χρήσης, τον μεταπωλητή και το κείμενο συναίνεσης με τις τιμές που πληρούν πράγματι τις προϋποθέσεις για τη δοκιμή σας.

{
  "brandId": "B123ABC",
  "channelId": "10DLC",
  "usecase": "TRIAL",
  "subUsecases": [],
  "resellerId": "R000000",
  "description": "Trial account notices requested by users of the example application.",
  "messageFlow": "Test users explicitly select an unchecked consent box before requesting these trial notices.",
  "sample1": "Example application: your requested account notice is available. Reply STOP to stop notices.",
  "subscriberOptin": true,
  "optinKeywords": "START",
  "optinMessage": "You are subscribed to the example application's requested account notices.",
  "subscriberOptout": true,
  "optoutKeywords": "STOP",
  "optoutMessage": "You will no longer receive the example application's account notices.",
  "subscriberHelp": true,
  "helpKeywords": "HELP",
  "helpMessage": "For help with example account notices, contact support@example.invalid.",
  "embeddedLink": false,
  "embeddedPhone": false,
  "numberPool": false,
  "ageGated": false,
  "directLending": false,
  "termsAndConditions": true,
  "autoRenewal": false,
  "mnoIds": [],
  "referenceId": "your-trial-reference"
}

Ορίστε το termsAndConditions σε true μόνο αφού το εξουσιοδοτημένο άτομο έχει ελέγξει και αποδεχθεί τους ισχύοντες όρους. Το παράδειγμα δεν αποτελεί συναίνεση εκ μέρους σας. Χρησιμοποιήστε λογικές τιμές JSON για τις σημαίες, όχι συμβολοσειρές σε εισαγωγικά.

curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
  --header 'Content-Type: application/json' \
  --header "Idempotency-Key: $IDEMPOTENCY_KEY" \
  --data-binary @campaign.json \
  'https://api.multitel.net/tcr/v2/campaignBuilder'

Πεδία καμπάνιας και απαιτήσεις υπό συνθήκη

Αίτημα καμπάνιας 10DLC
ΠεδίαΤι να δηλώσετε
brandId, channelId, usecaseΗ δική σας επωνυμία, το κανάλι 10DLC και ένας επιλέξιμος τρέχων κωδικός περίπτωσης χρήσης. Χρησιμοποιήστε κωδικούς από τον έλεγχο επιλεξιμότητας, όχι μεταφρασμένες ετικέτες.
subUsecasesΠίνακας επιλέξιμων κωδικών δευτερευουσών περιπτώσεων χρήσης. Τηρήστε τον ελάχιστο και τον μέγιστο αριθμό του επιλεγμένου αποτελέσματος ελέγχου επιλεξιμότητας.
resellerIdΈνα επιτρεπόμενο αναγνωριστικό μεταπωλητή. Η διαδρομή που ανήκει στον λογαριασμό αποδέχεται δικούς σας μεταπωλητές, τον διαμορφωμένο κοινόχρηστο μεταπωλητή της ή τη σκόπιμη τιμή χωρίς μεταπωλητή. Ένας άσχετος μεταπωλητής απορρίπτεται.
description, messageFlowΠεριγράψτε τον πραγματικό σκοπό και τον τρόπο συλλογής της συναίνεσης. Κάθε πεδίο πρέπει να περιέχει 40–4096 χαρακτήρες. Συμπεριλάβετε την πραγματική ενέργεια, φόρμα ή διαδικασία του χρήστη. Μην επινοείτε συναίνεση που η εφαρμογή σας δεν συλλέγει.
sample1 … sample5Αντιπροσωπευτικά μηνύματα, κανονικά 20–1024 χαρακτήρες το καθένα. Η πύλη απαιτεί τουλάχιστον ένα. Τα επιλέξιμα δίκτυα μπορεί να απαιτούν περισσότερα. Παράσχετε τον αριθμό που απαιτεί ο τρέχων έλεγχος επιλεξιμότητας.
subscriberOptin, subscriberOptout, subscriberHelpΔηλώστε τις υποστηριζόμενες ροές παραληπτών χρησιμοποιώντας αυτά τα ακριβή ονόματα πεδίων. Όταν μια ροή είναι ενεργοποιημένη, παράσχετε τα πεδία λέξεων-κλειδιών και μηνυμάτων της. Οι απαιτήσεις δικτύου μπορεί να καθιστούν συγκεκριμένες ροές υποχρεωτικές.
optinKeywords, optoutKeywords, helpKeywordsΟι πραγματικές αναγνωριζόμενες λέξεις-κλειδιά, έως 255 χαρακτήρες. Πρέπει να αντιστοιχούν στη συμπεριφορά της εφαρμογής λήψης.
optinMessage, optoutMessage, helpMessageΤα αντίστοιχα μηνύματα. Οι τρέχοντες δημοσιευμένοι κανόνες πεδίων ορίζουν 20–1024 χαρακτήρες. Συμπεριλάβετε πραγματική συμπεριφορά υποστήριξης και απεγγραφής.
embeddedLink, embeddedPhone, embeddedLinkSampleΔηλώστε με ειλικρίνεια ενσωματωμένους συνδέσμους ή αριθμούς τηλεφώνου. Ένα κατά τα άλλα επιλέξιμο δίκτυο μπορεί να τους απαγορεύει. Ένα δείγμα συνδέσμου επιτρέπει έως 255 χαρακτήρες.
mnoIdsΈνας προαιρετικός πίνακας επιλέξιμων αριθμητικών αναγνωριστικών δικτύων από τον έλεγχο επιλεξιμότητας. Μην υποθέτετε ότι κάθε δίκτυο υποστηρίζει την επιλεγμένη περίπτωση χρήσης.
numberPool, ageGated, directLendingΙσχύοντα χαρακτηριστικά καμπάνιας ως λογικές τιμές JSON. Επιλέξτε τα σύμφωνα με την πραγματική υπηρεσία.
privacyPolicyLink, termsAndConditionsLinkΟι σχετικές δημόσιες διευθύνσεις URL πολιτικής και όρων σας, όταν ισχύουν, έως 2048 χαρακτήρες η καθεμία. Πρέπει να περιγράφουν την πραγματική υπηρεσία ανταλλαγής μηνυμάτων.
termsAndConditionsΡητή αποδοχή των ισχύοντων όρων καμπάνιας. Η πύλη απαιτεί true και ο οδηγός της συλλέγει επίσης τις τρέχουσες επιμέρους επιβεβαιώσεις.
autoRenewalΕάν η καμπάνια ανανεώνεται. Η προεπιλογή είναι true. Η απενεργοποίηση της ανανέωσης δεν καταργεί ελάχιστη δέσμευση που ήδη συνδέεται με καμπάνια παραγωγής.
referenceId, tagΗ αναφορά καμπάνιας σας, έως 50 χαρακτήρες, και προαιρετικές ετικέτες. Το referenceId δεν είναι η κεφαλίδα Idempotency-Key.

Το δημοσιευμένο σχήμα περιέχει ορισμένες ασυνεπείς χρήσεις κεφαλαίων στους περιγραφικούς πίνακες. Το τρέχον αίτημα πύλης χρησιμοποιεί τα subscriberOptin και subscriberOptout όπως φαίνεται παραπάνω. Διατηρήστε αυτή την ακριβή χρήση πεζών/κεφαλαίων. Αυτός ο οδηγός καλύπτει τη ροή 10DLC για μισθωτές. Μην συμπεράνετε ότι τα απαιτούμενα πεδία ή τα βήματα ενεργοποίησης διαφορετικού καναλιού είναι τα ίδια.

Επαναλάβετε με ασφάλεια το ίδιο προβλεπόμενο αίτημα

Χρησιμοποιήστε ένα Idempotency-Key για αυτή την προβλεπόμενη δημιουργία. Το κλειδί είναι 1–128 εκτυπώσιμοι χαρακτήρες ASCII χωρίς κενά και περιορίζεται στον λογαριασμό κατόχου. Διατηρήστε αμετάβλητα σε επανάληψη τη μέθοδο HTTP, τη διαδρομή, τη συμβολοσειρά ερωτήματος και τα ακριβή byte του σώματος. Ένα αναδιαμορφωμένο αρχείο JSON συγκρούεται ακόμη και αν οι τιμές του είναι ισοδύναμες.

Ένα διπλότυπο σε εξέλιξη μπορεί να επιστρέψει HTTP 409 με Retry-After. Ολοκληρωμένα αιτήματα μπορεί να αναπαράγουν την αποθηκευμένη απόκρισή τους. Ένα αποθηκευμένο σφάλμα δεν αποδεικνύει ότι το μητρώο δεν δημιούργησε τίποτα. Αποθηκεύστε τα campaignId, requestId και τυχόν κεφαλίδες συσχέτισης, επιθεωρήστε την υπάρχουσα καμπάνια και διευθετήστε τυχόν μερική αποτυχία πριν εξετάσετε νέο κλειδί.

Ένα αναγνωριστικό καμπάνιας δεν είναι η τελική ρύθμιση αποστολής

Η απόκριση χρησιμοποιεί κατάσταση HTTP και άμεσο JSON. Σε επιτυχή δημιουργία, κρατήστε το campaignId και διαβάστε την τρέχουσα κατάστασή του:

curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/tcr/v2/campaign/$CAMPAIGN_ID"

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

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

Χρεώσεις καμπανιών παραγωγής

Τρέχουσες διαμορφωμένες μηνιαίες χρεώσεις καμπανιών
Περίπτωση χρήσηςΜηνιαία χρέωση
LOW_VOLUME, UCAAS_LOW$1.67
SOLE_PROPRIETOR$2.23
CHARITY$3.34
EMERGENCY$5.56
AGENTS_FRANCHISES$33.34
Άλλες διαμορφωμένες εφεδρικές περιπτώσεις χρήσης$11.12

Αυτά τα ποσά λιανικής ελέγχθηκαν με την τρέχουσα διαμόρφωση πύλης στις 24 Οκτωβρίου 2026. Επιβεβαιώστε την τρέχουσα επιλέξιμη περίπτωση χρήσης και την εμφανιζόμενη τιμή πριν από παραγωγική υποβολή. Ένα monthlyFee σε απόκριση ελέγχου επιλεξιμότητας από το μητρώο δεν είναι αυτόματα η λιανική τιμή MultiTEL σας.

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

Αντιμετωπίστε σφάλματα επικύρωσης και μερικές αποτυχίες

Διαβάστε την ένδειξη HTTP status και το επιστρεφόμενο JSON. Τα σφάλματα επικύρωσης μπορεί να είναι πίνακες αντικειμένων code/description. Τα τοπικά σφάλματα μπορεί αντίθετα να είναι αντικείμενα με message, status και, για ορισμένα σφάλματα επεξεργασίας, requestId.

Αποτυχίες καμπάνιας
Αποτέλεσμα HTTPΕπόμενη ενέργεια
400Διορθώστε τα συγκεκριμένα πεδία ή το κλειδί αποφυγής διπλών υποβολών. Επανελέγξτε το τρέχον αποτέλεσμα ελέγχου επιλεξιμότητας, τον απαιτούμενο αριθμό δειγμάτων και τις απαιτήσεις ροών παραληπτών.
401, 403 ή 404Ελέγξτε τα διαπιστευτήρια API και την επιτρεπόμενη IP προέλευσης, κατόπιν την κυριότητα και τα δικαιώματα επωνυμίας/μεταπωλητή. Μην χρησιμοποιείτε αναγνωριστικά από άλλον λογαριασμό.
402Ελέγξτε τη χρηματοδότηση παραγωγής και το δικαίωμα αγοράς πριν επαναλάβετε την ίδια προβλεπόμενη δημιουργία.
409Διακρίνετε την επανάληψη σε εξέλιξη από τροποποιημένο αίτημα που χρησιμοποιεί το ίδιο κλειδί. Διατηρήστε τα στοιχεία υπάρχουσας καμπάνιας και αιτήματος κατά τη διευθέτηση.
429 ή μη διαθέσιμος περιοριστήςΤηρήστε το Retry-After όταν υπάρχει και διατηρήστε το αρχικό κλειδί και το ακριβές αίτημα.
500 ή 502Η δημιουργία μπορεί να έχει ήδη πραγματοποιηθεί. Αποθηκεύστε τυχόν campaignId και requestId, ελέγξτε την υπάρχουσα καμπάνια και συνεχίστε ή διευθετήστε την ενεργοποίησή της αντί να δημιουργήσετε διπλότυπο.