Redact using an ID

In this code snippet you see how to redact a message using an ID

Example

Replace the following variables in the example code:

Key Description
VONAGE_REDACT_ID The ID of the data record that you'd like to redact
VONAGE_REDACT_TYPE The product that the ID belongs to e.g. sms

Prerequisites

npm install @vonage/server-sdk

Create a file named transaction.js and add the following code:

Copy to Clipboard
const Vonage = require('@vonage/server-sdk');

const vonage = new Vonage({
  apiKey: VONAGE_API_KEY,
  apiSecret: VONAGE_API_SECRET
});

View full source

Write the code

Add the following to transaction.js:

Copy to Clipboard
vonage.redact.transaction(NEXMO_REDACT_ID, NEXMO_REDACT_TYPE, (err) => {
  if(err) {
    console.error(err);
  }
  // On success the API returns a 204, so there is no response
});

View full source

Run your code

Save this file to your machine and run it:

node transaction.js

Prerequisites

Add the following to `build.gradle`:

compile 'com.vonage:client:5.5.0'

Create a class named RedactATransaction and add the following code to the main method:

Copy to Clipboard
VonageClient client = VonageClient.builder()
        .apiKey(VONAGE_API_KEY)
        .apiSecret(VONAGE_API_SECRET)
        .build();

View full source

Write the code

Add the following to the main method of the RedactATransaction class:

Copy to Clipboard
RedactClient redactClient = client.getRedactClient();

redactClient.redactTransaction(VONAGE_REDACT_ID, VONAGE_REDACT_PRODUCT);

View full source

Run your code

We can use the application plugin for Gradle to simplify the running of our application. Update your build.gradle with the following:

Copy to Clipboard
  apply plugin: 'application'
  mainClassName = project.hasProperty('main') ? project.getProperty('main') : ''

Run the following gradle command to execute your application, replacing com.vonage.quickstart.redact with the package containing RedactATransaction:

gradle run -Pmain=com.vonage.quickstart.redact.RedactATransaction

Prerequisites

Install-Package Vonage

Create a file named RedactTransaction.cs and add the following code:

Copy to Clipboard
using Vonage;
using Vonage.Redaction;
using Vonage.Request;

View full source

Add the following to RedactTransaction.cs:

Copy to Clipboard
var credentials = Credentials.FromApiKeyAndSecret(VONAGE_API_KEY, VONAGE_API_SECRET);
var client = new VonageClient(credentials);

View full source

Write the code

Add the following to RedactTransaction.cs:

Copy to Clipboard
var request = new RedactRequest() { Id = VONAGE_REDACT_ID, Type = VONAGE_REDACT_TYPE, Product = VONAGE_REDACT_PRODUCT };
var response = client.RedactClient.Redact(request);

View full source

Prerequisites

composer require vonage/client

Create a file named redact.php and add the following code:

Copy to Clipboard
$basic  = new \Vonage\Client\Credentials\Basic(VONAGE_API_KEY, VONAGE_API_SECRET);
$client = new \Vonage\Client($basic);

View full source

Write the code

Add the following to redact.php:

Copy to Clipboard
// This request returns a 204 on success, and throws on error
$client->redact()->transaction(VONAGE_REDACT_ID, VONAGE_REDACT_TYPE);

View full source

Run your code

Save this file to your machine and run it:

php redact.php

Prerequisites

gem install vonage

Create a file named redact.rb and add the following code:

Copy to Clipboard
client = Vonage::Client.new(
  api_key: VONAGE_API_KEY,
  api_secret: VONAGE_API_SECRET
)

View full source

Write the code

Add the following to redact.rb:

Copy to Clipboard
client.redact.transaction(
  id: VONAGE_REDACT_ID,
  product: VONAGE_REDACT_TYPE
)

View full source

Run your code

Save this file to your machine and run it:

ruby redact.rb