Developers
Authorization
API Resources
NL Interpreter
Search
Assist
StartConversation
Usage
Use this method to start a session and retrieve a token to maintain that session. It uses the same bot configuration that created the API client.
Mandatory parameters
This method has no mandatory parameters.
Optional parameters
For information on available configuration options, see the payload section of the POST /conversation endpoint.
Response data format
This method calls the Chat API’s POST /conversation 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
chatbot.api.startConversation().then(response => {
// Conversation is ready!
});