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.

Baixar a especificação OpenAPI
Operações disponíveis

Redact a specific message

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

Autenticação

ChaveDescriçãoOndeExemplo
Authorization

Chave e segredo da API codificados em Base64, separados por dois pontos.
Leia mais

Headers

Basic <base64>

Corpo da solicitação
Tipo de conteúdo
application/json

id
string
Obrigatório
exemplo209ab3c7536542b91e8b5aef032f6861

The transaction ID to redact

product
string
Obrigatório
exemplosms

Product name that the ID provided relates to

Deve ser uma das seguintes opções:smsvoicenumber-insightverifyverify-sdkmessagesnetwork-api-eventvonage-qod
type
string
Obrigatório
Padrãooutbound
exemplooutbound

Required if redacting SMS data

Deve ser uma das seguintes opções:inboundoutbound

Exemplo Solicitação

Respostas

Success

Erros

A seguir, apresentamos uma lista não exaustiva de códigos de erro que podem ocorrer durante o uso desta API.

Esses códigos são adicionais aos que constam em nosso site códigos de erro genéricos.

CódigoInformações
invalid-product

Descrição

The provided product is invalid

Resolução

Modify your request to provide a valid product

premature-redaction

Descrição

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

Resolução

Wait until the data becomes valid for redaction

rate-limit

Descrição

The request was rate limited

Resolução

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