Managing Members
The Vonage CLI can be used to create and manage members of a given conversation. You can read more about conversations and members in the Conversation API documentation.
Create a Member
The vonage members create <conversation-id> command allows you to create members associated with a specific conversation. You can set their details, channels, and audio permissions using the flags below:
Member
| Flag | Description | Type |
|---|---|---|
--state |
Member state | String (Required). Must be one of: "joined", "invited". |
--user-id |
User ID of the member | String |
--user-name |
User name of the member | String |
--knocking-id |
Knocker ID. A knocker is a pre-member of a conversation who does not exist yet | String |
--member-id-inviting |
Member ID of the member that sends the invitation | String |
--from-member-id |
Member ID of the member that sends the invitation | String |
Member Channel
| Flag | Description | Type |
|---|---|---|
--channel-from-type |
Which channel types this member accepts messages from (if not set, all are accepted) | Array (Required). Must be one or more of: "app", "phone", "sms", "mms", "whatsapp", "viber", "messenger" |
--channel-to-user |
The user ID of the member that this member can send messages to. | String |
--channel-to-phone |
The phone number of the member that this member can call. | String |
--channel-from-phone |
The phone number of the member that this member accepts calls from. | String |
--channel-to-sms |
The phone number of the member that this member can send sms messages to. | String |
--channel-to-mms |
The phone number of the member that this member can send mms messages to. | String |
--channel-to-whatsapp |
The phone number of the member that this member can send WhatsApp messages to. | String |
--channel-to-viber |
The id of the member that this member can send viber messages to. | String |
--channel-to-messenger |
The id of the member that this member can send messenger messages to. | String |
Member Audio
| Flag | Description | Type |
|---|---|---|
--audio-enabled |
Audio enabled | Boolean |
--audio-earmuffed |
Audio earmuffed | Boolean |
--audio-muted |
Audio muted | Boolean |
--audio |
Is an audio connection possible | Boolean |
vonage members create `
vonage members create ^
List Members
The vonage members list <conversation-id> command allows you to list all members associated with a given conversation.
vonage members list
vonage members list
Show a Member
The vonage members show <conversation-id> <member-id> command allows you to see all of the details for a given member.
vonage members show
vonage members show
Update a Member
The vonage members update <conversation-id> <member-id> command can be used to update the state of a member in a conversation.
| Flag | Description | Type |
|---|---|---|
--state |
Member state | String. Must be one of: "joined", "invited" |
--reason-code |
The reason code for the update | String |
--reason-text |
The reason text for the update | String |
vonage members update
vonage members update