Bot_ChatbotCannedQuickReply
Bot_ChatbotCannedQuickReplies
- Bot_ChatbotCannedQuickReplies Manage
GET bot/chatbotCannedQuickReplies/{id}
GET bot/chatbots/{id}/chatbotCannedQuickReplies
POST bot/chatbotCannedQuickReplies
PUT bot/chatbotCannedQuickReplies/{id}
DELETE bot/chatbotCannedQuickReplies/{id}
Model
Bot_ChatbotCannedQuickReply JSON Format
Bot_ChatbotCannedQuickReply is represented as simple flat JSON objects with the following keys:
| Name | Type | Description |
|---|---|---|
id |
guid | Id of the quick reply. |
chatbotId |
guid | Id of the chatbot. |
name |
string | Name of the quick reply. |
chatbotCannedQuickReplyItems |
chatbotCannedQuickReplyItems[] | Reference to Chatbot Canned Quick Reply Item. |
Chatbot Canned Quick Reply Item JSON Format:
| Name | Type | Description |
|---|---|---|
id |
guid | Id of the chatbot canned quick reply item. |
order |
integer | Must be greater than or equal to 0, the order of the quick reply item, ascending order. |
intentId |
guid | Id of the intent. |
quickReplyId |
guid | Id of the quick reply. |
text |
string | Only available when type is triggerAnIntent. |
type |
string | Allowed values are "triggerAnIntent", "contactAnAgent". |
optionTextWhenAgentOnline |
string | Option text when agent online. |
optionTextWhenAgentOffline |
string | Option text when agent offline. |
intent |
intent | Reference to Chatbot Intent. |
Endpoint
Get a single Bot_ChatbotCannedQuickReply
GET bot/chatbotCannedQuickReplies/{id}
Parameters:
| Name | Type | In | Required | Description |
|---|---|---|---|---|
include |
string | query | no | Allowed values are "chatbotCannedQuickReplyItem", "chatbotIntent". |
Response:
Example
Sample Request:
curl https://api15.comm100.io/v4/bot/chatbotCannedQuickReplies/1064a6e1-4485-4ef5-a7d3-000fc57cd598 \
-X
'GET'
\
-H
'Authorization: Bearer {access_token}'
\
Response:
HTTP/1.1 200 OK
Get the list of Bot_ChatbotCannedQuickReplies
GET bot/chatbots/{id}/chatbotCannedQuickReplies
Parameters:
| Name | Type | In | Required | Description |
|---|---|---|---|---|
keywords |
string | query | no | Search canned quick reply name by the keyword. |
chatbotId |
guid | query | yes | Id of the chatbot. |
sortBy |
string | query | no | Allowed values are "name", "id?and "chatbot". |
include |
string | query | no | Allowed values are "chatbotCannedQuickReplyItem", "chatbotIntent". |
Response:
An array of Bot_ChatbotCannedQuickReply
Example
Sample Request:
curl https://api15.comm100.io/v4/bot/chatbots/1064a6e1-4485-4ef5-a7d3-000fc57cd598/chatbotCannedQuickReplies \
-X
'GET'
\
-H
'Authorization: Bearer {access_token}'
\
Response:
HTTP/1.1 200 OK
Create a new Bot_ChatbotCannedQuickReply
POST bot/chatbotCannedQuickReplies
Parameters:
| Name | Type | In | Required | Description |
|---|---|---|---|---|
chatbotId |
guid | body | yes | Id of the chatbot. |
name |
string | body | yes | Name of the quick reply. |
chatbotCannedQuickReplyItems |
chatbotCannedQuickReplyItems[] | body | no | Reference to Chatbot Canned Quick Reply Item. |
Response:
Example
Sample Request:
curl https://api15.comm100.io/v4/bot/chatbotCannedQuickReplies \
-X
'POST'
\
-H
'Authorization: Bearer {access_token}'
\
-H
'Content-Type: application/json'
\
-D
'{"chatbotId":"9626da62-e87b-4bfb-9925-2b72b04481f2","name":"default canned quick reply","chatbotCannedQuickReplyItems":[{"order":0,"intentId":"1a75ce57-d88e-4398-98a2-e39f0e18cc6d","text":"Link to an intent","type":"triggerAnIntent","optionTextWhenAgentOnline":"","optionTextWhenAgentOffline":""}]}'
Response:
HTTP/1.1 201 Created
Update the Bot_ChatbotCannedQuickReply
PUT bot/chatbotCannedQuickReplies/{id}
Parameters:
| Name | Type | In | Required | Description |
|---|---|---|---|---|
chatbotId |
guid | body | yes | Id of the chatbot. |
name |
string | body | yes | Name of the quick reply. |
chatbotCannedQuickReplyItems |
chatbotCannedQuickReplyItems[] | body | no | Reference to Chatbot Canned Quick Reply Item. |
Response:
Example
Sample Request:
curl https://api15.comm100.io/v4/bot/chatbotCannedQuickReplies/1064a6e1-4485-4ef5-a7d3-000fc57cd598 \
-X
'PUT'
\
-H
'Authorization: Bearer {access_token}'
\
-H
'Content-Type: application/json'
\
-D
'{"chatbotId":"9626da62-e87b-4bfb-9925-2b72b04481f2","name":"default canned quick reply","chatbotCannedQuickReplyItems":[{"order":0,"intentId":"1a75ce57-d88e-4398-98a2-e39f0e18cc6d","text":"Link to an intent","type":"triggerAnIntent","optionTextWhenAgentOnline":"","optionTextWhenAgentOffline":""}]}'
Response:
HTTP/1.1 200 OK
Remove the Bot_ChatbotCannedQuickReply
DELETE bot/chatbotCannedQuickReplies/{id}
Parameters:
No Parameters
Response:
No Content
Example
Sample Request:
curl https://api15.comm100.io/v4/bot/chatbotCannedQuickReplies/1064a6e1-4485-4ef5-a7d3-000fc57cd598 \
-X
'DELETE'
\
-H
'Authorization: Bearer {access_token}'
\
Response:
HTTP/1.1 204 No Content