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

DELETE/tcr/v2/campaign/{campaignId}

Απενεργοποίηση καμπάνιας μηνυμάτων

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

Σε αυτή τη σελίδα
  1. Απενεργοποίηση υπάρχουσας καμπάνιας μηνυμάτων
  2. Καταργήστε πρώτα τις αντιστοιχίσεις των επηρεαζόμενων αριθμών
  3. Υποβολή της επιθυμητής απενεργοποίησης
  4. Επαληθεύστε τόσο την καταχώριση όσο και τις αντιστοιχίσεις
  5. Η απόσυρση είναι ξεχωριστή από την οικονομική τακτοποίηση του λογαριασμού

Απενεργοποίηση υπάρχουσας καμπάνιας μηνυμάτων

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

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

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

Καταργήστε πρώτα τις αντιστοιχίσεις των επηρεαζόμενων αριθμών

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

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

Υποβολή της επιθυμητής απενεργοποίησης

Αφού ελέγξετε το αναγνωριστικό της καμπάνιας και την επηρεαζόμενη διαμόρφωση αποστολής, στείλτε DELETE χωρίς σώμα JSON:

curl --silent --show-error --fail-with-body --user "$API_USER:$API_PASSWORD" \
  --request DELETE \
  --header "Idempotency-Key: $IDEMPOTENCY_KEY" \
  "https://api.multitel.net/tcr/v2/campaign/$CAMPAIGN_ID"

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

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

Επαληθεύστε τόσο την καταχώριση όσο και τις αντιστοιχίσεις

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

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

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

Η απόσυρση είναι ξεχωριστή από την οικονομική τακτοποίηση του λογαριασμού

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

Αν αποσύρεται ολόκληρη η καταχώριση της επιχείρησης αφού ελεγχθούν και τακτοποιηθούν οι καμπάνιες και οι αντιστοιχίσεις της, συνεχίστε με την απόσυρση επωνυμίας.