List Conversations

In this code snippet you learn how to list all Conversations.

Example

Prerequisites

You will need to use an existing Application that contains Conversations in order to receive some results here. 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 list-conversations.sh:

# Gets a list of conversations from an application ID (app ID is in the JWT).
curl "https://api.nexmo.com/v0.3/conversations" \
     -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 list-conversations.sh

Prerequisites

npm install @vonage/server-sdk

Create a file named list-conversations.js and add the following code:

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

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

View full source

Write the code

Add the following to list-conversations.js:

const run = async () => {
  try {
    for await (const conversation of vonage.conversations.listAllConversations()) {
      console.log(conversation);
    }
  } catch (error) {
    console.error(error);
  }
};

run();

View full source

Run your code

Save this file to your machine and run it:

node list-conversations.js

Prerequisites

composer require vonage/client

Create a file named list-conversations.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 list-conversations.php:

$conversations = $client->conversation()->listConversations();

View full source

Run your code

Save this file to your machine and run it:

php list-conversations.php

Try it out

When you run the code you will retrieve a list of all Conversations.