Skip to navigation

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.
  • cURL
  • Node.js

    • 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.2/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

    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. 

    npm install @vonage/server-sdk@beta

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

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

const vonage = new Vonage({
  apiKey: VONAGE_API_KEY,
  apiSecret: VONAGE_API_SECRET,
  applicationId: VONAGE_APPLICATION_ID,
  privateKey: VONAGE_APPLICATION_PRIVATE_KEY_PATH
})

    View full source

    Write the code

    Add the following to list-members.js:

    vonage.conversations.members.get(CONVERSATION_ID,
        {},
        (error, result) => {
        if(error) {
            console.error(error);
        }
        else {
            console.log(result);
        }
    });

    View full source

    Run your code

    Save this file to your machine and run it: 

    node list-members.js

    Try it out

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

    Improve this page