Developers
Authorization
API Resources
NL Interpreter
Search
Assist
GetAppData
Usage
Use this method to return application-related data stored in the Chat instance's Settings > Extra Info screen.
Mandatory parameters
| Name | Type | Description |
|---|---|---|
| dataId | String | The group name defined in the Chat instance's Settings > Extra Info screen. Must be included in the appDataInfo object. |
Optional parameters
| Name | Type | Description |
|---|---|---|
| name | String | The Name element defined in the Chat instance's Settings > Extra Info screen |
Response data format
This method calls the Chat API’s GET /app/data/{dataId} 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
const appDataInfo = {
dataID: "bot_labels",
name: "CustomLabels",
};
chatbot.api.getAppData(appDataInfo).then(response => {
// Use the data!
});