Delete a Conversation

In this code snippet you learn how to delete a specified Conversation.

Example

Ensure the following variables are set to your required values using any convenient method:

Key	Description
`CONVERSATION_ID`	The ID of the Conversation to be deleted.

Prerequisites

You will need to use an existing Application that contains Conversations in order to be able to delete one. See the Create Conversation code snippet for information on how to create an Application and some sample Conversations.

Write the code

Add the following to delete-conversation.sh:

curl -X "DELETE" "https://api.nexmo.com/v1/conversations/$CONV_ID" \
     -H 'Authorization: Bearer '$JWT\
     -H 'Content-Type: application/json'

View full source

Run your code

Save this file to your machine and run it:

bash delete-conversation.sh

Prerequisites

npm install @vonage/server-sdk

Create a file named delete-conversation.js and add the following code:

const { Vonage } = require('@vonage/server-sdk');

const vonage = new Vonage({
  applicationId: VONAGE_APPLICATION_ID,
  privateKey: VONAGE_PRIVATE_KEY,
});

View full source

Write the code

Add the following to delete-conversation.js:

vonage.conversations.deleteConversation(CONV_ID)
  .then(() => console.log('Conversation deleted'))
  .catch((error) => console.error(error));

View full source

Run your code

Save this file to your machine and run it:

node delete-conversation.js

Prerequisites

Add the following to build.gradle:

implementation 'com.vonage:server-sdk:9.3.1'

Create a file named DeleteConversation and add the following code to the main method:

VonageClient client = VonageClient.builder()
        .applicationId(VONAGE_APPLICATION_ID)
        .privateKeyPath(VONAGE_PRIVATE_KEY_PATH)
        .build();

View full source

Write the code

Add the following to the main method of the DeleteConversation file:

client.getConversationsClient().deleteConversation(CONV_ID);

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:

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

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

gradle run -Pmain=com.vonage.quickstart.conversation.DeleteConversation

Prerequisites

Install-Package Vonage

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

using System;
using System.Threading.Tasks;
using Newtonsoft.Json;
using Vonage;
using Vonage.Conversations.DeleteConversation;
using Vonage.Request;

View full source

Add the following to DeleteConversation.cs:

var credentials = Credentials.FromAppIdAndPrivateKeyPath(VONAGE_APPLICATION_ID, VONAGE_PRIVATE_KEY_PATH);
var client = new VonageClient(credentials);

View full source

Write the code

Add the following to DeleteConversation.cs:

var response = await client.ConversationsClient.DeleteConversationAsync(DeleteConversationRequest.Parse(CONV_ID));

View full source

Prerequisites

composer require vonage/client

Create a file named delete-conversation.php and add the following code:

use Vonage\Conversation\ConversationObjects\CreateConversationRequest;

require_once __DIR__ . '../../config.php';
require_once __DIR__ . '../../vendor/autoload.php';

$keypair = new \Vonage\Client\Credentials\Keypair(
    file_get_contents(VONAGE_APPLICATION_PRIVATE_KEY_PATH),
    VONAGE_APPLICATION_ID
);

$client = new \Vonage\Client($keypair);

View full source

Write the code

Add the following to delete-conversation.php:

$client->conversation()->deleteConversationById(CONVERSATION_ID);

View full source

Run your code

Save this file to your machine and run it:

php delete-conversation.php

Try it out

When you run the code you will delete the specified Conversation.