;
```
Defined in: [conversations/lib/conversations.ts:667](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/conversations.ts#L667)
Updates an existing member with the provided details.
Setting the state to left will result in the member leaving the conversation.
###### Parameters
###### conversationId
`string`
The conversation id to update the member in.
###### memberId
`string`
The member details to be updated.
###### params
[`UpdateMemberParameters`](#updatememberparameters)
The update parameters.
###### Returns
`Promise`\<[`Member`](#member)\>
- A promise resolving to the updated member.
###### See
API Specification [https://developer.vonage.com/en/api/conversation#updateMember](https://developer.vonage.com/en/api/conversation#updateMember)
###### Example
```ts
import { MemberState } from '@vonage/conversation';
const member = await memberClient.updateMember(
CONVERSATION_ID,
MEMBER_ID,
{
state: MemberState.LEFT,
from: USER_ID,
},
);
console.log(member.name);
```
## Type Aliases
### AnyChannel
```ts
type AnyChannel =
| PhoneNumberChannel
| SipChannel
| AppChannel
| WebSocketChannel
| VbcChannel;
```
Defined in: [conversations/lib/types/anyChannel.ts:7](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/anyChannel.ts#L7)
***
### AnyMessageBody
```ts
type AnyMessageBody =
| MessageASRBody
| MessageChannelBody
| MessageConversationBody
| MessageCustomBody
| MessageEventBody
| MessageFileBody
| MessageImageBody
| MessageLegBody
| MessageLocationBody
| MessageMemberBody
| MessageRTCAnswerBody
| MessageRTCIdBody
| MessageRecordBody
| MessageRecordIdBody
| MessageSIPDirectionBody
| MessageSIPHangupBody
| MessageSIPMachineBody
| MessageSIPStatusBody
| MessageSayBody
| MessageSayIdBody
| MessageStatusBody
| MessageTemplateBody
| MessageTextBody
| MessageVCardBody
| MessageVideoBody
| MessageAudioBody;
```
Defined in: [conversations/lib/types/anyMessageBody.ts:29](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/anyMessageBody.ts#L29)
***
### AnyMessageBodyResponse
```ts
type AnyMessageBodyResponse = { [P in keyof AnyMessageBody as SnakeToCamelCase]: AnyMessageBody[P] };
```
Defined in: [conversations/lib/types/responses/eventResponse.ts:14](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/responses/eventResponse.ts#L14)
***
### AppChannel
```ts
type AppChannel = object;
```
Defined in: [conversations/lib/types/appChannel.ts:6](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/appChannel.ts#L6)
Type representing an app channel.
#### Properties
##### type
```ts
type: APP;
```
Defined in: [conversations/lib/types/appChannel.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/appChannel.ts#L10)
The type of channel (app).
##### user
```ts
user: string;
```
Defined in: [conversations/lib/types/appChannel.ts:15](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/appChannel.ts#L15)
The app user.
***
### ASRResult
```ts
type ASRResult = object;
```
Defined in: [conversations/lib/types/messageASRBody.ts:3](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messageASRBody.ts#L3)
#### Properties
##### confidence
```ts
confidence: number;
```
Defined in: [conversations/lib/types/messageASRBody.ts:12](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messageASRBody.ts#L12)
Confidence of the word
##### word
```ts
word: string;
```
Defined in: [conversations/lib/types/messageASRBody.ts:7](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messageASRBody.ts#L7)
Word recognized
***
### AudioSettings
```ts
type AudioSettings = object;
```
Defined in: [conversations/lib/types/audioSettings.ts:4](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/audioSettings.ts#L4)
Type representing audio settings.
#### Properties
##### earmuffed
```ts
earmuffed: boolean;
```
Defined in: [conversations/lib/types/audioSettings.ts:13](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/audioSettings.ts#L13)
Indicates whether audio is earmuffed.
##### enabled
```ts
enabled: boolean;
```
Defined in: [conversations/lib/types/audioSettings.ts:8](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/audioSettings.ts#L8)
Indicates whether audio is enabled.
##### muted
```ts
muted: boolean;
```
Defined in: [conversations/lib/types/audioSettings.ts:18](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/audioSettings.ts#L18)
Indicates whether audio is muted.
***
### AudioSettingsRequest
```ts
type AudioSettingsRequest = object;
```
Defined in: [conversations/lib/types/requests/createMemberRequest.ts:4](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/requests/createMemberRequest.ts#L4)
#### Properties
##### audio
```ts
audio: boolean;
```
Defined in: [conversations/lib/types/requests/createMemberRequest.ts:23](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/requests/createMemberRequest.ts#L23)
Indicates whether audio is active.
##### earmuffed
```ts
earmuffed: boolean;
```
Defined in: [conversations/lib/types/requests/createMemberRequest.ts:13](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/requests/createMemberRequest.ts#L13)
Indicates whether audio is earmuffed.
##### enabled
```ts
enabled: boolean;
```
Defined in: [conversations/lib/types/requests/createMemberRequest.ts:8](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/requests/createMemberRequest.ts#L8)
Indicates whether audio is enabled.
##### muted
```ts
muted: boolean;
```
Defined in: [conversations/lib/types/requests/createMemberRequest.ts:18](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/requests/createMemberRequest.ts#L18)
Indicates whether audio is muted.
***
### AudioSettingsResponse
```ts
type AudioSettingsResponse = object;
```
Defined in: [conversations/lib/types/responses/memberResponse.ts:6](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/responses/memberResponse.ts#L6)
#### Properties
##### audio
```ts
audio: boolean;
```
Defined in: [conversations/lib/types/responses/memberResponse.ts:25](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/responses/memberResponse.ts#L25)
Indicates whether audio is active.
##### earmuffed
```ts
earmuffed: boolean;
```
Defined in: [conversations/lib/types/responses/memberResponse.ts:15](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/responses/memberResponse.ts#L15)
Indicates whether audio is earmuffed.
##### enabled
```ts
enabled: boolean;
```
Defined in: [conversations/lib/types/responses/memberResponse.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/responses/memberResponse.ts#L10)
Indicates whether audio is enabled.
##### muted
```ts
muted: boolean;
```
Defined in: [conversations/lib/types/responses/memberResponse.ts:20](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/responses/memberResponse.ts#L20)
Indicates whether audio is muted.
***
### Conversation
```ts
type Conversation = object;
```
Defined in: [conversations/lib/types/conversation.ts:8](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/conversation.ts#L8)
Represents a conversation
#### Properties
##### callback?
```ts
optional callback: ConversationCallback;
```
Defined in: [conversations/lib/types/conversation.ts:116](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/conversation.ts#L116)
Callback information (optional).
###### Remarks
This is not set when fetching a converstion from the API.
##### displayName?
```ts
optional displayName: string;
```
Defined in: [conversations/lib/types/conversation.ts:23](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/conversation.ts#L23)
The public-facing name of the conversation.
##### id?
```ts
readonly optional id: string;
```
Defined in: [conversations/lib/types/conversation.ts:13](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/conversation.ts#L13)
The unique identifier for this conversation.
##### imageUrl?
```ts
optional imageUrl: string;
```
Defined in: [conversations/lib/types/conversation.ts:28](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/conversation.ts#L28)
An image URL associated with the conversation.
##### name?
```ts
optional name: string;
```
Defined in: [conversations/lib/types/conversation.ts:18](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/conversation.ts#L18)
Your internal conversation name. Must be unique.
##### numbers?
```ts
optional numbers: AnyChannel[];
```
Defined in: [conversations/lib/types/conversation.ts:108](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/conversation.ts#L108)
Communication channels (optional).
###### Remarks
This is not set when fetching a converstion from the API.
##### properties?
```ts
optional properties: object;
```
Defined in: [conversations/lib/types/conversation.ts:53](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/conversation.ts#L53)
The conversation's properties
###### customData
```ts
customData: Record;
```
Custom key-value pairs to be included with the conversation.
###### customSortKey
```ts
customSortKey: string;
```
The conversation's custom sort key.
###### ttl?
```ts
optional ttl: number;
```
The conversation's time to leave.
After how many seconds the conversation is deleted.
###### type
```ts
type: string;
```
The conversation's type.
##### sequenceNumber?
```ts
readonly optional sequenceNumber: number;
```
Defined in: [conversations/lib/types/conversation.ts:43](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/conversation.ts#L43)
The last Event ID in this conversation.
This ID can be used to retrieve a specific event.
##### state?
```ts
optional state: ConversationState;
```
Defined in: [conversations/lib/types/conversation.ts:48](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/conversation.ts#L48)
The conversation's state.
##### status?
```ts
readonly optional status: ConversationState;
```
Defined in: [conversations/lib/types/conversation.ts:35](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/conversation.ts#L35)
The conversation's status.
##### timestamp?
```ts
readonly optional timestamp: object;
```
Defined in: [conversations/lib/types/conversation.ts:82](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/conversation.ts#L82)
Timestamps for when the conversation was created, updated, and destroyed.
###### created?
```ts
readonly optional created: string;
```
The time the conversation was created.
###### destroyed?
```ts
readonly optional destroyed: string;
```
The time the conversation was destroyed (if applicable).
###### updated?
```ts
readonly optional updated: string;
```
The time the conversation was last updated.
***
### ConversationCallback
```ts
type ConversationCallback = object;
```
Defined in: [conversations/lib/types/conversationCallback.ts:5](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/conversationCallback.ts#L5)
Type representing a callback object in a conversation request.
#### Properties
##### eventMask?
```ts
optional eventMask: string;
```
Defined in: [conversations/lib/types/conversationCallback.ts:14](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/conversationCallback.ts#L14)
The event mask for the callback.
##### method?
```ts
optional method: "POST" | "GET";
```
Defined in: [conversations/lib/types/conversationCallback.ts:34](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/conversationCallback.ts#L34)
The callback method.
##### params?
```ts
optional params: object;
```
Defined in: [conversations/lib/types/conversationCallback.ts:19](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/conversationCallback.ts#L19)
Callback parameters.
###### applicationId?
```ts
optional applicationId: string;
```
The application ID for the callback.
###### nccoUrl?
```ts
optional nccoUrl: string;
```
The NCCO URL for the callback.
##### url?
```ts
optional url: string;
```
Defined in: [conversations/lib/types/conversationCallback.ts:9](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/conversationCallback.ts#L9)
The callback URL.
***
### ConversationCallbackRequest
```ts
type ConversationCallbackRequest = object;
```
Defined in: [conversations/lib/types/requests/conversationCallbackRequest.ts:4](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/requests/conversationCallbackRequest.ts#L4)
Type representing a callback object in a conversation request.
#### Properties
##### event\_mask?
```ts
optional event_mask: string;
```
Defined in: [conversations/lib/types/requests/conversationCallbackRequest.ts:13](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/requests/conversationCallbackRequest.ts#L13)
The event mask for the callback.
##### method
```ts
method: "POST" | "GET";
```
Defined in: [conversations/lib/types/requests/conversationCallbackRequest.ts:33](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/requests/conversationCallbackRequest.ts#L33)
The callback method.
##### params?
```ts
optional params: object;
```
Defined in: [conversations/lib/types/requests/conversationCallbackRequest.ts:18](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/requests/conversationCallbackRequest.ts#L18)
Callback parameters.
###### applicationId?
```ts
optional applicationId: string;
```
The application ID for the callback.
###### ncco\_url?
```ts
optional ncco_url: string;
```
The NCCO URL for the callback.
##### url?
```ts
optional url: string;
```
Defined in: [conversations/lib/types/requests/conversationCallbackRequest.ts:8](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/requests/conversationCallbackRequest.ts#L8)
The callback URL.
***
### ConversationPage
```ts
type ConversationPage = object;
```
Defined in: [conversations/lib/types/conversationPage.ts:7](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/conversationPage.ts#L7)
A page of conversations.
#### Properties
##### conversations
```ts
conversations: Conversation[];
```
Defined in: [conversations/lib/types/conversationPage.ts:16](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/conversationPage.ts#L16)
Conversations for the page.
##### links?
```ts
optional links: Record;
```
Defined in: [conversations/lib/types/conversationPage.ts:21](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/conversationPage.ts#L21)
HAL links for the page.
##### pageSize
```ts
pageSize: number;
```
Defined in: [conversations/lib/types/conversationPage.ts:11](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/conversationPage.ts#L11)
How many items are in the page.
***
### ConversationPageResponse
```ts
type ConversationPageResponse = object & APILinks;
```
Defined in: [conversations/lib/types/responses/conversationPageResponse.ts:7](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/responses/conversationPageResponse.ts#L7)
Represents the response for listing conversations retrieved from the API.
#### Type declaration
##### \_embedded
```ts
_embedded: object;
```
Embedded data containing a list of conversations.
###### \_embedded.conversations
```ts
_embedded.conversations: ConversationResponse[];
```
##### page\_size
```ts
page_size: number;
```
The number of records returned in this response.
***
### ConversationResponse
```ts
type ConversationResponse = object & Omit & APILinks;
```
Defined in: [conversations/lib/types/responses/conversationResponse.ts:7](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/responses/conversationResponse.ts#L7)
Represents a conversation as it is returned from the API.
#### Type declaration
##### display\_name?
```ts
optional display_name: string;
```
The public-facing name of the conversation.
##### image\_url?
```ts
optional image_url: string;
```
An image URL associated with the conversation.
##### properties?
```ts
optional properties: object;
```
The conversation's properties
###### properties.custom\_data
```ts
properties.custom_data: Record;
```
Custom key-value pairs to be included with the conversation.
###### properties.custom\_sort\_key
```ts
properties.custom_sort_key: string;
```
The conversation's custom sort key.
###### properties.ttl?
```ts
optional properties.ttl: number;
```
The conversation's time to leave.
After how many seconds the conversation is deleted.
###### properties.type
```ts
properties.type: string;
```
The conversation's type.
##### sequence\_number
```ts
sequence_number: number;
```
The last Event ID in this conversation. This ID can be used to retrieve a specific event.
***
### CreateConversationRequest
```ts
type CreateConversationRequest = object;
```
Defined in: [conversations/lib/types/requests/createConversationRequest.ts:11](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/requests/createConversationRequest.ts#L11)
Type representing a request to create a conversation.
#### Properties
##### callback?
```ts
optional callback: ConversationCallbackRequest;
```
Defined in: [conversations/lib/types/requests/createConversationRequest.ts:67](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/requests/createConversationRequest.ts#L67)
Callback information (optional).
##### display\_name
```ts
display_name: string;
```
Defined in: [conversations/lib/types/requests/createConversationRequest.ts:20](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/requests/createConversationRequest.ts#L20)
The public-facing name of the conversation.
##### image\_url
```ts
image_url: string;
```
Defined in: [conversations/lib/types/requests/createConversationRequest.ts:25](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/requests/createConversationRequest.ts#L25)
An image URL associated with the conversation.
##### name
```ts
name: string;
```
Defined in: [conversations/lib/types/requests/createConversationRequest.ts:15](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/requests/createConversationRequest.ts#L15)
Your internal conversation name.
##### numbers?
```ts
optional numbers: (
| PhoneNumberChannel
| SipChannel
| AppChannel
| WebSocketChannel
| VbcChannel)[];
```
Defined in: [conversations/lib/types/requests/createConversationRequest.ts:56](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/requests/createConversationRequest.ts#L56)
Communication channels (optional).
##### properties?
```ts
optional properties: object;
```
Defined in: [conversations/lib/types/requests/createConversationRequest.ts:30](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/requests/createConversationRequest.ts#L30)
Conversation properties (optional).
###### custom\_data?
```ts
optional custom_data: Record;
```
Custom data as key-value pairs (optional).
###### custom\_sort\_key?
```ts
optional custom_sort_key: string;
```
Custom sort key (optional).
###### ttl?
```ts
optional ttl: number;
```
Time to leave in seconds for an empty conversation (optional).
###### type?
```ts
optional type: string;
```
Custom conversation type (optional).
***
### CreateEventRequest
```ts
type CreateEventRequest = object & Pick;
```
Defined in: [conversations/lib/types/requests/createEventRequest.ts:4](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/requests/createEventRequest.ts#L4)
#### Type declaration
##### body
```ts
body: AnyMessageBodyResponse;
```
***
### CreateMemberRequest
```ts
type CreateMemberRequest = object;
```
Defined in: [conversations/lib/types/requests/createMemberRequest.ts:29](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/requests/createMemberRequest.ts#L29)
A Member as its sent to the API
#### Properties
##### channel
```ts
channel: AnyChannel;
```
Defined in: [conversations/lib/types/requests/createMemberRequest.ts:53](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/requests/createMemberRequest.ts#L53)
The channel associated with the member.
##### from
```ts
from: string;
```
Defined in: [conversations/lib/types/requests/createMemberRequest.ts:83](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/requests/createMemberRequest.ts#L83)
The user who invited the member.
##### knocking\_id
```ts
knocking_id: string;
```
Defined in: [conversations/lib/types/requests/createMemberRequest.ts:73](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/requests/createMemberRequest.ts#L73)
The knocking ID for the member.
##### media
```ts
media: object;
```
Defined in: [conversations/lib/types/requests/createMemberRequest.ts:58](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/requests/createMemberRequest.ts#L58)
Media-related information for the member.
###### audio
```ts
audio: boolean;
```
Indicates whether the member has audio.
###### audio\_settings
```ts
audio_settings: AudioSettingsRequest;
```
Audio settings for the member.
##### member\_id\_inviting
```ts
member_id_inviting: string;
```
Defined in: [conversations/lib/types/requests/createMemberRequest.ts:78](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/requests/createMemberRequest.ts#L78)
The member who invited the member.
##### state
```ts
state: MemberState;
```
Defined in: [conversations/lib/types/requests/createMemberRequest.ts:33](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/requests/createMemberRequest.ts#L33)
The member's state
##### user
```ts
user: object;
```
Defined in: [conversations/lib/types/requests/createMemberRequest.ts:38](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/requests/createMemberRequest.ts#L38)
The matching user for this member.
###### id
```ts
id: string;
```
The user's ID.
###### name
```ts
name: string;
```
The user's name.
***
### Event
```ts
type Event = object;
```
Defined in: [conversations/lib/types/event.ts:5](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/event.ts#L5)
#### Properties
##### body
```ts
body: AnyMessageBody;
```
Defined in: [conversations/lib/types/event.ts:24](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/event.ts#L24)
Data of the event.
##### from
```ts
from: string;
```
Defined in: [conversations/lib/types/event.ts:19](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/event.ts#L19)
Member ID of the event.
##### fromMember?
```ts
optional fromMember: object;
```
Defined in: [conversations/lib/types/event.ts:39](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/event.ts#L39)
Sender Memeber
###### id
```ts
id: string;
```
Member ID
##### fromUser?
```ts
optional fromUser: EventUser;
```
Defined in: [conversations/lib/types/event.ts:34](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/event.ts#L34)
Sender User
##### id
```ts
id: number;
```
Defined in: [conversations/lib/types/event.ts:9](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/event.ts#L9)
The ID of the message.
##### timestamp?
```ts
optional timestamp: string;
```
Defined in: [conversations/lib/types/event.ts:29](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/event.ts#L29)
Timestamp of the event.
##### type
```ts
type: EventType;
```
Defined in: [conversations/lib/types/event.ts:14](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/event.ts#L14)
Message type
***
### EventPage
```ts
type EventPage = object;
```
Defined in: [conversations/lib/types/eventPage.ts:4](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/eventPage.ts#L4)
#### Properties
##### events
```ts
events: Event[];
```
Defined in: [conversations/lib/types/eventPage.ts:13](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/eventPage.ts#L13)
Embedded events.
##### links?
```ts
optional links: Record;
```
Defined in: [conversations/lib/types/eventPage.ts:18](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/eventPage.ts#L18)
Links to other resources.
##### pageSize
```ts
pageSize: number;
```
Defined in: [conversations/lib/types/eventPage.ts:8](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/eventPage.ts#L8)
The number of items returned on this page.
***
### EventPageResponse
```ts
type EventPageResponse = object & APILinks;
```
Defined in: [conversations/lib/types/responses/eventPageResponse.ts:4](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/responses/eventPageResponse.ts#L4)
#### Type declaration
##### \_embedded
```ts
_embedded: EventResponse[];
```
Embedded events.
##### page\_size
```ts
page_size: number;
```
The number of items returned on this page.
***
### EventResponse
```ts
type EventResponse = object & Omit & APILinks;
```
Defined in: [conversations/lib/types/responses/eventResponse.ts:18](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/responses/eventResponse.ts#L18)
#### Type declaration
##### \_embedded
```ts
_embedded: object;
```
###### \_embedded.from\_member
```ts
_embedded.from_member: object;
```
###### \_embedded.from\_member.id
```ts
_embedded.from_member.id: string;
```
###### \_embedded.from\_user
```ts
_embedded.from_user: EventUserResponse;
```
##### body
```ts
body: AnyMessageBodyResponse;
```
***
### EventUser
```ts
type EventUser = object;
```
Defined in: [conversations/lib/types/eventUser.ts:1](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/eventUser.ts#L1)
#### Properties
##### customData?
```ts
optional customData: Record;
```
Defined in: [conversations/lib/types/eventUser.ts:25](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/eventUser.ts#L25)
The user's custom data.
##### displayName
```ts
displayName: string;
```
Defined in: [conversations/lib/types/eventUser.ts:15](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/eventUser.ts#L15)
The user's display name.
##### id
```ts
id: string;
```
Defined in: [conversations/lib/types/eventUser.ts:5](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/eventUser.ts#L5)
The user's ID.
##### imageUrl?
```ts
optional imageUrl: string;
```
Defined in: [conversations/lib/types/eventUser.ts:20](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/eventUser.ts#L20)
The user's avatar URL.
##### name
```ts
name: string;
```
Defined in: [conversations/lib/types/eventUser.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/eventUser.ts#L10)
The user's name.
***
### EventUserResponse
```ts
type EventUserResponse = object & Omit;
```
Defined in: [conversations/lib/types/responses/eventResponse.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/responses/eventResponse.ts#L10)
#### Type declaration
##### display\_name
```ts
display_name: string;
```
***
### InitiatorInvited
```ts
type InitiatorInvited = object;
```
Defined in: [conversations/lib/types/member.ts:31](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/member.ts#L31)
#### Properties
##### invited
```ts
invited: object;
```
Defined in: [conversations/lib/types/member.ts:35](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/member.ts#L35)
Details about the initiator when the member invited.
###### isSystem
```ts
isSystem: boolean;
```
true if the user was invited by an admin JWT
***
### InitiatorInvitedResponse
```ts
type InitiatorInvitedResponse = object;
```
Defined in: [conversations/lib/types/responses/memberResponse.ts:56](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/responses/memberResponse.ts#L56)
Type representing the invited initiator as its returned from the API.
#### Properties
##### invited
```ts
invited: object;
```
Defined in: [conversations/lib/types/responses/memberResponse.ts:60](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/responses/memberResponse.ts#L60)
Details about the initiator when the member invited.
###### is\_system
```ts
is_system: boolean;
```
true if the user was invited by an admin JWT
***
### InitiatorJoined
```ts
type InitiatorJoined = object;
```
Defined in: [conversations/lib/types/member.ts:9](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/member.ts#L9)
Type representing the joined initiator.
#### Properties
##### joined
```ts
joined: object;
```
Defined in: [conversations/lib/types/member.ts:13](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/member.ts#L13)
Details about the initiator when the member joined.
###### isSystem
```ts
isSystem: boolean;
```
true if the user was invited by an admin JWT
###### memberId
```ts
memberId: string;
```
The member ID of the initiator.
###### userId
```ts
userId: string;
```
The user ID of the initiator.
***
### InitiatorJoinedResponse
```ts
type InitiatorJoinedResponse = object;
```
Defined in: [conversations/lib/types/responses/memberResponse.ts:31](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/responses/memberResponse.ts#L31)
Type representing the joined initiator as its returned from the API.
#### Properties
##### joined
```ts
joined: object;
```
Defined in: [conversations/lib/types/responses/memberResponse.ts:35](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/responses/memberResponse.ts#L35)
Details about the initiator when the member joined.
###### is\_system
```ts
is_system: boolean;
```
true if the user was invited by an admin JWT
###### member\_id
```ts
member_id: string;
```
The member ID of the initiator.
###### user\_id
```ts
user_id: string;
```
The user ID of the initiator.
***
### LegState
```ts
type LegState = object;
```
Defined in: [conversations/lib/types/messageLegBody.ts:5](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messageLegBody.ts#L5)
#### Properties
##### reason?
```ts
optional reason: ReasonCode;
```
Defined in: [conversations/lib/types/messageLegBody.ts:19](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messageLegBody.ts#L19)
Reason code of the message leg
##### status
```ts
status: LegStatus;
```
Defined in: [conversations/lib/types/messageLegBody.ts:9](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messageLegBody.ts#L9)
Status of the message leg
##### succssful?
```ts
optional succssful: boolean;
```
Defined in: [conversations/lib/types/messageLegBody.ts:14](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messageLegBody.ts#L14)
If the leg is successful
***
### ListConversationsParameters
```ts
type ListConversationsParameters = object;
```
Defined in: [conversations/lib/types/parameters/listConversationsParameters.ts:4](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/parameters/listConversationsParameters.ts#L4)
Represents the query parameters for listing conversations.
#### Properties
##### byUser?
```ts
optional byUser: string;
```
Defined in: [conversations/lib/types/parameters/listConversationsParameters.ts:39](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/parameters/listConversationsParameters.ts#L39)
Return the records that were created by this user.
##### cursor?
```ts
optional cursor: string;
```
Defined in: [conversations/lib/types/parameters/listConversationsParameters.ts:34](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/parameters/listConversationsParameters.ts#L34)
The cursor to start returning results from.
You are not expected to provide this manually but to follow the URL
provided in _links.next.href or _links.prev.href in the response which contains a cursor value.
###### Remarks
When using the generator from the client, this is handled for you.
##### dateEnd?
```ts
optional dateEnd: string;
```
Defined in: [conversations/lib/types/parameters/listConversationsParameters.ts:13](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/parameters/listConversationsParameters.ts#L13)
Return the records that occurred before this point in time.
##### dateStart?
```ts
optional dateStart: string;
```
Defined in: [conversations/lib/types/parameters/listConversationsParameters.ts:8](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/parameters/listConversationsParameters.ts#L8)
Return the records that occurred after this point in time.
##### includeCustomData?
```ts
optional includeCustomData: boolean;
```
Defined in: [conversations/lib/types/parameters/listConversationsParameters.ts:44](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/parameters/listConversationsParameters.ts#L44)
Include custom data for the conversation
##### order?
```ts
optional order: "asc" | "desc";
```
Defined in: [conversations/lib/types/parameters/listConversationsParameters.ts:24](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/parameters/listConversationsParameters.ts#L24)
Return the records in ascending or descending order.
Must be one of: 'asc', 'desc'.
##### pageSize?
```ts
optional pageSize: number;
```
Defined in: [conversations/lib/types/parameters/listConversationsParameters.ts:18](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/parameters/listConversationsParameters.ts#L18)
Return this amount of records in the response.
***
### ListEventParameters
```ts
type ListEventParameters = object;
```
Defined in: [conversations/lib/types/parameters/listEventParameters.ts:4](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/parameters/listEventParameters.ts#L4)
List Event Parameters
#### Properties
##### cursor?
```ts
optional cursor: string;
```
Defined in: [conversations/lib/types/parameters/listEventParameters.ts:41](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/parameters/listEventParameters.ts#L41)
The cursor to start returning results from.
You are not expected to provide this manually, but to follow the URL provided
in _links.next.href or _links.prev.href in the response which contains a cursor value.
##### endId?
```ts
optional endId: string;
```
Defined in: [conversations/lib/types/parameters/listEventParameters.ts:18](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/parameters/listEventParameters.ts#L18)
The ID to end returning events at.
##### eventType?
```ts
optional eventType: string;
```
Defined in: [conversations/lib/types/parameters/listEventParameters.ts:23](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/parameters/listEventParameters.ts#L23)
The type of event to search for. Does not currently support custom events.
##### excludeDeletedEvents?
```ts
optional excludeDeletedEvents: boolean;
```
Defined in: [conversations/lib/types/parameters/listEventParameters.ts:8](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/parameters/listEventParameters.ts#L8)
Exclude deleted events.
##### order?
```ts
optional order: "asc" | "desc";
```
Defined in: [conversations/lib/types/parameters/listEventParameters.ts:34](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/parameters/listEventParameters.ts#L34)
Return the records in ascending or descending order.
Must be one of: 'asc', 'desc'.
##### pageSize?
```ts
optional pageSize: number;
```
Defined in: [conversations/lib/types/parameters/listEventParameters.ts:28](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/parameters/listEventParameters.ts#L28)
Return this amount of records in the response.
##### startId?
```ts
optional startId: string;
```
Defined in: [conversations/lib/types/parameters/listEventParameters.ts:13](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/parameters/listEventParameters.ts#L13)
The ID to start returning events at.
***
### ListMemberParameters
```ts
type ListMemberParameters = object;
```
Defined in: [conversations/lib/types/parameters/listMemberParameters.ts:1](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/parameters/listMemberParameters.ts#L1)
#### Properties
##### cursor?
```ts
optional cursor: string;
```
Defined in: [conversations/lib/types/parameters/listMemberParameters.ts:19](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/parameters/listMemberParameters.ts#L19)
Return the records starting from this cursor
You are not expected to provide this manually, but to follow the url
provided in _links.next.href or _links.prev.href in the response which
contains a cursor value.
##### order?
```ts
optional order: "asc" | "desc";
```
Defined in: [conversations/lib/types/parameters/listMemberParameters.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/parameters/listMemberParameters.ts#L10)
Return the records in ascending or descending order
##### pageSize?
```ts
optional pageSize: number;
```
Defined in: [conversations/lib/types/parameters/listMemberParameters.ts:5](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/parameters/listMemberParameters.ts#L5)
Return this number of members
***
### ListMemberResponse
```ts
type ListMemberResponse = object & APILinks;
```
Defined in: [conversations/lib/types/responses/listMemberResponse.ts:9](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/responses/listMemberResponse.ts#L9)
A Mmbmer as its returned from the API in the listMembers
#### Type declaration
##### \_embedded
```ts
_embedded: object;
```
###### \_embedded.user
```ts
_embedded.user: MemberUserResponse;
```
The matching user for this member.
##### id
```ts
id: string;
```
The member's id
##### state
```ts
state: MemberState;
```
The member's state
***
### ListSessionParameters
```ts
type ListSessionParameters = object;
```
Defined in: [conversations/lib/types/parameters/listSessionParameters.ts:1](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/parameters/listSessionParameters.ts#L1)
#### Properties
##### cursor?
```ts
optional cursor: string;
```
Defined in: [conversations/lib/types/parameters/listSessionParameters.ts:21](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/parameters/listSessionParameters.ts#L21)
The cursor to start returning results from.
You are not expected to provide this manually but to follow the URL
provided in _links.next.href or _links.prev.href in the response which contains a cursor value.
###### Remarks
When using the generator from the client, this is handled for you.
##### order?
```ts
optional order: "asc" | "desc";
```
Defined in: [conversations/lib/types/parameters/listSessionParameters.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/parameters/listSessionParameters.ts#L10)
Return the records in ascending or descending order.
##### pageSize?
```ts
optional pageSize: number;
```
Defined in: [conversations/lib/types/parameters/listSessionParameters.ts:5](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/parameters/listSessionParameters.ts#L5)
Return the records per page
***
### Member
```ts
type Member = object;
```
Defined in: [conversations/lib/types/member.ts:46](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/member.ts#L46)
Type representing a member in a conversation.
#### Properties
##### channel?
```ts
optional channel: AnyChannel;
```
Defined in: [conversations/lib/types/member.ts:101](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/member.ts#L101)
The channel associated with the member.
##### conversationId?
```ts
optional conversationId: string;
```
Defined in: [conversations/lib/types/member.ts:58](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/member.ts#L58)
##### id?
```ts
optional id: string;
```
Defined in: [conversations/lib/types/member.ts:50](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/member.ts#L50)
The unique ID of the member.
##### initiator?
```ts
optional initiator:
| InitiatorJoined
| InitiatorInvited;
```
Defined in: [conversations/lib/types/member.ts:96](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/member.ts#L96)
The initiator of the member's joining.
##### invitedBy
```ts
invitedBy: string;
```
Defined in: [conversations/lib/types/member.ts:126](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/member.ts#L126)
The user who invited the member.
##### knockingId
```ts
knockingId: string;
```
Defined in: [conversations/lib/types/member.ts:121](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/member.ts#L121)
The knocking ID for the member.
##### media?
```ts
optional media: object;
```
Defined in: [conversations/lib/types/member.ts:106](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/member.ts#L106)
Media-related information for the member.
###### audio
```ts
audio: boolean;
```
Indicates whether audio is active.
###### audioSettings
```ts
audioSettings: AudioSettings;
```
Audio settings for the member.
##### state?
```ts
optional state: MemberState;
```
Defined in: [conversations/lib/types/member.ts:63](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/member.ts#L63)
The state of the member (INVITED, JOINED, LEFT, UNKNOWN).
##### timestamp?
```ts
optional timestamp: object;
```
Defined in: [conversations/lib/types/member.ts:76](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/member.ts#L76)
Timestamps for various states of the member.
###### invited
```ts
invited: string;
```
Timestamp when the member was invited.
###### joined
```ts
joined: string;
```
Timestamp when the member joined.
###### left
```ts
left: string;
```
Timestamp when the member left.
##### user
```ts
user: UserType;
```
Defined in: [conversations/lib/types/member.ts:71](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/member.ts#L71)
The user associated with the member.
###### Remarks
Either the user id or name is required.
***
### MemberPage
```ts
type MemberPage = object;
```
Defined in: [conversations/lib/types/memberPage.ts:4](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/memberPage.ts#L4)
#### Properties
##### links?
```ts
optional links: Record;
```
Defined in: [conversations/lib/types/memberPage.ts:18](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/memberPage.ts#L18)
HAL links for the page.
##### members
```ts
members: Member[];
```
Defined in: [conversations/lib/types/memberPage.ts:13](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/memberPage.ts#L13)
The list of members.
##### pageSize
```ts
pageSize: number;
```
Defined in: [conversations/lib/types/memberPage.ts:8](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/memberPage.ts#L8)
The list of members.
***
### MemberPageResponse
```ts
type MemberPageResponse = object & APILinks;
```
Defined in: [conversations/lib/types/responses/memberPageResponse.ts:5](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/responses/memberPageResponse.ts#L5)
#### Type declaration
##### \_embedded
```ts
_embedded: object;
```
HAL Page response
###### \_embedded.members
```ts
_embedded.members: ListMemberResponse[];
```
The members in the page.
##### page\_size
```ts
page_size: number;
```
Number of members in the page.
***
### MemberResponse
```ts
type MemberResponse = object & APILinks;
```
Defined in: [conversations/lib/types/responses/memberResponse.ts:71](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/responses/memberResponse.ts#L71)
A Mmbmer as its returned from the API
#### Type declaration
##### \_embedded
```ts
_embedded: object;
```
###### \_embedded.user
```ts
_embedded.user: MemberUserResponse;
```
The matching user for this member.
##### channel
```ts
channel: AnyChannel;
```
The channel associated with the member.
##### id
```ts
id: string;
```
The member's id
##### initiator
```ts
initiator:
| InitiatorJoinedResponse
| InitiatorInvitedResponse;
```
The initiator of the member's joining.
##### invited\_by
```ts
invited_by: string;
```
The user who invited the member.
##### knocking\_id
```ts
knocking_id: string;
```
The knocking ID for the member.
##### media
```ts
media: object;
```
Media-related information for the member.
###### media.audio
```ts
media.audio: boolean;
```
Indicates whether audio is active.
###### media.audio\_settings
```ts
media.audio_settings: AudioSettingsResponse;
```
Audio settings for the member.
##### state
```ts
state: MemberState;
```
The member's state
##### timestamp
```ts
timestamp: object;
```
Timestamps for various states of the member.
###### timestamp.invited
```ts
timestamp.invited: string;
```
Timestamp when the member was invited.
###### timestamp.joined
```ts
timestamp.joined: string;
```
Timestamp when the member joined.
###### timestamp.left
```ts
timestamp.left: string;
```
Timestamp when the member left.
***
### MemberUserResponse
```ts
type MemberUserResponse = object & APILinks;
```
Defined in: [conversations/lib/types/responses/memberUserResponse.ts:6](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/responses/memberUserResponse.ts#L6)
The user as its returned from the API
#### Type declaration
##### display\_name
```ts
display_name: string;
```
A string to be displayed for the user. This does not have to be unique.
##### id
```ts
id: string;
```
The user's id
##### name
```ts
name: string;
```
The Unique name for the user
***
### MessageASRBody
```ts
type MessageASRBody = object;
```
Defined in: [conversations/lib/types/messageASRBody.ts:15](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messageASRBody.ts#L15)
#### Properties
##### asr
```ts
asr: object;
```
Defined in: [conversations/lib/types/messageASRBody.ts:24](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messageASRBody.ts#L24)
ASR Result
###### asrId
```ts
asrId: string;
```
ASR Id
###### callId
```ts
callId: string;
```
ASR Call Id
###### endTime?
```ts
optional endTime: string;
```
ASR End Time
###### Remarks
Present only when recording is done
###### error
```ts
error: string;
```
ASR Error
###### format?
```ts
optional format: string;
```
ASR Audio Format
###### Remarks
Present only when recording is done
###### mediaServiceUUID?
```ts
optional mediaServiceUUID: string;
```
ASR Media Service UUID
###### Remarks
Present only when recording is done
###### result?
```ts
optional result: ASRResult[];
```
ASR Results
###### Remarks
Present only when recording is happening
###### size?
```ts
optional size: number;
```
ASR File size
###### Remarks
Present only when recording is done
###### startTime?
```ts
optional startTime: string;
```
ASR Start Time
###### Remarks
Present only when recording is done
###### timeoutReason?
```ts
optional timeoutReason: string;
```
ASR Timeout Reason
###### Remarks
Present only when recording is happening
##### channel
```ts
channel: MessageChannelBody;
```
Defined in: [conversations/lib/types/messageASRBody.ts:19](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messageASRBody.ts#L19)
Channel Information
***
### MessageAudioBody
```ts
type MessageAudioBody = object;
```
Defined in: [conversations/lib/types/messageAudioBody.ts:3](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messageAudioBody.ts#L3)
#### Properties
##### audio
```ts
audio: object;
```
Defined in: [conversations/lib/types/messageAudioBody.ts:12](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messageAudioBody.ts#L12)
Message audio
###### url
```ts
url: string;
```
Audio URL
##### messageType
```ts
messageType: AUDIO;
```
Defined in: [conversations/lib/types/messageAudioBody.ts:7](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messageAudioBody.ts#L7)
Message type
***
### MessageChannelBody
```ts
type MessageChannelBody = object;
```
Defined in: [conversations/lib/types/messageChannelBody.ts:4](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messageChannelBody.ts#L4)
#### Properties
##### channel
```ts
channel: object;
```
Defined in: [conversations/lib/types/messageChannelBody.ts:8](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messageChannelBody.ts#L8)
Channel Details
###### from
```ts
from: AnyChannel;
```
Channel is coming from user/type
###### to
```ts
to: AnyChannel;
```
Channel is going to user/type
##### headers
```ts
headers: Record;
```
Defined in: [conversations/lib/types/messageChannelBody.ts:33](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messageChannelBody.ts#L33)
Message headers
##### id
```ts
id: string;
```
Defined in: [conversations/lib/types/messageChannelBody.ts:23](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messageChannelBody.ts#L23)
Message ID
##### type
```ts
type: ChannelType;
```
Defined in: [conversations/lib/types/messageChannelBody.ts:28](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messageChannelBody.ts#L28)
Message Type
***
### MessageConversationBody
```ts
type MessageConversationBody = object;
```
Defined in: [conversations/lib/types/messageConversationBody.ts:3](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messageConversationBody.ts#L3)
#### Properties
##### displayName?
```ts
optional displayName: string;
```
Defined in: [conversations/lib/types/messageConversationBody.ts:17](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messageConversationBody.ts#L17)
The conversation display name.
##### id
```ts
id: string;
```
Defined in: [conversations/lib/types/messageConversationBody.ts:7](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messageConversationBody.ts#L7)
The conversation id.
##### imageUrl?
```ts
optional imageUrl: string;
```
Defined in: [conversations/lib/types/messageConversationBody.ts:22](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messageConversationBody.ts#L22)
The image for the conversation.
##### name
```ts
name: string;
```
Defined in: [conversations/lib/types/messageConversationBody.ts:12](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messageConversationBody.ts#L12)
The conversation name.
##### state
```ts
state: ConversationState;
```
Defined in: [conversations/lib/types/messageConversationBody.ts:27](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messageConversationBody.ts#L27)
The conversation state.
##### timestamp?
```ts
readonly optional timestamp: object;
```
Defined in: [conversations/lib/types/messageConversationBody.ts:34](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messageConversationBody.ts#L34)
Timestamps for when the conversation was created, updated, and destroyed.
###### created?
```ts
readonly optional created: string;
```
The time the conversation was created.
###### destroyed?
```ts
readonly optional destroyed: string;
```
The time the conversation was destroyed (if applicable).
###### updated?
```ts
readonly optional updated: string;
```
The time the conversation was last updated.
***
### MessageCustomBody
```ts
type MessageCustomBody = object;
```
Defined in: [conversations/lib/types/messageCustomBody.ts:4](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messageCustomBody.ts#L4)
#### Properties
##### custom
```ts
custom: Record;
```
Defined in: [conversations/lib/types/messageCustomBody.ts:13](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messageCustomBody.ts#L13)
Custom data for message
##### messageType
```ts
messageType: CUSTOM;
```
Defined in: [conversations/lib/types/messageCustomBody.ts:8](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messageCustomBody.ts#L8)
Message type
***
### MessageEventBody
```ts
type MessageEventBody = object;
```
Defined in: [conversations/lib/types/messageEventBody.ts:1](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messageEventBody.ts#L1)
#### Properties
##### eventId
```ts
eventId: string;
```
Defined in: [conversations/lib/types/messageEventBody.ts:5](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messageEventBody.ts#L5)
The event id.
***
### MessageFileBody
```ts
type MessageFileBody = object;
```
Defined in: [conversations/lib/types/messageFileBody.ts:3](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messageFileBody.ts#L3)
#### Properties
##### file
```ts
file: object;
```
Defined in: [conversations/lib/types/messageFileBody.ts:9](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messageFileBody.ts#L9)
###### url
```ts
url: string;
```
File URL
##### messageType
```ts
messageType: FILE;
```
Defined in: [conversations/lib/types/messageFileBody.ts:7](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messageFileBody.ts#L7)
Message type
***
### MessageImageBody
```ts
type MessageImageBody = object;
```
Defined in: [conversations/lib/types/messageImageBody.ts:3](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messageImageBody.ts#L3)
#### Properties
##### image
```ts
image: object;
```
Defined in: [conversations/lib/types/messageImageBody.ts:12](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messageImageBody.ts#L12)
Message image
###### url
```ts
url: string;
```
Image URL
##### messageType
```ts
messageType: IMAGE;
```
Defined in: [conversations/lib/types/messageImageBody.ts:7](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messageImageBody.ts#L7)
Message type
***
### MessageLegBody
```ts
type MessageLegBody = object;
```
Defined in: [conversations/lib/types/messageLegBody.ts:23](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messageLegBody.ts#L23)
#### Properties
##### direction
```ts
direction: CallDirection;
```
Defined in: [conversations/lib/types/messageLegBody.ts:32](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messageLegBody.ts#L32)
Call direction of the message leg
##### legId
```ts
legId: string;
```
Defined in: [conversations/lib/types/messageLegBody.ts:27](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messageLegBody.ts#L27)
Id of the message leg
##### state
```ts
state: LegState;
```
Defined in: [conversations/lib/types/messageLegBody.ts:47](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messageLegBody.ts#L47)
State of the message leg
##### status
```ts
status: CallStatus;
```
Defined in: [conversations/lib/types/messageLegBody.ts:42](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messageLegBody.ts#L42)
Call status of the message leg
##### statusHistory
```ts
statusHistory: object;
```
Defined in: [conversations/lib/types/messageLegBody.ts:52](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messageLegBody.ts#L52)
Last status of the leg
###### conversationId?
```ts
optional conversationId: string;
```
Conversation Id
###### knockerId?
```ts
optional knockerId: string;
```
Id of the knocker
###### memberId?
```ts
optional memberId: string;
```
Member Id
###### state
```ts
state: LegState;
```
Last state of the leg
###### status
```ts
status: CallStatus;
```
Call status of the leg
##### type
```ts
type: Channels;
```
Defined in: [conversations/lib/types/messageLegBody.ts:37](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messageLegBody.ts#L37)
Channel type of the message leg
***
### MessageLocationBody
```ts
type MessageLocationBody = object;
```
Defined in: [conversations/lib/types/messageLocationBody.ts:3](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messageLocationBody.ts#L3)
#### Properties
##### location
```ts
location: object;
```
Defined in: [conversations/lib/types/messageLocationBody.ts:9](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messageLocationBody.ts#L9)
###### address
```ts
address: string;
```
Address
###### latitude
```ts
latitude: string;
```
Latitude
###### longitude
```ts
longitude: string;
```
Longitude
###### name
```ts
name: string;
```
Name
##### messageType
```ts
messageType: LOCATION;
```
Defined in: [conversations/lib/types/messageLocationBody.ts:7](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messageLocationBody.ts#L7)
Message Type
***
### MessageMemberBody
```ts
type MessageMemberBody = object & Omit & Omit;
```
Defined in: [conversations/lib/types/messageMemberBody.ts:4](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messageMemberBody.ts#L4)
#### Type declaration
##### audio?
```ts
optional audio: boolean;
```
Audio Message
##### memberId
```ts
memberId: string;
```
Member ID
***
### MessagePlayDTMFBody
```ts
type MessagePlayDTMFBody = object;
```
Defined in: [conversations/lib/types/messagePlayDTMFBody.ts:3](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messagePlayDTMFBody.ts#L3)
#### Properties
##### channel
```ts
channel: object;
```
Defined in: [conversations/lib/types/messagePlayDTMFBody.ts:12](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messagePlayDTMFBody.ts#L12)
Channel information.
###### from
```ts
from: object;
```
Channel message was sent from.
###### from.from
```ts
from.from: object;
```
From Channel information.
###### from.from.type
```ts
from.from.type: Channels;
```
Channel type.
###### from.to
```ts
from.to: object;
```
To Channel information.
###### from.to.type
```ts
from.to.type: string;
```
Channel type.
###### from.to.user
```ts
from.to.user: string;
```
User ID.
###### from.type
```ts
from.type: Channels;
```
Channel type.
###### headers
```ts
headers: Record;
```
Message headers
###### id
```ts
id: string;
```
Mmessage Id
###### to
```ts
to: object;
```
Channel message was sent to.
###### to.from
```ts
to.from: object;
```
From Channel information.
###### to.from.type
```ts
to.from.type: Channels;
```
Channel type.
###### to.to
```ts
to.to: object;
```
To Channel information.
###### to.to.type
```ts
to.to.type: string;
```
Channel type.
###### to.to.user
```ts
to.to.user: string;
```
User ID.
###### to.type
```ts
to.type: Channels;
```
Channel type.
###### type
```ts
type: "app" | "phone" | "sip" | "websocket" | "vcp";
```
Message type
##### digits
```ts
digits: string;
```
Defined in: [conversations/lib/types/messagePlayDTMFBody.ts:7](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messagePlayDTMFBody.ts#L7)
The digits to play.
##### dtmfSeq?
```ts
optional dtmfSeq: number;
```
Defined in: [conversations/lib/types/messagePlayDTMFBody.ts:102](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messagePlayDTMFBody.ts#L102)
The sequence number of the DTMF event.
##### duration
```ts
duration: number;
```
Defined in: [conversations/lib/types/messagePlayDTMFBody.ts:112](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messagePlayDTMFBody.ts#L112)
The duration of the DTMF event.
##### method
```ts
method: "in";
```
Defined in: [conversations/lib/types/messagePlayDTMFBody.ts:107](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messagePlayDTMFBody.ts#L107)
The method used to send the DTMF event.
***
### MessageRandomBody
```ts
type MessageRandomBody = object;
```
Defined in: [conversations/lib/types/messageRandomBody.ts:3](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messageRandomBody.ts#L3)
#### Properties
##### messageType
```ts
messageType: RANDOM;
```
Defined in: [conversations/lib/types/messageRandomBody.ts:4](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messageRandomBody.ts#L4)
***
### MessageRecordBody
```ts
type MessageRecordBody = object;
```
Defined in: [conversations/lib/types/messageRecordBody.ts:1](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messageRecordBody.ts#L1)
#### Properties
##### beepEnd
```ts
beepEnd: boolean;
```
Defined in: [conversations/lib/types/messageRecordBody.ts:30](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messageRecordBody.ts#L30)
Play beep at the end of the recording
##### beepStart
```ts
beepStart: boolean;
```
Defined in: [conversations/lib/types/messageRecordBody.ts:25](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messageRecordBody.ts#L25)
Play beep at the beginning of the recording
##### channels
```ts
channels: number;
```
Defined in: [conversations/lib/types/messageRecordBody.ts:50](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messageRecordBody.ts#L50)
Number of channels
##### detectSpeach
```ts
detectSpeach: boolean;
```
Defined in: [conversations/lib/types/messageRecordBody.ts:35](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messageRecordBody.ts#L35)
Detect speech
##### format
```ts
format: string;
```
Defined in: [conversations/lib/types/messageRecordBody.ts:20](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messageRecordBody.ts#L20)
Audio format
##### multiTrack
```ts
multiTrack: boolean;
```
Defined in: [conversations/lib/types/messageRecordBody.ts:45](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messageRecordBody.ts#L45)
Recording has multiple tracks
##### recordId
```ts
recordId: string;
```
Defined in: [conversations/lib/types/messageRecordBody.ts:5](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messageRecordBody.ts#L5)
Recording ID
##### split
```ts
split: boolean;
```
Defined in: [conversations/lib/types/messageRecordBody.ts:40](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messageRecordBody.ts#L40)
Split the audio
##### streamed
```ts
streamed: boolean;
```
Defined in: [conversations/lib/types/messageRecordBody.ts:15](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messageRecordBody.ts#L15)
Audio is streamed
##### transcription
```ts
transcription: object;
```
Defined in: [conversations/lib/types/messageRecordBody.ts:55](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messageRecordBody.ts#L55)
Transcription settings
###### language
```ts
language: string;
```
Transcription language
###### sentimentAnalysis
```ts
sentimentAnalysis: boolean;
```
Include sentiment analysis
##### validity
```ts
validity: number;
```
Defined in: [conversations/lib/types/messageRecordBody.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messageRecordBody.ts#L10)
Recording URL
***
### MessageRecordIdBody
```ts
type MessageRecordIdBody = object;
```
Defined in: [conversations/lib/types/messageRecordIdBody.ts:1](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messageRecordIdBody.ts#L1)
#### Properties
##### recordId
```ts
recordId: string;
```
Defined in: [conversations/lib/types/messageRecordIdBody.ts:5](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messageRecordIdBody.ts#L5)
Recording ID
***
### MessageRTCAnswerBody
```ts
type MessageRTCAnswerBody = object & MessageRTCIdBody;
```
Defined in: [conversations/lib/types/messageRTCAnswerBody.ts:3](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messageRTCAnswerBody.ts#L3)
#### Type declaration
##### answer
```ts
answer: string;
```
##### isFromMb
```ts
isFromMb: boolean;
```
##### sessionDestination
```ts
sessionDestination: string;
```
***
### MessageRTCIdBody
```ts
type MessageRTCIdBody = object;
```
Defined in: [conversations/lib/types/messageRTCIdBody.ts:1](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messageRTCIdBody.ts#L1)
#### Properties
##### rtcId
```ts
rtcId: string;
```
Defined in: [conversations/lib/types/messageRTCIdBody.ts:5](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messageRTCIdBody.ts#L5)
RTC ID
***
### MessageSayBody
```ts
type MessageSayBody = object;
```
Defined in: [conversations/lib/types/messageSayBody.ts:1](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messageSayBody.ts#L1)
#### Properties
##### language
```ts
language: string;
```
Defined in: [conversations/lib/types/messageSayBody.ts:25](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messageSayBody.ts#L25)
The language of the voice
##### level
```ts
level: number;
```
Defined in: [conversations/lib/types/messageSayBody.ts:5](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messageSayBody.ts#L5)
Volume level
##### loop
```ts
loop: number;
```
Defined in: [conversations/lib/types/messageSayBody.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messageSayBody.ts#L10)
Number of times to repeat the audio
##### premium
```ts
premium: boolean;
```
Defined in: [conversations/lib/types/messageSayBody.ts:35](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messageSayBody.ts#L35)
Whether to use the premium voice
##### queue
```ts
queue: boolean;
```
Defined in: [conversations/lib/types/messageSayBody.ts:15](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messageSayBody.ts#L15)
Queue the audio
##### ssml
```ts
ssml: boolean;
```
Defined in: [conversations/lib/types/messageSayBody.ts:45](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messageSayBody.ts#L45)
Whether to use SSML
##### style
```ts
style: number;
```
Defined in: [conversations/lib/types/messageSayBody.ts:30](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messageSayBody.ts#L30)
The style of the voice
##### text
```ts
text: string;
```
Defined in: [conversations/lib/types/messageSayBody.ts:40](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messageSayBody.ts#L40)
The text to say
##### voiceName
```ts
voiceName: string;
```
Defined in: [conversations/lib/types/messageSayBody.ts:20](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messageSayBody.ts#L20)
The name of the voice to use
***
### MessageSayIdBody
```ts
type MessageSayIdBody = object;
```
Defined in: [conversations/lib/types/messageSayIdBody.ts:1](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messageSayIdBody.ts#L1)
#### Properties
##### sayId
```ts
sayId: string;
```
Defined in: [conversations/lib/types/messageSayIdBody.ts:5](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messageSayIdBody.ts#L5)
The ID of the message.
***
### MessageSIPBody
```ts
type MessageSIPBody = object;
```
Defined in: [conversations/lib/types/messageSIPBody.ts:8](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messageSIPBody.ts#L8)
Standard SIP and RTC message body
#### Remarks
This is the same body for RTC and SIP
#### Properties
##### channel
```ts
channel: AnyChannel;
```
Defined in: [conversations/lib/types/messageSIPBody.ts:12](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messageSIPBody.ts#L12)
Call channel
***
### MessageSIPDirectionBody
```ts
type MessageSIPDirectionBody = object & MessageSIPBody;
```
Defined in: [conversations/lib/types/messageSIPDirectionBody.ts:9](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messageSIPDirectionBody.ts#L9)
Standard SIP and RTC message body with direction
#### Type declaration
##### direction
```ts
direction: CallDirection;
```
Direction of the call
#### Remarks
This is the same body for RTC and SIP
***
### MessageSIPHangupBody
```ts
type MessageSIPHangupBody = object & MessageSIPDirectionBody;
```
Defined in: [conversations/lib/types/messageSIPHangupBody.ts:8](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messageSIPHangupBody.ts#L8)
Standard SIP and RTC
#### Type declaration
##### bandwidth
```ts
bandwidth: object;
```
Bandwidth of the call
###### bandwidth.byteIn
```ts
bandwidth.byteIn: number;
```
Total number of bytes received
###### bandwidth.byteOut
```ts
bandwidth.byteOut: number;
```
Total number of bytes sent
##### quality
```ts
quality: object;
```
Quality of the call
###### quality.flawTotal
```ts
quality.flawTotal: number;
```
Total number of packets that had flaws
###### quality.jitterBurstRate
```ts
quality.jitterBurstRate: number;
```
Average amount of jitter burst
###### quality.jitterLossRate
```ts
quality.jitterLossRate: number;
```
Average amount of jitter loss
###### quality.jitterMaxVar
```ts
quality.jitterMaxVar: number;
```
Most amount ofjitter
###### quality.jitterMinVar
```ts
quality.jitterMinVar: number;
```
Least amount of jitter
###### quality.mosScore
```ts
quality.mosScore: number;
```
The MOS score of the call
###### quality.packetCnt
```ts
quality.packetCnt: number;
```
Total number of packets
###### quality.packetLossPerc
```ts
quality.packetLossPerc: number;
```
Total number of packets lost
###### quality.qualityPercentage
```ts
quality.qualityPercentage: number;
```
The percentage of the call that was not silence
##### reason
```ts
reason: object;
```
The reason of the call hangup
###### reason.code
```ts
reason.code: string;
```
The SIP reason Code of the call
###### reason.sipCode
```ts
reason.sipCode: string;
```
The SIP code of the call
###### reason.text
```ts
reason.text: string;
```
The reason of the call
#### Remarks
This is the same body for RTC and SIP
***
### MessageSIPMachineBody
```ts
type MessageSIPMachineBody = object & MessageSIPBody;
```
Defined in: [conversations/lib/types/messageSIPMachineBody.ts:3](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messageSIPMachineBody.ts#L3)
#### Type declaration
##### confidence
```ts
confidence: number;
```
Confidence of the machine detection
##### type
```ts
type: string;
```
Type of SIP call
***
### MessageSIPStatusBody
```ts
type MessageSIPStatusBody = object & MessageSIPBody;
```
Defined in: [conversations/lib/types/messageSIPStatusBody.ts:9](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messageSIPStatusBody.ts#L9)
SIP and RTC message body with status
#### Type declaration
##### direction
```ts
direction: CallDirection;
```
Direction of the call
##### duration
```ts
duration: string;
```
Call duration
##### endTime
```ts
endTime: string;
```
Time of the end of the call
##### from
```ts
from: string;
```
Phone number of the caller
##### networkCode
```ts
networkCode: string;
```
Network code of the caller
##### price
```ts
price: string;
```
Price for the call
##### rate
```ts
rate: string;
```
Rate per minute
##### requestTime
```ts
requestTime: string;
```
Time of the request
##### startTime
```ts
startTime: string;
```
Time of the start of the call
##### state
```ts
state: object;
```
State of the call
###### state.status
```ts
state.status: CallStatus;
```
Status of the call
##### status
```ts
status: CallStatus;
```
Status of the call
##### to
```ts
to: string;
```
Phone number
#### Remarks
This is the same body for RTC and SIP
***
### MessageStatusBody
```ts
type MessageStatusBody = object;
```
Defined in: [conversations/lib/types/messageStatusBody.ts:3](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messageStatusBody.ts#L3)
#### Properties
##### audio?
```ts
optional audio: object;
```
Defined in: [conversations/lib/types/messageStatusBody.ts:58](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messageStatusBody.ts#L58)
###### url
```ts
url: string;
```
Audio URL
##### channelType?
```ts
optional channelType: "sms" | "mms" | "whatsapp" | "viber" | "messenger";
```
Defined in: [conversations/lib/types/messageStatusBody.ts:17](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messageStatusBody.ts#L17)
Channel type
##### custom?
```ts
optional custom: Record;
```
Defined in: [conversations/lib/types/messageStatusBody.ts:94](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messageStatusBody.ts#L94)
##### error?
```ts
optional error: Record;
```
Defined in: [conversations/lib/types/messageStatusBody.ts:37](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messageStatusBody.ts#L37)
Message error
##### file?
```ts
optional file: object;
```
Defined in: [conversations/lib/types/messageStatusBody.ts:65](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messageStatusBody.ts#L65)
###### url
```ts
url: string;
```
File URL
##### from?
```ts
optional from: string;
```
Defined in: [conversations/lib/types/messageStatusBody.ts:22](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messageStatusBody.ts#L22)
Member ID of the sender.
##### image?
```ts
optional image: object;
```
Defined in: [conversations/lib/types/messageStatusBody.ts:44](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messageStatusBody.ts#L44)
###### url
```ts
url: string;
```
Image URL
##### location?
```ts
optional location: object;
```
Defined in: [conversations/lib/types/messageStatusBody.ts:103](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messageStatusBody.ts#L103)
###### address
```ts
address: string;
```
Location address
###### latitude
```ts
latitude: number;
```
Latitude
###### longitude
```ts
longitude: number;
```
Longitude
###### name
```ts
name: string;
```
Location name
##### messageType?
```ts
optional messageType: EventMessageType;
```
Defined in: [conversations/lib/types/messageStatusBody.ts:12](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messageStatusBody.ts#L12)
Type of event
##### messageUUID?
```ts
optional messageUUID: string;
```
Defined in: [conversations/lib/types/messageStatusBody.ts:32](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messageStatusBody.ts#L32)
The ID of the message.
##### originalEventId?
```ts
optional originalEventId: string;
```
Defined in: [conversations/lib/types/messageStatusBody.ts:7](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messageStatusBody.ts#L7)
The ID of the message.
##### template?
```ts
optional template: object;
```
Defined in: [conversations/lib/types/messageStatusBody.ts:72](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messageStatusBody.ts#L72)
###### name
```ts
name: string;
```
###### parameters
```ts
parameters: string[];
```
Template variables
##### text?
```ts
optional text: string;
```
Defined in: [conversations/lib/types/messageStatusBody.ts:42](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messageStatusBody.ts#L42)
Message text
##### to?
```ts
optional to: string;
```
Defined in: [conversations/lib/types/messageStatusBody.ts:27](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messageStatusBody.ts#L27)
Member ID of the recipient.
##### vcard?
```ts
optional vcard: object;
```
Defined in: [conversations/lib/types/messageStatusBody.ts:96](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messageStatusBody.ts#L96)
###### url
```ts
url: string;
```
VCard URL
##### video?
```ts
optional video: object;
```
Defined in: [conversations/lib/types/messageStatusBody.ts:51](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messageStatusBody.ts#L51)
###### url
```ts
url: string;
```
Video URL
##### whatsapp?
```ts
optional whatsapp: object;
```
Defined in: [conversations/lib/types/messageStatusBody.ts:82](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messageStatusBody.ts#L82)
###### locale
```ts
locale: string;
```
Whats App locale
###### policy
```ts
policy: string;
```
Whats App policy
***
### MessageTemplateBody
```ts
type MessageTemplateBody = object;
```
Defined in: [conversations/lib/types/messageTemplateBody.ts:3](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messageTemplateBody.ts#L3)
#### Properties
##### messageType
```ts
messageType: TEMPLATE;
```
Defined in: [conversations/lib/types/messageTemplateBody.ts:7](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messageTemplateBody.ts#L7)
Message type
##### template
```ts
template: object;
```
Defined in: [conversations/lib/types/messageTemplateBody.ts:12](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messageTemplateBody.ts#L12)
Message template
###### name
```ts
name: string;
```
Template name
###### parameters
```ts
parameters: unknown[];
```
Template parameters
###### whatsapp
```ts
whatsapp: object;
```
Whatsapp settings
###### whatsapp.locale
```ts
whatsapp.locale: string;
```
Template locale
###### whatsapp.policy
```ts
whatsapp.policy: string;
```
Template policy
***
### MessageTextBody
```ts
type MessageTextBody = object;
```
Defined in: [conversations/lib/types/messageTextBody.ts:3](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messageTextBody.ts#L3)
#### Properties
##### messageType
```ts
messageType: TEXT;
```
Defined in: [conversations/lib/types/messageTextBody.ts:7](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messageTextBody.ts#L7)
Message type
##### text
```ts
text: string;
```
Defined in: [conversations/lib/types/messageTextBody.ts:12](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messageTextBody.ts#L12)
Message text
***
### MessageVCardBody
```ts
type MessageVCardBody = object;
```
Defined in: [conversations/lib/types/messageVCardBody.ts:3](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messageVCardBody.ts#L3)
#### Properties
##### image
```ts
image: object;
```
Defined in: [conversations/lib/types/messageVCardBody.ts:19](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messageVCardBody.ts#L19)
###### url
```ts
url: string;
```
Image URL
##### messageType
```ts
messageType: VCARD;
```
Defined in: [conversations/lib/types/messageVCardBody.ts:7](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messageVCardBody.ts#L7)
Message type
##### vcard
```ts
vcard: object;
```
Defined in: [conversations/lib/types/messageVCardBody.ts:12](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messageVCardBody.ts#L12)
Message vcard
###### url
```ts
url: string;
```
Vcard url
***
### MessageVideoBody
```ts
type MessageVideoBody = object;
```
Defined in: [conversations/lib/types/messageVideoBody.ts:3](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messageVideoBody.ts#L3)
#### Properties
##### messageType
```ts
messageType: VIDEO;
```
Defined in: [conversations/lib/types/messageVideoBody.ts:7](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messageVideoBody.ts#L7)
Message type
##### video
```ts
video: object;
```
Defined in: [conversations/lib/types/messageVideoBody.ts:12](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/messageVideoBody.ts#L12)
Message video
###### url
```ts
url: string;
```
Video URL
***
### PhoneNumberChannel
```ts
type PhoneNumberChannel = object;
```
Defined in: [conversations/lib/types/phoneNumberChannel.ts:6](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/phoneNumberChannel.ts#L6)
Type representing a phone number channel.
#### Properties
##### number
```ts
number: string;
```
Defined in: [conversations/lib/types/phoneNumberChannel.ts:15](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/phoneNumberChannel.ts#L15)
The phone number.
##### type
```ts
type: PHONE;
```
Defined in: [conversations/lib/types/phoneNumberChannel.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/phoneNumberChannel.ts#L10)
The type of channel (phone).
***
### Session
```ts
type Session = object;
```
Defined in: [conversations/lib/types/session.ts:13](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/session.ts#L13)
#### Properties
##### apiKey
```ts
apiKey: string;
```
Defined in: [conversations/lib/types/session.ts:27](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/session.ts#L27)
The API Key for the session.
##### id
```ts
id: string;
```
Defined in: [conversations/lib/types/session.ts:17](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/session.ts#L17)
The ID of the session.
##### properties
```ts
properties: object;
```
Defined in: [conversations/lib/types/session.ts:32](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/session.ts#L32)
Session properties
###### ttl
```ts
ttl: number;
```
Time to live in seconds.
##### user
```ts
user: SessionUser;
```
Defined in: [conversations/lib/types/session.ts:22](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/session.ts#L22)
User for the session
***
### SessionPage
```ts
type SessionPage = object;
```
Defined in: [conversations/lib/types/sessionPage.ts:4](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/sessionPage.ts#L4)
#### Properties
##### links?
```ts
optional links: Record;
```
Defined in: [conversations/lib/types/sessionPage.ts:18](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/sessionPage.ts#L18)
HAL links for the page.
##### pageSize
```ts
pageSize: number;
```
Defined in: [conversations/lib/types/sessionPage.ts:8](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/sessionPage.ts#L8)
The number of items in the page.
##### sessions
```ts
sessions: Session[];
```
Defined in: [conversations/lib/types/sessionPage.ts:13](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/sessionPage.ts#L13)
Sessions in the page.
***
### SessionPageResponse
```ts
type SessionPageResponse = object & APILinks;
```
Defined in: [conversations/lib/types/responses/sessionPageResponse.ts:4](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/responses/sessionPageResponse.ts#L4)
#### Type declaration
##### \_embedded
```ts
_embedded: object;
```
HAL Page response
###### \_embedded.sessions
```ts
_embedded.sessions: SessionResponse[];
```
The sessions in the page.
##### page\_size
```ts
page_size: number;
```
Number of members in the page.
***
### SessionResponse
```ts
type SessionResponse = object & Omit;
```
Defined in: [conversations/lib/types/responses/sessionResponse.ts:6](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/responses/sessionResponse.ts#L6)
A session as its returned from the API
#### Type declaration
##### \_embedded
```ts
_embedded: object;
```
###### \_embedded.api\_key
```ts
_embedded.api_key: string;
```
API Key for the session.
###### \_embedded.user
```ts
_embedded.user: SessionUser;
```
The matching user for this member.
***
### SessionUser
```ts
type SessionUser = object;
```
Defined in: [conversations/lib/types/session.ts:1](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/session.ts#L1)
#### Properties
##### id
```ts
id: string;
```
Defined in: [conversations/lib/types/session.ts:5](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/session.ts#L5)
The ID of the user.
##### name
```ts
name: string;
```
Defined in: [conversations/lib/types/session.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/session.ts#L10)
The name of the user.
***
### SipChannel
```ts
type SipChannel = object;
```
Defined in: [conversations/lib/types/sipChannel.ts:6](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/sipChannel.ts#L6)
Type representing a SIP channel.
#### Properties
##### password
```ts
password: string;
```
Defined in: [conversations/lib/types/sipChannel.ts:25](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/sipChannel.ts#L25)
The SIP password.
##### type
```ts
type: SIP;
```
Defined in: [conversations/lib/types/sipChannel.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/sipChannel.ts#L10)
The type of channel (SIP).
##### uri
```ts
uri: string;
```
Defined in: [conversations/lib/types/sipChannel.ts:15](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/sipChannel.ts#L15)
The SIP URI.
##### username
```ts
username: string;
```
Defined in: [conversations/lib/types/sipChannel.ts:20](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/sipChannel.ts#L20)
The SIP username.
***
### UpdateMemberParameters
```ts
type UpdateMemberParameters = object;
```
Defined in: [conversations/lib/types/parameters/updateMemberParameters.ts:6](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/parameters/updateMemberParameters.ts#L6)
Parameters for updating a member.
#### Properties
##### from
```ts
from: string;
```
Defined in: [conversations/lib/types/parameters/updateMemberParameters.ts:18](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/parameters/updateMemberParameters.ts#L18)
Member ID of who is making the update.
##### reason?
```ts
optional reason: object;
```
Defined in: [conversations/lib/types/parameters/updateMemberParameters.ts:23](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/parameters/updateMemberParameters.ts#L23)
The reason for the update.
###### code
```ts
code: string;
```
The reason code.
###### text
```ts
text: string;
```
The reason text.
##### state
```ts
state: LEFT | JOINED;
```
Defined in: [conversations/lib/types/parameters/updateMemberParameters.ts:13](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/parameters/updateMemberParameters.ts#L13)
The new state to public set
Setting to `MemberState.LEFT` will remove the member from the `reason` is
required when setting to `MemberState.JOINED`
***
### VbcChannel
```ts
type VbcChannel = object;
```
Defined in: [conversations/lib/types/vbcChannel.ts:6](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/vbcChannel.ts#L6)
Type representing a VBC (Voice Business Cloud) channel.
#### Properties
##### extension
```ts
extension: string;
```
Defined in: [conversations/lib/types/vbcChannel.ts:15](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/vbcChannel.ts#L15)
The VBC extension.
##### type
```ts
type: VBC;
```
Defined in: [conversations/lib/types/vbcChannel.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/vbcChannel.ts#L10)
The type of channel (VBC).
***
### WebSocketChannel
```ts
type WebSocketChannel = object;
```
Defined in: [conversations/lib/types/websocketChannel.ts:6](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/websocketChannel.ts#L6)
Type representing a WebSocket channel.
#### Properties
##### contentType
```ts
contentType: string;
```
Defined in: [conversations/lib/types/websocketChannel.ts:20](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/websocketChannel.ts#L20)
The content type for WebSocket.
##### type
```ts
type: ChannelType;
```
Defined in: [conversations/lib/types/websocketChannel.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/websocketChannel.ts#L10)
The type of channel (WebSocket).
##### uri
```ts
uri: string;
```
Defined in: [conversations/lib/types/websocketChannel.ts:15](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/types/websocketChannel.ts#L15)
The WebSocket URI.
This is the Vonage Conversations SDK for Node.js for use with [Vonage APIs](https://www.vonage.com/). To use it you will need a Vonage account. Sign up [for free][signup] at vonage.com.
For full API documentation refer to the [Vonage Conversations API specs](https://developer.vonage.com/en/api/conversation?source=conversation).
If you are updating from V2 to V3, please check the migration guide found [here](https://github.com/Vonage/vonage-node-sdk/blob/3.x/packages/conversations/v2_TO_v3_MIGRATION_GUIDE.md)
* [Installation](#installation)
* [Usage](#usage)
* [Promises](#promises)
## Installation
We recommend using this SDK as part of the overall [`@vonage/server-sdk` package](https://github.com/vonage/vonage-node-sdk). Please see the main package for installation.
You can also use this SDK standalone if you only need access to just the Conversations API.
### With NPM
```bash
npm install @vonage/conversations
```
### With Yarn
```bash
yarn add @vonage/conversations
```
## Usage
### As part of the Vonage Server SDK
If you are using this SDK as part of the Vonage Server SDK, you can access it as the `conversations` property off of the client that you instantiate.
```js
const { Vonage } = require('@vonage/server-sdk');
const { Auth } = require('@vonage/auth');
const vonage = new Vonage(new Auth({
apiKey: API_KEY,
apiSecret: API_SECRET,
applicationId: APP_ID,
privateKey: PRIVATE_KEY_PATH,
}), options);
vonage.conversations.getConversation(CONVERSATION_ID)
```
### Standalone
The SDK can be used standalone from the main [Vonage Server SDK for Node.js](https://github.com/vonage/vonage-node-sdk)
if you only need to use the Conversations API. All you need to do
is `require('@vonage/conversations')`, and use the returned object to create your own
client.
```js
const { Auth } = require('@vonage/auth');
const { Conversations } = require('@vonage/conversations');
const conversationsClient = new Conversations(new Auth({
apiKey: API_KEY,
apiSecret: API_SECRET,
applicationId: APP_ID,
privateKey: PRIVATE_KEY_PATH,
}), options);
conversationsClient.getConversation(CONVERSATION_ID)
```
## Promises
Most methods that interact with the Vonage API uses Promises. You can either resolve these yourself, or use `await` to
wait for a response.
```js
const resp = await conversationsClient.getConversation(CONVERSATION_ID)
conversationsClient.getConversation(CONVERSATION_ID)
.then(resp => console.log(resp))
.catch(err => console.error(err));
```
## Testing
Run:
```bash
npm run test
```
[signup]: https://dashboard.nexmo.com/sign-up?utm_source=DEV_REL&utm_medium=github&utm_campaign=node-server-sdk
[license]: _media/LICENSE.txt
## Enumerations
### ChannelType
Defined in: [conversations/lib/enums/channelType.ts:4](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/enums/channelType.ts#L4)
Enum representing the type of communication channel.
#### Enumeration Members
| Enumeration Member | Value | Description | Defined in |
| ------ | ------ | ------ | ------ |
| `APP` | `"app"` | Represents an app channel. | [conversations/lib/enums/channelType.ts:18](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/enums/channelType.ts#L18) |
| `PHONE` | `"phone"` | Represents a phone channel. | [conversations/lib/enums/channelType.ts:8](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/enums/channelType.ts#L8) |
| `SIP` | `"sip"` | Represents a SIP channel. | [conversations/lib/enums/channelType.ts:13](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/enums/channelType.ts#L13) |
| `VBC` | `"vbc"` | Represents a VBC (Voice Business Cloud) channel. | [conversations/lib/enums/channelType.ts:28](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/enums/channelType.ts#L28) |
| `WEBSOCKET` | `"websocket"` | Represents a WebSocket channel. | [conversations/lib/enums/channelType.ts:23](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/enums/channelType.ts#L23) |
***
### ConversationState
Defined in: [conversations/lib/enums/conversationState.ts:4](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/enums/conversationState.ts#L4)
Conversation state
#### Enumeration Members
| Enumeration Member | Value | Description | Defined in |
| ------ | ------ | ------ | ------ |
| `ACTIVE` | `"ACTIVE"` | Conversation is still active | [conversations/lib/enums/conversationState.ts:8](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/enums/conversationState.ts#L8) |
| `DELETED` | `"DELETED"` | Conversation is deleted | [conversations/lib/enums/conversationState.ts:18](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/enums/conversationState.ts#L18) |
| `INACTIVE` | `"INACTIVE"` | Conversation is inactive | [conversations/lib/enums/conversationState.ts:13](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/enums/conversationState.ts#L13) |
***
### EventMessageType
Defined in: [conversations/lib/enums/eventMessageType.ts:1](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/enums/eventMessageType.ts#L1)
#### Enumeration Members
| Enumeration Member | Value | Defined in |
| ------ | ------ | ------ |
| `AUDIO` | `"audio"` | [conversations/lib/enums/eventMessageType.ts:4](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/enums/eventMessageType.ts#L4) |
| `CUSTOM` | `"custom"` | [conversations/lib/enums/eventMessageType.ts:8](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/enums/eventMessageType.ts#L8) |
| `FILE` | `"file"` | [conversations/lib/enums/eventMessageType.ts:6](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/enums/eventMessageType.ts#L6) |
| `IMAGE` | `"image"` | [conversations/lib/enums/eventMessageType.ts:3](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/enums/eventMessageType.ts#L3) |
| `LOCATION` | `"location"` | [conversations/lib/enums/eventMessageType.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/enums/eventMessageType.ts#L10) |
| `RANDOM` | `"random"` | [conversations/lib/enums/eventMessageType.ts:11](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/enums/eventMessageType.ts#L11) |
| `TEMPLATE` | `"template"` | [conversations/lib/enums/eventMessageType.ts:7](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/enums/eventMessageType.ts#L7) |
| `TEXT` | `"text"` | [conversations/lib/enums/eventMessageType.ts:2](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/enums/eventMessageType.ts#L2) |
| `VCARD` | `"vcard"` | [conversations/lib/enums/eventMessageType.ts:9](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/enums/eventMessageType.ts#L9) |
| `VIDEO` | `"video"` | [conversations/lib/enums/eventMessageType.ts:5](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/enums/eventMessageType.ts#L5) |
***
### EventType
Defined in: [conversations/lib/enums/eventsTypes.ts:4](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/enums/eventsTypes.ts#L4)
Enum representing various types of events and their descriptions.
#### Enumeration Members
| Enumeration Member | Value | Description | Defined in |
| ------ | ------ | ------ | ------ |
| `AUDIO_DTMF` | `"audio:dtmf"` | Audio: Play DTMF audio | [conversations/lib/enums/eventsTypes.ts:28](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/enums/eventsTypes.ts#L28) |
| `AUDIO_EAR_MUFF_OFF` | `"audio:earmuff:off"` | Audio: Earmuff audio | [conversations/lib/enums/eventsTypes.ts:58](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/enums/eventsTypes.ts#L58) |
| `AUDIO_EAR_MUFF_ON` | `"audio:earmuff:on"` | Audio: Earmuff audio | [conversations/lib/enums/eventsTypes.ts:53](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/enums/eventsTypes.ts#L53) |
| `AUDIO_MUTE_OFF` | `"audio:mute:off"` | Audio: Unmute audio | [conversations/lib/enums/eventsTypes.ts:48](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/enums/eventsTypes.ts#L48) |
| `AUDIO_MUTE_ON` | `"audio:mute:on"` | Audio: Mute audio | [conversations/lib/enums/eventsTypes.ts:43](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/enums/eventsTypes.ts#L43) |
| `AUDIO_PLAY` | `"audio:play"` | Audio: Play audio | [conversations/lib/enums/eventsTypes.ts:8](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/enums/eventsTypes.ts#L8) |
| `AUDIO_PLAY_STOP` | `"audio:play:stop"` | Audio: Stop currently playing audio | [conversations/lib/enums/eventsTypes.ts:13](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/enums/eventsTypes.ts#L13) |
| `AUDIO_RECORD` | `"audio:record"` | Audio: Record the audio in the conversation | [conversations/lib/enums/eventsTypes.ts:33](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/enums/eventsTypes.ts#L33) |
| `AUDIO_RECORD_STOP` | `"audio:record:stop"` | Audio: Stop current recording of audio | [conversations/lib/enums/eventsTypes.ts:38](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/enums/eventsTypes.ts#L38) |
| `AUDIO_SAY` | `"audio:say"` | Audio: Use TTS to speak the given text | [conversations/lib/enums/eventsTypes.ts:18](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/enums/eventsTypes.ts#L18) |
| `AUDIO_SAY_STOP` | `"audio:say:stop"` | Audio: Stop currently playing TTS | [conversations/lib/enums/eventsTypes.ts:23](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/enums/eventsTypes.ts#L23) |
| `AUDIO_SPEAKING_OFF` | `"audio:speaking:off"` | Audio: Speaking on | [conversations/lib/enums/eventsTypes.ts:68](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/enums/eventsTypes.ts#L68) |
| `AUDIO_SPEAKING_ON` | `"audio:speaking:on"` | Audio: Speaking on | [conversations/lib/enums/eventsTypes.ts:63](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/enums/eventsTypes.ts#L63) |
| `CUSTOM` | `"custom"` | Custom: Custom event | [conversations/lib/enums/eventsTypes.ts:73](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/enums/eventsTypes.ts#L73) |
| `EPHEMERAL` | `"ephemeral"` | Ephemeral: Ephemeral | [conversations/lib/enums/eventsTypes.ts:78](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/enums/eventsTypes.ts#L78) |
| `MESSAGE` | `"message"` | Message: Message (Text, Image, Audio, Video, File, Template, Custom, VCard, Location, Random) | [conversations/lib/enums/eventsTypes.ts:83](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/enums/eventsTypes.ts#L83) |
| `MESSAGE_DELIVERED` | `"message:delivered"` | Message: Message delivered | [conversations/lib/enums/eventsTypes.ts:108](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/enums/eventsTypes.ts#L108) |
| `MESSAGE_REJECTED` | `"message:rejected"` | Message: Message rejected | [conversations/lib/enums/eventsTypes.ts:93](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/enums/eventsTypes.ts#L93) |
| `MESSAGE_SEEN` | `"message:seen"` | Message: Message seen | [conversations/lib/enums/eventsTypes.ts:103](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/enums/eventsTypes.ts#L103) |
| `MESSAGE_SUBMITTED` | `"message:submitted"` | Message: Message submitted | [conversations/lib/enums/eventsTypes.ts:88](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/enums/eventsTypes.ts#L88) |
| `MESSAGE_UNDELIVERABLE` | `"message:undeliverable"` | Message: Message undeliverable | [conversations/lib/enums/eventsTypes.ts:98](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/enums/eventsTypes.ts#L98) |
***
### LegStatus
Defined in: [conversations/lib/enums/legStatus.ts:4](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/enums/legStatus.ts#L4)
The status of a leg
#### Enumeration Members
| Enumeration Member | Value | Description | Defined in |
| ------ | ------ | ------ | ------ |
| `ANSWERED` | `"answered"` | The leg is answered | [conversations/lib/enums/legStatus.ts:18](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/enums/legStatus.ts#L18) |
| `RINGING` | `"ringing"` | The leg is ringing | [conversations/lib/enums/legStatus.ts:13](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/enums/legStatus.ts#L13) |
| `STARTED` | `"started"` | The leg is started | [conversations/lib/enums/legStatus.ts:8](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/enums/legStatus.ts#L8) |
***
### MemberState
Defined in: [conversations/lib/enums/memberState.ts:4](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/enums/memberState.ts#L4)
Enum representing the state of a member.
#### Enumeration Members
| Enumeration Member | Value | Description | Defined in |
| ------ | ------ | ------ | ------ |
| `INVITED` | `"INVITED"` | The member has been invited to join the conversation. | [conversations/lib/enums/memberState.ts:8](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/enums/memberState.ts#L8) |
| `JOINED` | `"JOINED"` | The member has joined the conversation. | [conversations/lib/enums/memberState.ts:13](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/enums/memberState.ts#L13) |
| `LEFT` | `"LEFT"` | The member has left the conversation. | [conversations/lib/enums/memberState.ts:18](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/enums/memberState.ts#L18) |
| `UNKNOWN` | `"UNKNOWN"` | The state of the member is unknown or undefined. | [conversations/lib/enums/memberState.ts:23](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/enums/memberState.ts#L23) |
***
### ReasonCode
Defined in: [conversations/lib/enums/reasonMessages.ts:4](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/enums/reasonMessages.ts#L4)
Enum representing various reasons
#### Enumeration Members
| Enumeration Member | Value | Description | Defined in |
| ------ | ------ | ------ | ------ |
| `ADDRESS_INCOMPLETE` | `"address_incomplete"` | Address incomplete. | [conversations/lib/enums/reasonMessages.ts:83](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/enums/reasonMessages.ts#L83) |
| `BAD_EXTENSION` | `"bad_extension"` | Bad extension. | [conversations/lib/enums/reasonMessages.ts:48](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/enums/reasonMessages.ts#L48) |
| `BAD_GATEWAY` | `"bad_gateway"` | Bad gateway. | [conversations/lib/enums/reasonMessages.ts:78](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/enums/reasonMessages.ts#L78) |
| `BANNED_CALL_ENDED` | `"banned_call_ended"` | Call ended due to being banned. | [conversations/lib/enums/reasonMessages.ts:118](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/enums/reasonMessages.ts#L118) |
| `BUSY` | `"busy"` | The recipient is currently busy. | [conversations/lib/enums/reasonMessages.ts:13](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/enums/reasonMessages.ts#L13) |
| `BUSY_HERE` | `"busy_here"` | Recipient is busy here. | [conversations/lib/enums/reasonMessages.ts:53](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/enums/reasonMessages.ts#L53) |
| `CANCELLED` | `"cancelled"` | The request was cancelled. | [conversations/lib/enums/reasonMessages.ts:23](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/enums/reasonMessages.ts#L23) |
| `FAILED` | `"failed"` | General failure. | [conversations/lib/enums/reasonMessages.ts:8](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/enums/reasonMessages.ts#L8) |
| `FLOW_FAILED` | `"flow_failed"` | Flow execution failed. | [conversations/lib/enums/reasonMessages.ts:123](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/enums/reasonMessages.ts#L123) |
| `FORBIDDEN` | `"forbidden"` | Forbidden access. | [conversations/lib/enums/reasonMessages.ts:68](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/enums/reasonMessages.ts#L68) |
| `GONE` | `"gone"` | Resource has gone away. | [conversations/lib/enums/reasonMessages.ts:73](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/enums/reasonMessages.ts#L73) |
| `NOT_FOUND` | `"not_found"` | Resource not found. | [conversations/lib/enums/reasonMessages.ts:38](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/enums/reasonMessages.ts#L38) |
| `NOT_IMPLEMENTED` | `"not_implemented"` | Not implemented. | [conversations/lib/enums/reasonMessages.ts:93](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/enums/reasonMessages.ts#L93) |
| `OK` | `"ok"` | Operation was successful. | [conversations/lib/enums/reasonMessages.ts:33](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/enums/reasonMessages.ts#L33) |
| `PAYMENT_REQUIRED` | `"payment_required"` | Payment is required. | [conversations/lib/enums/reasonMessages.ts:113](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/enums/reasonMessages.ts#L113) |
| `REJECTED` | `"rejected"` | The request was rejected. | [conversations/lib/enums/reasonMessages.ts:28](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/enums/reasonMessages.ts#L28) |
| `REQUEST_TERMINATED` | `"request_terminated"` | Request terminated. | [conversations/lib/enums/reasonMessages.ts:43](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/enums/reasonMessages.ts#L43) |
| `REQUEST_TIMEOUT` | `"request_timeout"` | Request timeout. | [conversations/lib/enums/reasonMessages.ts:58](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/enums/reasonMessages.ts#L58) |
| `SERVER_INTERNAL_ERROR` | `"server_internal_error"` | Internal server error. | [conversations/lib/enums/reasonMessages.ts:88](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/enums/reasonMessages.ts#L88) |
| `SERVER_TIMEOUT` | `"server_timeout"` | Server timeout. | [conversations/lib/enums/reasonMessages.ts:98](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/enums/reasonMessages.ts#L98) |
| `SERVICE_UNAVAILABLE` | `"service_unavailable"` | Service is unavailable. | [conversations/lib/enums/reasonMessages.ts:108](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/enums/reasonMessages.ts#L108) |
| `TEMPORARILY_UNAVAILABLE` | `"temporarily_unavailable"` | Temporarily unavailable. | [conversations/lib/enums/reasonMessages.ts:63](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/enums/reasonMessages.ts#L63) |
| `TIMEOUT` | `"timeout"` | Operation timed out. | [conversations/lib/enums/reasonMessages.ts:18](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/enums/reasonMessages.ts#L18) |
| `VERSION_NOT_SUPPORTED` | `"version_not_supported"` | Version not supported. | [conversations/lib/enums/reasonMessages.ts:103](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/enums/reasonMessages.ts#L103) |
## Classes
### Conversations
Defined in: [conversations/lib/conversations.ts:173](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/conversations.ts#L173)
A client for talking to the Vonage Conversation API.
#### Examples
Create a standalone Conversation client
```ts
import { Conversations } from '@vonage/conversation';
const conversationClient = new Conversations({
applicationId: VONAGE_APPLICATION_ID,
privateKey: VONAGE_APPLICATION_PRIVATE_KEY_PATH,
});
```
Create an Conversation client from the Vonage client
```ts
import { Vonage } from '@vonage/server-client';
const vonage = new Vonage({
applicationId: VONAGE_APPLICATION_ID,
privateKey: VONAGE_APPLICATION_PRIVATE_KEY_PATH,
});
const conversationClient = vonage.conversations
```
#### Extends
- [`Client`](Vonage-Server-Client.md#client)
#### Constructors
##### Constructor
```ts
new Conversations(credentials, options?): Conversations;
```
Defined in: server-client/dist/lib/client.d.ts:35
Creates a new instance of the Client.
###### Parameters
###### credentials
The authentication credentials or an authentication instance.
[`AuthInterface`](Vonage-Auth.md#authinterface) | [`AuthParams`](Vonage-Auth.md#authparams)
###### options?
[`ConfigParams`](Vonage-Server-Client.md#configparams)
Optional configuration settings for the client.
###### Returns
[`Conversations`](#conversations)
###### Inherited from
[`Client`](Vonage-Server-Client.md#client).[`constructor`](Vonage-Server-Client.md#client#constructor)
#### Properties
##### auth
```ts
protected auth: AuthInterface;
```
Defined in: server-client/dist/lib/client.d.ts:24
The authentication instance responsible for generating authentication headers and query parameters.
###### Inherited from
[`Client`](Vonage-Server-Client.md#client).[`auth`](Vonage-Server-Client.md#client#auth)
##### authType
```ts
authType: AuthenticationType = AuthenticationType.JWT;
```
Defined in: [conversations/lib/conversations.ts:174](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/conversations/lib/conversations.ts#L174)
The type of authentication used for the client's requests.
###### Overrides
[`Client`](Vonage-Server-Client.md#client).[`authType`](Vonage-Server-Client.md#client#authtype)
##### config
```ts
protected config: ConfigParams;
```
Defined in: server-client/dist/lib/client.d.ts:28
Configuration settings for the client, including default hosts for various services and other request settings.
###### Inherited from
[`Client`](Vonage-Server-Client.md#client).[`config`](Vonage-Server-Client.md#client#config)
##### transformers
```ts
static transformers: object;
```
Defined in: server-client/dist/lib/client.d.ts:11
Static property containing utility transformers.
###### camelCaseObjectKeys
```ts
camelCaseObjectKeys: PartialTransformFunction;
```
###### kebabCaseObjectKeys
```ts
kebabCaseObjectKeys: PartialTransformFunction;
```
###### omit()
```ts
omit: (keys, obj) => TransformedObject;
```
###### Parameters
###### keys
`string`[]
###### obj
[`ObjectToTransform`](Vonage-Server-Client.md#objecttotransform)
###### Returns
[`TransformedObject`](Vonage-Server-Client.md#transformedobject)
###### snakeCaseObjectKeys
```ts
snakeCaseObjectKeys: PartialTransformFunction;
```
###### Inherited from
[`Client`](Vonage-Server-Client.md#client).[`transformers`](Vonage-Server-Client.md#client#transformers)
#### Methods
##### addAuthenticationToRequest()
```ts
addAuthenticationToRequest(request): Promise