Documentazione di posta elettronica API

Come funziona request_id

1. Anteprima i conti con action=preview. Non è necessario alcun request_id e non vengono eliminati i record.
2. Generare un unico request_id per una nuova cancellazione, ad esempio un UUID. Salvalo prima di inviare action=delete.
3. Per i retries, timeout o HTTP 202, riutilizzare lo stesso tasto API, endpoint di storia, request_id e include_linked valore. Non generare mai un nuovo ID automaticamente dopo un errore.
4. Quando completed=true, l'operazione è terminata. Riutilizzare il suo ID restituisce lo stesso risultato invece di cancellare i record appena arrivati. Utilizzare un nuovo ID solo per una pulizia deliberatamente nuova.

request_id identifica l'operazione di cancellazione, non un singolo SMS. Formato consentito: 16–128 lettere ASCII, cifre, trattini o sottolineature. È adatto un UUID generato con crypto.randomUUID().

L’eliminazione avviene in lotti. HTTP 202 con continue_required=true richiede di ripetere action=delete dopo 3 secondi. Non è previsto un cron in background. action=status legge solo l’avanzamento senza proseguire l’eliminazione, anche con HTTP 200.

Esempi di cancellazione e stato

Sostituire il campione request_id con il proprio valore unico prima di iniziare. Le seguenti richieste di cancellazione cambiano la cronologia del conto reale; non sono anteprime.

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 accetta anche action=preview o action=delete. POST è consigliato: i parametri dell'URL possono penetrare nella cronologia del browser e nei registri del server. Non posizionare mai un URL di cancellazione in un link pubblico, immagine o prefetch.

Per POST, inviare tutti i parametri nel corpo del modulo o un oggetto JSON, mai nella stringa di query. I parametri sconosciuti sono rifiutati; i filtri data o mobile non sono supportati.

Autenticazione per i endpoint storici

Utilizzare apikey o un token di accesso Authorization: Bearer rilasciato da SMSMobileAPI OAuth2. Non inviare un token di aggiornamento o una chiave API come un token Bearer. I gettoni scarsi sono rifiutati.

Quando gli ambiti sono impostati, history:read consente l'anteprima/status e history:delete permette anche la cancellazione. Si applicano restrizioni sia sul token che sul client OAuth. I gettoni legacy senza scopi mantengono il loro accesso al conto esistente.

OAuth2 seleziona la chiave API primaria unica. Se esistono diverse chiavi primarie, inoltre, fornire apikey per selezionare una parte dell'account. Le chiavi secondarie non permettono mai l'accesso alla storia principale chiave.

Leggi la risposta prima di continuare

count_delete è il numero cumulativo rimosso da questa operazione. selected_at_start è la selezione iniziale; protected_at_start conta record esclusi. Utilizzare preview.linked_or_processing per contare i record collegati anche quando 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 con completed=true: finito. Una sola risposta di stato o di anteprima 200 non prova il completamento.
• 400 INVALID_REQUEST_ID: controlla il formato. 404 REQUEST_NOT_FOUND: non esiste alcuna operazione per questo ID, chiave API e storia.
• 401: credenziali non valide o scadute. 403: insufficiente campo OAuth o conto non autorizzato.
• 409 HISTORY_BUSY: un'altra pulizia è in esecuzione; continuare dal client originale. 409 INCLUDE_LINKED_CONFLICT: ripristinare il valore originale include_linked.
• 409 OAUTH_ACCOUNT_AMBIGUOUS: fornire una chiave API appartenente a questo account.
• 503 o interruzione di rete: alcuni lotti possono già essere completati. Controllare la configurazione, quindi riprova con l'originale request_id. Non creare automaticamente un'operazione di sostituzione.