Bot_ChatbotIntentCategory
Bot_ChatbotIntentCategories
- Bot_ChatbotIntentCategories Manage
GET bot/chatbotIntentCategories
GET bot/chatbotIntentCategories/{id}
POST bot/chatbotIntentCategories
PUT bot/chatbotIntentCategories/{id}
DELETE bot/chatbotIntentCategories/{id}
Model
Bot_ChatbotIntentCategory JSON Format
Bot_ChatbotIntentCategory is represented as simple flat JSON objects with the following keys:
| Name | Type | Description |
|---|---|---|
id |
guid | Id of the category. |
chatbotId |
guid | Id of the chatbot. |
name |
string | Name of the category. |
order |
integer | Must be greater than or equal to 0, ascending order. |
parentId |
guid | Parent Id of the category. |
Endpoint
Get the list of Bot_ChatbotIntentCategories
GET bot/chatbotIntentCategories
Parameters:
| Name | Type | In | Required | Description |
|---|---|---|---|---|
chatbotId |
guid | query | no | Id of the chatbot. |
parentId |
guid | query | no | Parent Id of the category. |
Response:
An array of Bot_ChatbotIntentCategory
Example
Sample Request:
curl https://api15.comm100.io/v4/bot/chatbotIntentCategories \
-X
'GET'
\
-H
'Authorization: Bearer {access_token}'
\
Response:
HTTP/1.1 200 OK
Get a single Bot_ChatbotIntentCategory
GET bot/chatbotIntentCategories/{id}
Example
Sample Request:
curl https://api15.comm100.io/v4/bot/chatbotIntentCategories/ee705b05-33c0-43b6-ab4a-a138f28b6aa2 \
-X
'GET'
\
-H
'Authorization: Bearer {access_token}'
\
Response:
HTTP/1.1 200 OK
Create a new Bot_ChatbotIntentCategory
POST bot/chatbotIntentCategories
Parameters:
| Name | Type | In | Required | Description |
|---|---|---|---|---|
chatbotId |
guid | body | yes | Id of the chatbot. |
name |
string | body | yes | Name of the category. |
order |
integer | body | no | Must be greater than or equal to 0, ascending order. |
parentId |
guid | body | no | Parent Id of the category. |
Response:
Example
Sample Request:
curl https://api15.comm100.io/v4/bot/chatbotIntentCategories \
-X
'POST'
\
-H
'Authorization: Bearer {access_token}'
\
-H
'Content-Type: application/json'
\
-D
'{"chatbotId":"e8bf0d25-eed6-4a46-a417-318e15019609","name":"fruit","order":1,"parentId":"3bfcf193-9939-4abd-a832-2625ea02e75b"}'
Response:
HTTP/1.1 201 Created
Update the Bot_ChatbotIntentCategory
PUT bot/chatbotIntentCategories/{id}
Parameters:
| Name | Type | In | Required | Description |
|---|---|---|---|---|
chatbotId |
guid | body | yes | Id of the chatbot. |
name |
string | body | yes | Name of the category. |
order |
integer | body | no | Must be greater than or equal to 0, ascending order. |
parentId |
guid | body | no | Parent Id of the category. |
Response:
Example
Sample Request:
curl https://api15.comm100.io/v4/bot/chatbotIntentCategories/ee705b05-33c0-43b6-ab4a-a138f28b6aa2 \
-X
'PUT'
\
-H
'Authorization: Bearer {access_token}'
\
-H
'Content-Type: application/json'
\
-D
'{"chatbotId":"e8bf0d25-eed6-4a46-a417-318e15019609","name":"fruit","order":1,"parentId":"3bfcf193-9939-4abd-a832-2625ea02e75b"}'
Response:
HTTP/1.1 200 OK
Remove the Bot_ChatbotIntentCategory
DELETE bot/chatbotIntentCategories/{id}
Parameters:
No Parameters
Response:
No Content
Example
Sample Request:
curl https://api15.comm100.io/v4/bot/chatbotIntentCategories/ee705b05-33c0-43b6-ab4a-a138f28b6aa2 \
-X
'DELETE'
\
-H
'Authorization: Bearer {access_token}'
\
Response:
HTTP/1.1 204 No Content