Τεκμηρίωση με email API

Πώς λειτουργεί το request_id

1. Προεπισκόπηση των μετρήσεων με action=preview. Δεν χρειάζεται request_id και δεν διαγράφονται εγγραφές.
2. Δημιουργία ενός μοναδικού request_id για μια νέα διαγραφή, για παράδειγμα ένα UUID. Αποθήκευση πριν από την αποστολή action=delete.
3. Για τις επαναλήψεις, τα χρονικά όρια ή HTTP 202, επαναχρησιμοποιήστε το ίδιο πλήκτρο API, το τελικό σημείο ιστορικού, request_id και include_linked τιμή. Ποτέ μην δημιουργείτε ένα νέο ID αυτόματα μετά από ένα σφάλμα.
4. Όταν completed=true, η λειτουργία έχει ολοκληρωθεί. Επαναχρησιμοποιώντας την ταυτότητά του επιστρέφει το ίδιο αποτέλεσμα αντί να διαγράψει τα νεοαφιχθέντα αρχεία. Χρησιμοποιήστε μια νέα ταυτότητα μόνο για μια σκόπιμα νέα εκκαθάριση.

request_id προσδιορίζει τη διαγραφή σας λειτουργία, όχι ένα μεμονωμένο SMS. Επιτρεπόμενη μορφή: 16–128 ASCII γράμματα, ψηφία, παύλα ή υποκοριστικά. Ένα UUID που παράγεται με κρυπτο.randomUID () είναι κατάλληλο.

Η διαγραφή γίνεται σε παρτίδες. Με HTTP 202 και continue_required=true, επαναλάβετε το action=delete μετά από 3 δευτερόλεπτα. Δεν εκτελείται cron στο παρασκήνιο. Το action=status διαβάζει μόνο την πρόοδο, χωρίς να συνεχίζει τη διαγραφή, ακόμη και με HTTP 200.

Παραδείγματα διαγραφής και κατάστασης

Αντικαταστήστε το δείγμα request_id με τη δική σας μοναδική αξία πριν ξεκινήσετε. Τα ακόλουθα διαγράψουν τα αιτήματα αλλάζουν πραγματικό ιστορικό λογαριασμού· δεν είναι προεπισκοπήσεις.

curl -X POST "https://api.smsmobileapi.com/delete-history-email/" \
  --data-urlencode "apikey=YOUR_API_KEY" \
  -d "action=delete" -d "include_linked=0" \
  -d "request_id=6d54ac58-41f1-4fbc-9a39-6e6c86089451"

curl -X POST "https://api.smsmobileapi.com/delete-history-email/" \
  -H "Authorization: Bearer YOUR_OAUTH_ACCESS_TOKEN" \
  -d "action=delete" -d "include_linked=0" \
  -d "request_id=6d54ac58-41f1-4fbc-9a39-6e6c86089451"

curl -G "https://api.smsmobileapi.com/delete-history-email/" \
  --data-urlencode "apikey=YOUR_API_KEY" \
  -d "action=status" \
  -d "request_id=6d54ac58-41f1-4fbc-9a39-6e6c86089451"

GET δέχεται επίσης action=preview ή action=delete. POST συνιστάται: Οι παράμετροι URL μπορούν να διαρρεύσουν στο ιστορικό του προγράμματος περιήγησης και τα αρχεία καταγραφής του διακομιστή. Ποτέ μην τοποθετείτε ένα URL διαγραφής σε ένα δημόσιο σύνδεσμο, εικόνα ή προεπιλογή.

Για POST, στείλτε όλες τις παραμέτρους στο σώμα μορφή ή ένα αντικείμενο JSON, ποτέ στη συμβολοσειρά ερωτημάτων. Οι άγνωστες παράμετροι απορρίπτονται· δεν υποστηρίζονται η ημερομηνία ή τα κινητά φίλτρα.

Ταυτοποίηση για τα τελικά σημεία ιστορικού

Χρησιμοποιήστε apikey ή Authorization: Bearer πρόσβαση στο σημείο που εκδόθηκε από SMSMobileAPI OAuth2. Μην στείλετε ένα νέο σημείο ή ένα πλήκτρο API ως ένα Bearer. Τα ληγμένα κουπόνια απορρίπτονται.

Όταν τα πεδία είναι ρυθμισμένα, history:read επιτρέπει προεπισκόπηση / κατάσταση και history:delete επιτρέπει επίσης τη διαγραφή. Ισχύουν περιορισμοί τόσο στον πελάτη του ενδεικτικού όσο και στον πελάτη OAuth. Τα σημεία κληροδότησης χωρίς τα πεδία διατηρούν την υπάρχουσα πρόσβαση του λογαριασμού τους.

OAuth2 επιλέγει το μοναδικό πρωτεύον πλήκτρο API. Εάν υπάρχουν αρκετά βασικά κλειδιά, παρέχουν επίσης apikey για να επιλέξετε ένα που ανήκει στο λογαριασμό. Τα δευτερεύοντα κλειδιά δεν επιτρέπουν ποτέ πρόσβαση στο ιστορικό του βασικού κλειδιού.

Διαβάστε την απάντηση πριν συνεχίσετε

count_delete είναι ο σωρευτικός αριθμός που αφαιρείται από αυτή την λειτουργία. selected_at_start είναι η αρχική επιλογή; protected_at_start μετράει αποκλεισμένα αρχεία. Χρησιμοποιήστε preview.linked_or_processing για να μετρήσετε τις συνδεδεμένες εγγραφές ακόμη και όταν include_linked=1.

{
    "result": {
        "error": 0,
        "history": "email",
        "action": "delete",
        "request_id": "6d54ac58-41f1-4fbc-9a39-6e6c86089451",
        "status": "processing",
        "completed": false,
        "count_delete": 100,
        "total_before": 250,
        "selected_at_start": 200,
        "protected_at_start": 50,
        "include_linked": 0,
        "continue_required": true,
        "message": "Repeat GET or POST with the same request_id and include_linked to continue. Status requests do not run deletion."
    }
}

• 200 με completed=true: ολοκληρώθηκε. Μια προεπισκόπηση 200 ή απάντηση κατάστασης από μόνη της δεν αποδεικνύει ολοκλήρωση.
• 400 INVALID_REQUEST_ID: ελέγξτε τη μορφή. 404 REQUEST_NOT_FOUND: δεν υπάρχει λειτουργία για αυτό το ID, το πλήκτρο API και το ιστορικό.
• 401: άκυρα ή ληγμένα διαπιστευτήρια. 403: ανεπαρκής εμβέλεια OAuth ή μη εξουσιοδοτημένος λογαριασμός.
• 409 HISTORY_BUSY: εκτελείται ένας άλλος καθαρισμός, συνεχίστε τον από τον αρχικό πελάτη. 409 INCLUDE_LINKED_CONFLICT: επαναφορά της αρχικής τιμής include_linked.
• 409 OAUTH_ACCOUNT_AMBIGUOUS: παρέχουν ένα κλειδί API που ανήκει σε αυτόν τον λογαριασμό.
• 503 ή διακοπή δικτύου: ορισμένες παρτίδες μπορούν ήδη να συμπληρωθούν. Ελέγξτε τις ρυθμίσεις, στη συνέχεια, επανεκκίνηση με το αρχικό request_id. Μη δημιουργία αυτόματης λειτουργίας αντικατάστασης.