List a User's Conversations

In this code snippet you learn how to get a list of Conversations a User is associated with.

Example

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

Key Description
USER_ID The unique ID of the User.

Prerequisites

You will need to use an existing Application containing at least one Conversation and one User in order to see a list of a User's Conversations. See the Create Conversation code snippet for information on how to create an Application and a Conversation. See also the Create User code snippet on how to create a User.

Write the code

Add the following to list-user-conversations.sh:

curl "https://api.nexmo.com/beta/users/$USER_ID/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-user-conversations.sh

Prerequisites

You will need to use an existing Application containing at least one Conversation and one User in order to see a list of a User's Conversations. See the Create Conversation code snippet for information on how to create an Application and a Conversation. See also the Create User code snippet on how to create a User.

npm install @vonage/server-sdk@beta

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

vonage.users.getConversations(USER_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-user-conversations.js

Try it out

When you run the code you will get a list of Conversations associated with the specified User.

In this case the User is associated with a single Conversation:

[
  {
    "name": "mega_chat",
    "timestamp": {
      "created": "2018-10-18T13:28:14.760Z"
    },
    "image_url": "",
    "display_name": "Mega Chat Room",
    "state": "JOINED",
    "member_id": "MEM-62667429-e0fa-4adb-87a9-b4768fd46fce",
    "sequence_number": 8,
    "href": "https://api.nexmo.com/beta/users/USR-ebf6ca49-4941-4762-b7a6-c30cb0c06179/conversations/CON-0b72410c-e090-45b2-86b7-65ff0c986c02",
    "id": "CON-0b72410c-e090-45b2-86b7-65ff0c986c02"
  }
]