Developers
Authorization
API Resources
NL Interpreter
Search
Assist
StartSurvey
Usage
Use this method to start and get the settings data from the requested survey using the survey ID. A session must be initiated before you can request the survey ID.
Mandatory parameters
| Name | Type | Description |
|---|---|---|
| surveyId | integer | The identifier of the requested survey, which must match an existing Survey ID stored in the Chat instance. If necessary, contact Inbenta support to activate Surveys in your instance. |
Optional parameters
This method has no optional parameters.
Response data format
This method calls the Chat API’s GET /surveys/{surveyId}/start 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.startSurvey(<survey_id>);