Enables scripted content fragments to use ConversationMessages

Methods

Create

Creates a new conversation

Usage

#set($conversationMessageResponse = $core_v2_conversationMessage.Create($conversationId, $body))

Parameters

NameTypeDescriptionRequiredDefaultOptions
conversationIdGuidId of the conversationRequired
bodystringBody of the conversationRequired

Return Type

ConversationMessage

Create

Creates a new conversation message

Usage

#set($conversationMessageResponse = $core_v2_conversationMessage.Create($conversationId, $body, "%{Subject = $subjectArg}"))

Parameters

NameTypeDescriptionRequiredDefaultOptions
conversationIdGuidId of the conversationRequired
bodystringBody of the messageRequired
SubjectstringSubject of the messageOptional

Return Type

ConversationMessage

Delete

Delete a conversation message

Usage

#set($additionalInfoResponse = $core_v2_conversationMessage.Delete($conversationId, $id))

Parameters

NameTypeDescriptionRequiredDefaultOptions
conversationIdGuidId of the parent conversationRequired
idGuidId of the conversation messageRequired

Return Type

AdditionalInfo

List

List conversation messages for a conversation

Usage

#set($pagedListResponse = $core_v2_conversationMessage.List($conversationId))

Parameters

NameTypeDescriptionRequiredDefaultOptions
conversationIdGuidId of a conversationRequired

Return Type

PagedList<ConversationMessage>

List

List conversation messages for a conversation

Usage

#set($pagedListResponse = $core_v2_conversationMessage.List($conversationId, "%{PageIndex = $pageIndexArg, PageSize = $pageSizeArg}"))

Parameters

NameTypeDescriptionRequiredDefaultOptions
conversationIdGuidId of a conversationRequired
PageIndexintZero-basedOptional0
PageSizeintAmount of messages to return per pageOptional20

Return Type

PagedList<ConversationMessage>