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.
Opérations disponibles
Authentification
| Clé | Description | Où | Exemple |
|---|---|---|---|
| Authorization | Clé et secret de l'API encodés en Base64 et reliés par deux points. | Headers | Basic <base64> |
209ab3c7536542b91e8b5aef032f6861The transaction ID to redact
smsProduct name that the ID provided relates to
smsvoicenumber-insightverifyverify-sdkmessagesoutboundoutboundRequired if redacting SMS data
inboundoutboundExemple Demande
{
"id": "209ab3c7536542b91e8b5aef032f6861",
"product": "sms",
"type": "outbound"
}{
"id": "209ab3c7536542b91e8b5aef032f6861",
"product": "sms",
"type": "outbound"
}Erreurs
Voici une liste non exhaustive des codes d'erreur susceptibles de se produire lors de l'utilisation de cette API.
Ces codes s'ajoutent à ceux de notre site codes d'erreur génériques.
| Code | Informations |
|---|---|
| invalid-product | Description The provided product is invalid Résolution Modify your request to provide a valid product |
| premature-redaction | Description There is a 1 hour time period before data can be redacted to allow for all data to propagate through the Vonage system Résolution Wait until the data becomes valid for redaction |
| rate-limit | Description The request was rate limited Résolution The Redact API supports 170 requests per second. Slow down your request rate |