KustomerCore.endConversation()

End a conversation

πŸ‘

First, initialize chat

You must initialize with KustomerCore.init() before you can execute any additional Core SDK methods

Examples

// end a conversation
KustomerCore.endConversation({
  conversationId: 'SOME_ID
}, function (res, error) {
  console.log('conversation ended');
});

Syntax

KustomerCore.endConversation(options, function(callbackResponse, error));

Parameter

Type

Description

options

Object

Required

An object containing the property conversationId

callbackResponse

Object

Optional

A callback that is run after method completion.

callbackResponse is an object returned to the callback function. See the callbackResponse section below to see the properties of the object.

error is either undefined or a native JavaScript Error object.

callbackResponse

Property

Type

Description

conversationId

String

Required

The conversation that you ended.

createdAt

String

Required

The time of creation of the conversation

ended

Boolean

Required

Whether or not the conversation is ended.


Did this page help you?