Chatbot Intent Question
Chatbot Intent Questions
- Chatbot Intent Questions Manage
GET bot/chatbotIntentQuestions
GET bot/chatbotIntentQuestions/{id}
POST bot/chatbotIntentQuestions
Model
Chatbot Intent Question JSON Format
Chatbot Intent Question is represented as simple flat JSON objects with the following keys:
| Name | Type | Description |
|---|---|---|
id |
guid | Id of the intent question. |
order |
integer | Must be greater than or equal to 0, ascending order. |
intentId |
guid | Id of the intent. |
content |
string | Visitor questions that tigger this intent. |
chatbotIntentQuestionKeywords |
chatbotIntentQuestionKeywords[] | Reference to Chatbot Intent Question Keyword. |
Chatbot Intent Question Keyword JSON Format:
| Name | Type | Description |
|---|---|---|
id |
guid | Id of the chatbot intent question keyword. |
intentQuestionId |
guid | Id of the chatbot intent question. |
variableName |
string | Label to distinguish same entity marked on one question. |
startPosition |
integer | Start index of current question you marked. |
endPosition |
integer | End index of current question you marked. |
ifPrebuiltEntity |
bool | Whether marked entity is prebuilt entity or custom entity. |
prebuiltEntityId |
guid | Id of the marked prebuilt entity. |
entityId |
guid | Id of the entity marked in one question. |
entity |
entity | Reference to Bot_ChatbotEntity. |
prebuiltEntity |
prebuiltEntity | Reference to Prebuilt Entity. |
Endpoint
Get the list of Chatbot Intent Questions
GET bot/chatbotIntentQuestions
Parameters:
| Name | Type | In | Required | Description |
|---|---|---|---|---|
intentId |
guid | query | no | Id of the intent. |
include |
string | query | no | Allowed value is "chatbotIntentQuestionKeyword". |
Response:
An array of Chatbot Intent Question
Example
Sample Request:
curl https://api15.comm100.io/v4/bot/chatbotIntentQuestions \
-X
'GET'
\
-H
'Authorization: Bearer {access_token}'
\
Response:
HTTP/1.1 200 OK
Get a single Chatbot Intent Question
GET bot/chatbotIntentQuestions/{id}
Parameters:
| Name | Type | In | Required | Description |
|---|---|---|---|---|
include |
string | query | no | Allowed value is "chatbotIntentQuestionKeyword". |
Response:
Example
Sample Request:
curl https://api15.comm100.io/v4/bot/chatbotIntentQuestions/83d2660f-b7e6-409a-b072-896a4ee4914a \
-X
'GET'
\
-H
'Authorization: Bearer {access_token}'
\
Response:
HTTP/1.1 200 OK
Create a new Chatbot Intent Question
POST bot/chatbotIntentQuestions
Parameters:
| Name | Type | In | Required | Description |
|---|---|---|---|---|
order |
integer | body | no | Must be greater than or equal to 0, ascending order. |
intentId |
guid | body | yes | Id of the intent. |
content |
string | body | yes | Visitor questions that tigger this intent. |
chatbotIntentQuestionKeywords |
chatbotIntentQuestionKeywords[] | body | no | Reference to Chatbot Intent Question Keyword. |
Response:
Example
Sample Request:
curl https://api15.comm100.io/v4/bot/chatbotIntentQuestions \
-X
'POST'
\
-H
'Authorization: Bearer {access_token}'
\
-H
'Content-Type: application/json'
\
-D
'{"order":0,"intentId":"2fde3f7e-8c23-4852-97be-a28fa5289d0e","content":"Hello","chatbotIntentQuestionKeywords":[{"variableName":"color","startPosition":5,"endPosition":20,"ifPrebuiltEntity":false,"prebuiltEntityId":"00000000-0000-0000-0000-000000000000","entityId":"d394618e-6c2a-444f-b4b3-5b88ed2466ad"}]}'
Response:
HTTP/1.1 201 Created