List Members

In this code snippet you learn how to list the Members of 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.

Prerequisites

You will need to use an existing Application that contains a Conversation and at least one Member in order to be able to list Members. 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-members.sh:

curl "https://api.nexmo.com/v0.3/conversations/$CONVERSATION_ID/members" \
     -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-members.sh

Prerequisites

npm install @vonage/server-sdk

Create a file named list-members.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-members.js:

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

run();

View full source

Run your code

Save this file to your machine and run it:

node list-members.js

Prerequisites

composer require vonage/client

Create a file named list-members.php and add the following code:

use Vonage\Conversation\ConversationObjects\CreateConversationRequest;
use Vonage\Conversation\ConversationObjects\UpdateConversationRequest;

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-members.php:

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

View full source

Run your code

Save this file to your machine and run it:

php list-members.php

Try it out

When you run the code you will retrieve a list of all Members of the specified Conversation.