E-post API dokumentation

Hur request_id fungerar

1. Förhandsgranska räkningarna med action=preview. Ingen request_id behövs och inga poster raderas.
2. Skapa en unik request_id för en ny radering, till exempel en UUID. Spara det innan du skickar action=delete.
3. För retries, timeouts eller HTTP 202, återanvända samma API nyckel, historia endpoint, request_id och include_linked värde. Aldrig generera ett nytt ID automatiskt efter ett fel.
4. När completed=true är operationen klar. Återanvändning av ID returnerar samma resultat istället för att ta bort nykomna poster. Använd ett nytt ID endast för en medvetet ny rengöring.

request_id identifierar din radering, inte en enskild SMS. Tillåtet format: 16–128 ASCII-brev, siffror, hyfs eller understruktioner. En UUID som genereras med crypto.randomUID() är lämplig.

Raderingen sker i omgångar. Vid HTTP 202 med continue_required=true ska action=delete upprepas efter 3 sekunder. Inget cron-jobb körs i bakgrunden. action=status läser bara förloppet och fortsätter inte raderingen, även om svaret är HTTP 200.

radering och statusexempel

Byt ut provet request_id med ditt eget unika värde innan du börjar. Följande raderingsförfrågningar ändrar riktig kontohistorik; de är inte förhandsgranskningar.

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 accepterar också action=preview eller action=delete.. POST rekommenderas: URL-parametrar kan läcka in i webbläsarhistorik och serverloggar. Placera aldrig en raderingsadress i en offentlig länk, bild eller prefetch.

För POST, skicka alla parametrar i formkroppen eller ett JSON-objekt, aldrig i fråga strängen. Okända parametrar avvisas; datum eller mobila filter stöds inte.

Autentisering för historia slutpunkter

Använd apikey eller en Authorization: Bearer-åtkomsttoken som utfärdats av SMSMobileAPI OAuth2. Skicka inte en uppdaterad token eller en API-nyckel som en Bearer-token. Utgångna tokens vägras.

När omfattningar är inställda tillåter history:read förhandsgranskning/status och history:delete också radering. Begränsningar på både token och OAuth-klienten gäller. Legacy tokens utan omfattningar behåller sin befintliga kontoåtkomst.

OAuth2 väljer den unika primära API-nyckeln. Om flera primärnycklar finns, ge också apikey att välja en som tillhör kontot. Sekundära nycklar ger aldrig tillgång till den primära nyckelhistorien.

Läs svaret innan du fortsätter

count_delete är det kumulativa numret som tas bort av denna operation. selected_at_start är det första urvalet; protected_at_start räknas exkluderade poster. Användning preview.linked_or_processing räkna länkade poster även när 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 med completed=true: färdig. Enbart 200 förhandsgranskning eller statusrespons bevisar inte slutförandet.
• 400 INVALID_REQUEST_ID: Kontrollera formatet. 404 REQUEST_NOT_FOUND: Ingen operation existerar för denna ID, API nyckel och historia.
• 401: ogiltig eller utgången referenser. 403: otillräcklig OAuth-omfattning eller obehörigt konto.
• 409 HISTORY_BUSY: en annan rengöring körs; fortsätt den från den ursprungliga klienten. 409 INCLUDE_LINKED_CONFLICT: återställa det ursprungliga include_linked-värdet.
• 409 OAUTH_ACCOUNT_AMBIGUOUS: ge en API-nyckel som tillhör detta konto.
• 503 eller nätverksavbrott: vissa partier kan redan slutföras. Konfiguration, sedan retry med den ursprungliga request_id. Skapa inte en ersättningsoperation automatiskt.