Redact API

The Redact API helps organisations meet their privacy compliance obligations. It provides controlled, on-demand redaction of private information from transactional records in the long-term storage. Note, Redact API does not have the capability to redact the short-lived server logs that are retained for a few weeks. For SMS customers that need immediate redaction, Vonage suggests using Advanced Auto-redact.

OpenAPI-Spezifikation herunterladen
Verfügbare Operationen

Redact a specific message

posthttps://api.nexmo.com/v1/redact/transaction

Authentifizierung

SchlüsselBeschreibungWoBeispiel
Authorization

Base64-kodierter API-Schlüssel und Geheimnis, verbunden durch einen Doppelpunkt.
Mehr lesen

Headers

Basic <base64>

Anfrage Körper
Inhalt Typ
application/json

id
string
Erforderlich
Beispiel209ab3c7536542b91e8b5aef032f6861

The transaction ID to redact

product
string
Erforderlich
Beispielsms

Product name that the ID provided relates to

Muss eines der folgenden sein:smsvoicenumber-insightverifyverify-sdkmessages
type
string
Erforderlich
Standardoutbound
Beispieloutbound

Required if redacting SMS data

Muss eines der folgenden sein:inboundoutbound

Beispiel Anfrage

{
   "id": "209ab3c7536542b91e8b5aef032f6861",
   "product": "sms",
   "type": "outbound"
}

Antworten

Success

Fehler

Im Folgenden finden Sie eine nicht erschöpfende Liste von Fehlercodes, die bei der Verwendung dieser API auftreten können.

Diese Codes gelten zusätzlich zu unseren generische Fehlercodes.

CodeInformationen
invalid-product

Beschreibung

The provided product is invalid

Auflösung

Modify your request to provide a valid product

premature-redaction

Beschreibung

There is a 1 hour time period before data can be redacted to allow for all data to propagate through the Vonage system

Auflösung

Wait until the data becomes valid for redaction

rate-limit

Beschreibung

The request was rate limited

Auflösung

The Redact API supports 170 requests per second. Slow down your request rate