Kennisgeving API documentatie

Hoe werkt request_id?

1. Bekijk de tellingen met action=preview. Er is geen request_id nodig en er worden geen records verwijderd.
2. Genereer een unieke request_id voor een nieuwe verwijdering, bijvoorbeeld een UUID. Bewaar het voordat u action=delete verstuurt.
3. Voor retrieves, timeouts of HTTP 202, hergebruikt u dezelfde API-toets, geschiedeniseindpunt, request_id en include_linked-waarde. Maak nooit automatisch een nieuw ID na een fout.
4. Wanneer completed=true, de bewerking is voltooid. Het hergebruik van zijn ID geeft hetzelfde resultaat terug in plaats van het verwijderen van nieuw aangekomen records. Gebruik een nieuw ID alleen voor een opzettelijk nieuwe opruiming.

request_id identificeert uw verwijderingsoperatie, niet een individuele SMS. Toegestaan formaat: 16 Een UUID gegenereerd met crypto.randomUUID() is geschikt.

Het wissen gebeurt in batches. Bij HTTP 202 met continue_required=true herhaalt u action=delete na 3 seconden. Er is geen achtergrondcron. action=status leest alleen de voortgang en hervat het wissen niet, ook niet bij HTTP 200.

Verwijdering en statusvoorbeelden

Vervang het monster request_id door uw eigen unieke waarde voordat u begint. De volgende verzoeken verwijderen wijzigen de werkelijke accountgeschiedenis; het zijn geen previews.

curl -X POST "https://api.smsmobileapi.com/delete-history-notifications/" \
  --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-notifications/" \
  -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-notifications/" \
  --data-urlencode "apikey=YOUR_API_KEY" \
  -d "action=status" \
  -d "request_id=6d54ac58-41f1-4fbc-9a39-6e6c86089451"

GET accepteert ook action=preview of action=delete. POST wordt aanbevolen: URL parameters kunnen lekken in browsergeschiedenis en server logs. Plaats nooit een verwijderen URL in een publieke link, afbeelding of prefetch.

Stuur voor POST alle parameters in de vormtekst of een JSON-object, nooit in de query string. Onbekende parameters worden geweigerd; datum- of mobiele filters worden niet ondersteund.

Authenticatie voor eindpunten in de geschiedenis

Gebruik apikey of een Authorization: Bearer toegangs token uitgegeven door SMSMobileAPI OAuth2. Stuur geen verversings token of een API-sleutel als Bearer token. Verlopen tokens worden geweigerd.

Wanneer scopes zijn ingesteld, history:read staat preview/status en history:delete ook verwijdering toe. Beperkingen op zowel de token als OAuth client gelden. Legacy tokens zonder toepassingsgebied behouden hun bestaande account toegang.

OAuth2 selecteert de unieke primaire API sleutel. Als er meerdere primaire sleutels bestaan, geef dan ook apikey om er een te selecteren die bij de account hoort. Secundaire sleutels geven nooit toegang tot de primaire sleutelgeschiedenis.

Lees de reactie voordat u doorgaat

count_delete is het cumulatieve getal dat door deze bewerking wordt verwijderd. selected_at_start is de eerste selectie; protected_at_start telt uitgesloten records. Gebruik preview.linked_or_processing om gekoppelde records te tellen, zelfs wanneer include_linked=1.

{
    "result": {
        "error": 0,
        "history": "notifications",
        "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 met completed=true: afgewerkt. Een 200-vooruitblik of statusrespons alleen is niet compleet.
• 400 INVALID_REQUEST_ID: controleer het formaat. 404 REQUEST_NOT_FOUND: er bestaat geen bewerking voor deze ID, API sleutel en geschiedenis.
• 401: ongeldige of verlopen referenties. 403: onvoldoende OAuth-scope of onbevoegde account.
• 409 HISTORY_BUSY: er wordt weer een opruiming uitgevoerd; ga door met de oorspronkelijke client. 409 INCLUDE_LINKED_CONFLICT: herstel de originele include_linked waarde.
• 409 OAUTH_ACCOUNT_AMBIGUOUS: lever een API sleutel die bij dit account hoort.
• 503 of netwerkonderbreking: sommige batches kunnen al zijn voltooid. Controleer de configuratie en probeer het opnieuw met de originele request_id. Maak geen automatische vervanging aan.