Developers

GetVariables

Usage

Use this method to return every variable value captured in an ongoing conversation.

Mandatory parameters

Name Object attribute Type Description Default value
variableConfiguration Object
revealValues String Whether obfuscated variable values should be returned or not. Accepted values: true, false false

Optional parameters

This method has no optional parameters.

Response data format

This method calls the Chat API’s GET /conversation/variables endpoint. It returns a Promise with the API response data. Please refer to the Responses section of the endpoint on the Chat API Routes page for the response format.

Example

var variableConfiguration = {
    revealValues:true
}
chatbot.api.getVariables(variableConfiguration);