Methods
Create
Creates a new conversation
Usage
#set($conversationMessageResponse = $core_v2_conversationMessage.Create($conversationId, $body))
Parameters
| Name | Type | Description | Required | Default | Options |
|---|
| conversationId | Guid | Id of the conversation | Required | | |
| body | string | Body of the conversation | Required | | |
Return Type
ConversationMessage
Create
Creates a new conversation message
Usage
#set($conversationMessageResponse = $core_v2_conversationMessage.Create($conversationId, $body, "%{Subject = $subjectArg}"))Parameters
| Name | Type | Description | Required | Default | Options |
|---|
| conversationId | Guid | Id of the conversation | Required | | |
| body | string | Body of the message | Required | | |
| Subject | string | Subject of the message | Optional | | |
Return Type
ConversationMessage
Delete
Delete a conversation message
Usage
#set($additionalInfoResponse = $core_v2_conversationMessage.Delete($conversationId, $id))
Parameters
| Name | Type | Description | Required | Default | Options |
|---|
| conversationId | Guid | Id of the parent conversation | Required | | |
| id | Guid | Id of the conversation message | Required | | |
Return Type
AdditionalInfo
List
List conversation messages for a conversation
Usage
#set($pagedListResponse = $core_v2_conversationMessage.List($conversationId))
Parameters
| Name | Type | Description | Required | Default | Options |
|---|
| conversationId | Guid | Id of a conversation | Required | | |
Return Type
PagedList<ConversationMessage>
List
List conversation messages for a conversation
Usage
#set($pagedListResponse = $core_v2_conversationMessage.List($conversationId, "%{PageIndex = $pageIndexArg, PageSize = $pageSizeArg}"))Parameters
| Name | Type | Description | Required | Default | Options |
|---|
| conversationId | Guid | Id of a conversation | Required | | |
| PageIndex | int | Zero-based | Optional | 0 | |
| PageSize | int | Amount of messages to return per page | Optional | 20 | |
Return Type
PagedList<ConversationMessage>