Sähköposti API-dokumentaatio

Miten request_id vaikuttaa

1. Esikatsele lukuja action=preview: llä. request_id:ää ei tarvita eikä tietueita poisteta.
2. Luo ainutlaatuinen request_id uuden poiston, esimerkiksi UUID. Tallenna se ennen action=delete:n lähettämistä.
3. ennallistamis-, aikakatkaisu- tai HTTP 202, uudelleenkäyttäydy samalla tavalla API avain, historian päätetapahtuma, request_id sekä include_linked arvo. Älä koskaan luo uutta tunnistetta automaattisesti virheen jälkeen.
4. Kun completed=true, operaatio on päättynyt. Henkilötunnuksen uudelleenkäyttö palauttaa saman tuloksen sen sijaan, että poistaisi uudet tietueet. Käytä uutta henkilökorttia vain tarkoituksella uuteen siivoukseen.

request_id tunnistaa poistotoimintosi, ei yksittäinen SMS. Sallittu muoto: 16...128 ASCII kirjaimet, numerot, väliviivat tai alleviivat. UUID:n generoitu salauksella.randomUID() sopii hyvin.

Poisto etenee erissä. Jos vastaus on HTTP 202 ja continue_required=true, toista action=delete 3 sekunnin kuluttua. Taustalla ei suoriteta cron-tehtävää. action=status vain lukee edistymisen eikä jatka poistoa, vaikka vastaus olisi HTTP 200.

Esimerkki:

Vaihda näyte request_id:lle oma ainutlaatuinen arvosi ennen kuin aloitat. Seuraava poistaa pyynnöt muuttaa todellista tilin historia; ne eivät ole esikatseluja.

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 hyväksyy myös action=preview:n tai action=delete:n. POST suositellaan: URL-parametrit voivat vuotaa selaimen historiaan ja palvelinlokiin. Älä koskaan aseta poisto-osoitetta julkiseen linkkiin, kuva tai prefetch.

Lähetä POST:lle kaikki parametrit muodossa keho tai JSON:n objekti, älä koskaan kyselyn merkkijonossa. Tuntematon parametreja hylätään; päivämäärä tai liikkuvia suodattimia ei tueta.

Historiallisten päätetapahtumien todentaminen

Käyttö apikey tai Authorization: Bearer kulkutunnus, jonka on antanut SMSMobileAPI OAuth2. Älä lähetä virkistävää kuponkia tai API avain Bearer -Ei. Vanhentuneet kuponkit hylätään.

Kun ulottuvuudet on asetettu, history:read mahdollistaa esikatselun/statuksen ja history:delete myös poiston. Sekä token että OAuth-asiakkaan rajoituksia sovelletaan. Perintö rahakkeita ilman soveltamisalaa säilyttää niiden nykyinen tili pääsy.

OAuth2 valitsee ainutlaatuisen ensisijaisen API-avain. Jos on olemassa useita ensisijaisia avaimia, anna apikey myös valita yksi tilin. Toissijaiset avaimet eivät koskaan anna pääsyä ensisijaisen avainhistorian.

Lue vastaus ennen kuin jatkat

count_delete on tämän operaation poistama kumulatiivinen numero. selected_at_start on ensimmäinen valinta; protected_at_start laskee pois tietueita. Käytä preview.linked_or_processing:ää laskeaksesi linkitettyjä tietueita myös include_linked=1:n aikana.

{
    "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: valmis. 200 esikatselu tai tilavaste ei yksin todista valmistumista.
• 400 INVALID_REQUEST_ID: tarkista muoto. 404 REQUEST_NOT_FOUND: tälle ID:lle, API-avaimelle ja historialle ei ole olemassa operaatiota.
• 401: pätemättömät tai vanhentuneet tunnukset. 403: riittämätön OAuth-alue tai luvaton tili.
• 409 HISTORY_BUSY: toinen puhdistus on käynnissä; jatka sitä alkuperäisestä asiakkaasta. 409 INCLUDE_LINKED_CONFLICT: Palauta alkuperäinen include_linked-arvo.
• 409 OAUTH_ACCOUNT_AMBIGUOUS: anna tälle tilille kuuluva API-avain.
• 503 tai verkon keskeytys: jotkut erät voidaan jo täyttää. Tarkista asetukset ja yritä sitten uudelleen alkuperäisen request_id:n kanssa. Älä luo korvaavaa toimintoa automaattisesti.