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/v0.3/conversations/$CONVERSATION_ID/members" \
     -H 'Authorization: Bearer '$JWT\
     -H 'Content-Type: application/json' \
     -d $'{
  "user_id": "'$USER_ID'",
  "action": "invite",
  "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_APPLICATION_PRIVATE_KEY_PATH,
});

View full source

Write the code

Add the following to create-member.js:

const run = async () => {
  const member = vonage.conversations.createMember(
    CONVERSATION_ID,
    {
      'action': 'join',
      'userId': USER_ID,
      'channel': {
        'type':'app',
      },
    },
  );
  console.log(member);
};

run();

View full source

Run your code

Save this file to your machine and run it:

node create-member.js

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.