Create a Member

In this code snippet you learn how to create a Member. A Member can be thought of as a User who has been invited to, joined, or left a 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.
`USER_ID`	The unique ID of the User.

Prerequisites

You will need to use an existing Application that contains a Conversation in order to be able to create a Member. 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 create-member.sh:

curl -X "POST" "https://api.nexmo.com/v1/conversations/$CONV_ID/members" \
     -H 'Authorization: Bearer '$JWT\
     -H 'Content-Type: application/json' \
     -d $'{
  "user": {
    "id": "'$CONV_USER_ID'"
  },
  "state": "'$CONV_MEMBER_STATE'",
  "channel": {
    "type": "app"
  }
}'

View full source

Run your code

Save this file to your machine and run it:

bash create-member.sh

Prerequisites

npm install @vonage/server-sdk

Create a file named create-member.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 create-member.js:


const run = async () => {
  const member = vonage.conversations.createMember(
    CONV_ID,
    {
      user: {
        id: CONV_USER_ID,
      },
      state: CONV_MEMBER_STATE,
      channel: {
        type:'app',
      },
    },
  );
  console.log(member);

View full source

Run your code

Save this file to your machine and run it:

node create-member.js

Prerequisites

Add the following to build.gradle:

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

Create a class named CreateMember 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 CreateMember class:

var member = client.getConversationsClient().createMember(
        CONV_ID, Member.builder()
                .channelType(ChannelType.APP)
                .state(CONV_MEMBER_STATE)
                .user(USER_ID)
                .build()
);
System.out.println(member);

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 CreateMember:

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

Prerequisites

Install-Package Vonage

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

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

View full source

Add the following to CreateMember.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 CreateMember.cs:

var response = await client.ConversationsClient.CreateMemberAsync(CreateMemberRequest.Build()
    .WithConversationId(CONV_ID)
    .WithState(CONV_MEMBER_STATE)
    .WithUser(new MemberUser(CONV_USER_ID, CONV_USER_NAME))
    .WithApp(CONV_USER_ID, ChannelType.App)
    .Create());

View full source

Prerequisites

composer require vonage/client

Create a file named create-member.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 create-member.php:

$channel = new \Vonage\Conversation\ConversationObjects\Channel('app');


$createMemberRequest = new \Vonage\Conversation\ConversationObjects\CreateMemberRequest(
    'invited',
    \Vonage\Conversation\ConversationObjects\Channel::CHANNEL_TYPE_APP,
    USER_ID
);

$client->conversation()->createMember($createMemberRequest, CONVERSATION_ID);

View full source

Run your code

Save this file to your machine and run it:

php create-member.php

Try it out

When you run the code you will create a new Member. The specified User will be invited to join the specified Conversation.