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. |
GET bot/chatbotCannedQuickReplies/{id}
Name | Type | In | Required | Description |
---|---|---|---|---|
include |
string | query | no | Allowed values are "chatbotCannedQuickReplyItem", "chatbotIntent". |
Sample Request:
Response:
HTTP/1.1 200 OK
GET bot/chatbots/{id}/chatbotCannedQuickReplies
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". |
An array of Bot_ChatbotCannedQuickReply
Sample Request:
Response:
HTTP/1.1 200 OK
POST bot/chatbotCannedQuickReplies
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. |
Sample Request:
Response:
HTTP/1.1 201 Created
PUT bot/chatbotCannedQuickReplies/{id}
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. |
Sample Request:
Response:
HTTP/1.1 200 OK
DELETE bot/chatbotCannedQuickReplies/{id}
No Content
Sample Request:
Response:
HTTP/1.1 204 No Content