Class ConversationApi

Index

Methods

create delete get injectEvent injectMessage list listRecent stopActive update

Methods

create

create(data: CreateConversationRequestData): Promise<Conversation.Conversation>
Create a conversation Creates a new empty conversation. It is generally not needed to create a conversation explicitly since sending or receiving a message automatically creates a new conversation if it does not already exist between the given app and contact. Creating empty conversation is useful if the metadata of the conversation should be populated when the first message in the conversation is a contact message or the first message in the conversation comes out-of-band and needs to be injected with InjectMessage endpoint.
Parameters
- data: CreateConversationRequestData
  The data to provide to the API call.
Returns Promise<Conversation.Conversation>

delete

delete(data: DeleteConversationRequestData): Promise<any>
Delete a conversation Deletes a conversation together with all the messages sent as part of the conversation.
Parameters
- data: DeleteConversationRequestData
  The data to provide to the API call.
Returns Promise<any>

get

get(data: GetConversationRequestData): Promise<Conversation.Conversation>
Get a conversation Retrieves a conversation by id. A conversation has two participating entities, an app and a contact.
Parameters
- data: GetConversationRequestData
  The data to provide to the API call.
Returns Promise<Conversation.Conversation>

injectEvent

injectEvent(data: InjectEventRequestData): Promise<InjectEventResponse>
Inject an event This operation injects a conversation event into a specific conversation.
Parameters
- data: InjectEventRequestData
  The data to provide to the API call.
Returns Promise<InjectEventResponse>

injectMessage

injectMessage(data: InjectMessageRequestData): Promise<any>
Inject a message This operation injects a conversation message into a specific conversation.
Parameters
- data: InjectMessageRequestData
  The data to provide to the API call.
Returns Promise<any>

list

list(
data?: ListConversationsRequestData,
): ApiListPromise<Conversation.Conversation>
List conversations This operation lists all conversations that are associated with an app and/or a contact.
Parameters
- Optionaldata: ListConversationsRequestData
  The data to provide to the API call.
Returns ApiListPromise<Conversation.Conversation>

listRecent

listRecent(
data: ListRecentConversationsRequestData,
): ApiListPromise<ConversationRecentMessage>
List recent conversations This operation lists conversations and their most recent message, ordered by when the most recent message was sent for that conversation.
Parameters
- data: ListRecentConversationsRequestData
  The data to provide to the API call.
Returns ApiListPromise<ConversationRecentMessage>

stopActive

stopActive(data: StopActiveConversationRequestData): Promise<any>
Stop conversation This operation stops the referenced conversation, if the conversation is still active. In Conversation mode, a new conversation will be created if a new message is exchanged between the app or contact that was part of the stopped conversation.
Parameters
- data: StopActiveConversationRequestData
  The data to provide to the API call.
Returns Promise<any>

update

update(data: UpdateConversationRequestData): Promise<Conversation.Conversation>
Update a conversation This operation updates a conversation which can, for instance, be used to update the metadata associated with a conversation.
Parameters
- data: UpdateConversationRequestData
  The data to provide to the API call.
Returns Promise<Conversation.Conversation>