E-mail API dokumentation

Hvordan virker request_id

1. Vis forhåndsvisning af tællingerne med action=previewNej. request_id er nødvendige, og ingen optegnelser er slettet.
2. Generér en unik request_id for en ny sletning, for eksempel en UUID. Gem det før du sender action=delete.
3. til genforsøg, timeouts eller HTTP 202, genbrug det samme API nøgletal, historikendepunkt, request_id og include_linked værdi. Opret aldrig et nyt ID automatisk efter en fejl.
4. Hvornår completed=true, operationen er færdig. Genbrug af sin ID giver det samme resultat i stedet for at slette nyligt ankommet optegnelser. Brug kun et nyt ID til en bevidst ny oprydning.

request_id identificerer din sletning operation, ikke en individuel SMS. Tilladt format: 16-128 ASCII bogstaver, tal, bindestreger eller underpointsum. A UUID genereres med crypto.randomic UID () er egnet.

Sletningen sker i portioner. Ved HTTP 202 med continue_required=true skal action=delete gentages efter 3 sekunder. Der kører intet cron-job i baggrunden. action=status læser kun fremdriften og fortsætter ikke sletningen, heller ikke ved HTTP 200.

Eksempler på sletning og status

Udskift prøven request_id med din egen unikke værdi før start. Følgende slette anmodninger ændre real konto historie; de er ikke previews.

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 accepterer også action=preview eller action=delete. POST anbefales: URL-parametre kan lække ind i browserens historik og serverlogfiler. Placer aldrig en sletning URL i et offentligt link, billede eller pre-hentning.

For POST, send alle parametre i formularen organ eller et JSON objekt, aldrig i forespørgselsstrengen. Ukendt parametre afvises; dato eller mobile filtre understøttes ikke.

Godkendelse af historikendepunkter

Anvendelse apikey eller Authorization: Bearer adgangskort udstedt af SMSMobileAPI OAuth2. Send ikke en genfriskning eller en API nøgle som en Bearer - En token. Udløb tokens er nægtet.

Når der er sat en række områder, history:read tillader forhåndsvisning / status og history:delete giver også mulighed for sletning. Begrænsninger på både token og OAuth klienten ansøge. Legacy tokens uden scope bevarer deres eksisterende konto adgang.

OAuth2 vælger den unikke primære API - nøgle. Hvis flere primære nøgler findes, også give apikey til at vælge en tilhørende kontoen. Sekundære nøgler giver aldrig adgang til den primære nøglehistorie.

Læs svaret før du fortsætter

count_delete er det kumulative antal, der er fjernet ved denne operation. selected_at_start er den oprindelige udvælgelse protected_at_start antal udelukkede registreringer. Anvendelse preview.linked_or_processing til at tælle tilknyttede poster, selv 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. En 200 preview eller status respons alene beviser ikke afslutning.
• 400 INVALID_REQUEST_ID: Kontroller formatet. 404 REQUEST_NOT_FOUND: der findes ingen operation for dette id API Nøgle og historie.
• 401: ugyldige eller udløbne legitimationsoplysninger. 403: utilstrækkelig OAuth omfang eller uautoriseret konto.
• 409 HISTORY_BUSY: en anden oprydning kører; fortsætte det fra den oprindelige klient. 409 INCLUDE_LINKED_CONFLICT: gendannelse af originalen include_linked værdi.
• 409 OAUTH_ACCOUNT_AMBIGUOUS: giv en API-nøgle, der tilhører denne konto.
• 503 eller afbrydelse af nettet: nogle partier kan allerede være færdige. Kontrollér konfiguration, og prøv derefter igen med originalen request_id. Opret ikke en udskiftning operation automatisk.