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.

Descargar la especificación OpenAPI
Operaciones disponibles

Redact a specific message

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

Autenticación

ClaveDescripciónDóndeEjemplo
Authorization

Clave API codificada en Base64 y secreto unidos por dos puntos.
Seguir leyendo

Headers

Basic <base64>

Cuerpo de la solicitud
Tipo de contenido
application/json

id
string
Requerido
ejemplo209ab3c7536542b91e8b5aef032f6861

The transaction ID to redact

product
string
Requerido
ejemplosms

Product name that the ID provided relates to

Debe ser uno de:smsvoicenumber-insightverifyverify-sdkmessages
type
string
Requerido
Por defectooutbound
ejemplooutbound

Required if redacting SMS data

Debe ser uno de:inboundoutbound

Ejemplo Solicitar

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

Respuestas

Success

Errores

La siguiente es una lista no exhaustiva de códigos de error que pueden producirse al utilizar esta API.

Estos códigos se suman a cualquiera de nuestros códigos de error genéricos.

CódigoInformación
invalid-product

Descripción

The provided product is invalid

Resolución

Modify your request to provide a valid product

premature-redaction

Descripción

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

Resolución

Wait until the data becomes valid for redaction

rate-limit

Descripción

The request was rate limited

Resolución

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