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));
ParameterTypeDescription
optionsObjectRequired

An object containing the property conversationId
callbackResponseObjectOptional

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

PropertyTypeDescription
conversationIdStringRequired

The conversation that you ended.
createdAtStringRequired

The time of creation of the conversation
endedBooleanRequired

Whether or not the conversation is ended.