--- title: "Chatbot Intent" slug: "server-api-bot-chatbot-intent" updated: 2022-07-11T03:02:12Z published: 2022-07-11T03:02:12Z canonical: "developer.comm100.com/server-api-bot-chatbot-intent" --- > ## Documentation Index > Fetch the complete documentation index at: https://developer.comm100.com/llms.txt > Use this file to discover all available pages before exploring further. # Chatbot Intent ## Chatbot Intent - `Chatbot Intents` - Chatbot Intents Manage - `GET bot/chatbotIntents` - [Get the list of Chatbot Intents](/docs/server-api-bot-chatbot-intent#get-the-list-of-chatbot-intents) - `GET bot/chatbotIntents/{id}` - [Get a single Chatbot Intent](/docs/server-api-bot-chatbot-intent#get-a-single-chatbot-intent) - `POST bot/chatbotIntents` - [Create a new Chatbot Intent](/docs/server-api-bot-chatbot-intent#create-a-new-chatbot-intent) - `PUT bot/chatbotIntents/{id}` - [Update the Chatbot Intent](/docs/server-api-bot-chatbot-intent#update-the-chatbot-intent) - `DELETE bot/chatbotIntents/{id}` - [Remove the Chatbot Intent](/docs/server-api-bot-chatbot-intent#remove-the-chatbot-intent) ### Chatbot Intent JSON Format Chatbot Intent is represented as simple flat JSON objects with the following keys: | Name | Type | Description | | --- | --- | --- | | `id` | guid | Id of the intent. | | `name` | string | Name of the intent. | | `chatbotIntentCategoryId` | guid | Id of the intent category. | | `chatbotIntentCategory` | [chatbotIntentCategory](/docs/server-api-bot-chatbot-intent-category) | Reference to Chatbot Intent Category. | ### Chatbot Intent Prompt JSON Format: | Name | Type | Description | | --- | --- | --- | | `question` | string | Prompt question. | | `options` | string [] | Prompt options. | | `entityId` | guid | id of chatbot entity. | | `id` | guid | Id of the chatbot intent prompt. | | `prebuiltEntityId` | guid | Id of the prebuilt entity. | | `mappingFieldName` | string | Name of the mapping field. | | `variableName` | string | Name of the variable. | | `ifPrebuiltEntity` | bool | Whether the entity prebuilt or not. | | `chatbotIntentId` | guid | Id of the chatbot intent. | | `order` | integer | Must be greater than or equal to 0. | ### Get the list of Chatbot Intents `GET bot/chatbotIntents` - #### Parameters: | Name | Type | in | Required | Description | | --- | --- | --- | --- | --- | | `chatbotId` | guid | query | yes | Id of the chatbot. | | `keywords` | string | query | no | Search intents by the keyword. | | `chatbotintentcategoryid` | guid | query | no | Id of the category, filter by category. | | `include` | string | query | no | Allowed values are "chatbotIntentQuestion", "chatbotIntentAnswer", "chatbotIntentCategory", "chatbotIntentPrompt". | - #### Response: An array of [Chatbot Intent](/docs/server-api-bot-chatbot-intent#chatbot-intent-json-format) - #### Example Sample Request: ``` curl https://api11.comm100.io/v4/bot/chatbotIntents?chatbotId=f88320b9-6b57-408f-9056-d038c7870ae4 \ -X 'GET' \ -H 'Authorization: Bearer {access_token}' \ ``` Response: HTTP/1.1 200 OK ``` { "chatbotIntents": [ { "id": "54c51763-8241-40a7-bb61-95231a03bb86", "name": "Thanks", "chatbotIntentCategoryId": "3bfcf193-9939-4abd-a832-2625ea02e75b", "chatbotIntentCategory": { "id": "ee705b05-33c0-43b6-ab4a-a138f28b6aa2", "chatbotId": "e8bf0d25-eed6-4a46-a417-318e15019609", "name": "fruit", "order": 1, "parentId": "3bfcf193-9939-4abd-a832-2625ea02e75b" } } ], "nextPage": null, "previousPage": null, "total": 1 } ``` ### Get a single Chatbot Intent `GET bot/chatbotIntents/{id}` - #### Parameters: | Name | Type | in | Required | Description | | --- | --- | --- | --- | --- | | `include` | string | query | no | Allowed values are "chatbotIntentQuestion", "chatbotIntentAnswer", "chatbotIntentCategory", "chatbotIntentPrompt". | - #### Response: [Chatbot Intent](/docs/server-api-bot-chatbot-intent#chatbot-intent-json-format) - #### Example Sample Request: ``` curl https://api11.comm100.io/v4/bot/chatbotIntents/54c51763-8241-40a7-bb61-95231a03bb86 \ -X 'GET' \ -H 'Authorization: Bearer {access_token}' \ ``` Response: HTTP/1.1 200 OK ``` { "id": "54c51763-8241-40a7-bb61-95231a03bb86", "name": "Thanks", "chatbotIntentCategoryId": "3bfcf193-9939-4abd-a832-2625ea02e75b", "chatbotIntentCategory": { "id": "ee705b05-33c0-43b6-ab4a-a138f28b6aa2", "chatbotId": "e8bf0d25-eed6-4a46-a417-318e15019609", "name": "fruit", "order": 1, "parentId": "3bfcf193-9939-4abd-a832-2625ea02e75b" } } ``` ### Create a new Chatbot Intent `POST bot/chatbotIntents` - #### Parameters: | Name | Type | in | Required | Description | | --- | --- | --- | --- | --- | | `name` | string | body | yes | Name of the intent. | | `chatbotIntentCategoryId` | guid | body | yes | Id of the intent category. | | `chatbotIntentQuestions` | [chatbotIntentQuestions[]](/docs/server-api-bot-chatbot-intent-question) | body | no | Reference to Chatbot Intent Question. | | `chatbotIntentAnswers` | [chatbotIntentAnswers[]](/docs/server-api-bot-chatbot-intent-answer) | body | no | Reference to Chatbot Intent Answer. | | `chatbotIntentPrompts` | [chatbotIntentPrompts[]](/docs/server-api-bot-chatbot-intent#chatbot-intent-prompt-json-format) | body | no | Reference to Chatbot Intent Prompt. | - #### Response: [Chatbot Intent](/docs/server-api-bot-chatbot-intent#chatbot-intent-json-format) - #### Example Sample Request: ``` curl https://api11.comm100.io/v4/bot/chatbotIntents \ -X 'POST' \ -H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ -D '{"name":"Thanks","chatbotIntentCategoryId":"3bfcf193-9939-4abd-a832-2625ea02e75b","chatbotIntentQuestions":[{"order":0,"content":"Hello","chatbotIntentQuestionKeywords":[{"variableName":"color","startPosition":5,"endPosition":20,"ifPrebuiltEntity":false,"prebuiltEntityId":"00000000-0000-0000-0000-000000000000","entityId":"d394618e-6c2a-444f-b4b3-5b88ed2466ad"}]}],"chatbotIntentAnswers":[{"channelId":"Live Chat","order":0,"collectInfoType":"form","chatbotResponseId":"ecd57b2b-2a7a-4059-8e63-ad5c8e291048","chatbotResponse":{"chatbotActions":[{"xPosition":50,"yPosition":50,"type":"chatbotActionStart","chatbotActionSalesforceFindRecordBySoql":{"soql":"","failedActionId":"bbec7c36-9c72-4789-8e07-8951c22eb945","successedActionId":"bbec7c36-9c72-4789-8e07-8951c22eb945","chatbotActionSalesforceFindRecordFieldBySoqls":[{"fieldName":"","saveToVariable":""}]},"chatbotActionTransferChat":{"transferTo":"87AD4BE9-89F5-4E57-AE9E-2D5FEE8ED3E5","whenAgentOfflineToActionId":"00000000-0000-0000-0000-000000000000","type":"transferToAgent"},"chatbotActionSendMessage":{"nextActionId":"00000000-0000-0000-0000-000000000000","variants":[""],"message":"Hi there! I'm a chatbot, here to help answer your questions.","typingDelay":0.0,"chatbotActionSendMessageLinks":[{"buttonText":"twitter","type":"webview","openIn":"sideWindow","intentId":"00000000-0000-0000-0000-000000000000","url":"https://www.baidu.com","openStyle":"compact","order":0}]},"chatbotActionCollectPhoneNumber":{"nextActionId":"AA310D7E-24AB-422E-8976-B83336700527","isInputAreaEnabled":true,"message":"What's your phone number?","typingDelay":1.0},"chatbotActionSalesforceCreateRecord":{"saveRecordIdToVariable":"","nextActionId":"bbec7c36-9c72-4789-8e07-8951c22eb945","ifUpdateDuplicatedRecord":true,"object":"","chatbotActionSalesforceCreateRecordFields":[{"fieldValue":"","fieldName":""}]},"chatbotActionCollectName":{"isInputAreaEnabled":true,"typingDelay":1.0,"message":"What's your name?","nextActionId":"00000000-0000-0000-0000-000000000000"},"chatbotActionWebhook":{"ifSendChatTranscript":false,"url":"www.baidu.com","otherResponseToActionId":"00000000-0000-0000-0000-000000000000","additionalPostBody":"","chatbotActionWebhookResponseToVariables":[{"order":0,"responseKey":"fdafa","variableName":"2342432432132131"}],"chatbotActionWebhookHeaders":[{"value":"v1","order":0,"key":"k1"}],"chatbotActionWebhookResponseCodeToActions":[{"responseCode":"200","nextActionId":"00000000-0000-0000-0000-000000000000","order":0}]},"chatbotActionGoToTaskbot":{"taskbotId":"F198799B-F8DE-40B4-94A9-004848BE0918"},"chatbotActionSendCannedQuickReply":{"cannedQuickReplyId":"D62DE3F6-A55E-4AB2-9DA3-2AF33849306D","message":"","isInputAreaEnabled":true,"anyOtherResponseActionId":"00000000-0000-0000-0000-000000000000","typingDelay":0.0},"chatbotActionSendImage":{"message":"","typingDelay":0.0,"imageUrl":"","nextActionId":"CC5AF23C-CCA4-4D2D-B25A-4BF891275F30","image":""},"chatbotActionGoToIntent":{"intentId":"4C36FC4D-9CEC-4AB4-9F00-8D8B20EA47A8"},"chatbotActionDynamics365FindRecord":{"successedActionId":"bbec7c36-9c72-4789-8e07-8951c22eb945","searchValue":"","fieldToSearchBy":"","entitySetName":"","failedActionId":"bbec7c36-9c72-4789-8e07-8951c22eb945","entity":"","chatbotActionDynamics365FindRecordFields":[{"saveToVariable":"","fieldName":""}]},"chatbotActionSSOLoginButton":{"typingDelay":0.0,"isInputAreaEnabled":true,"successedActionId":"03DF237A-7F5F-45A8-A44C-042CD9D85E0C","message":"signin message sso","failedActionId":"00000000-0000-0000-0000-000000000000","loginButtonText":"signin-text sso"},"chatbotActionLeaveChat":{},"chatbotActionSendVideo":{"typingDelay":0.0,"message":"","nextActionId":"00000000-0000-0000-0000-000000000000","videoUrl":"https://www.youtube.com/watch?v=0XYWpraTgaY"},"chatbotActionCollectEmail":{"message":"What's your email?","typingDelay":1.0,"isInputAreaEnabled":false,"nextActionId":"478EE923-458A-4EAA-A698-98DDB64DCF19"},"chatbotActionCondition":{"otherCaseActionId":"00000000-0000-0000-0000-000000000000","chatbotActionConditionCases":[{"order":0,"logicalExpression":"","goToActionId":"00000000-0000-0000-0000-000000000000","conditionExpressionType":"all","chatbotActionConditionCaseConditions":[{"order":0,"operator":"is","value":"fdsfsdaf","fieldName":"{!Variable.Name}"}]}]},"chatbotActionBookMeeting":{"failedActionId":"00000000-0000-0000-0000-000000000000","calendlyEventTypeUri":"http://localhost/event_types/15","successedActionId":"00000000-0000-0000-0000-000000000000","integrationCalendlyId":"7E8DFDA2-2117-4796-93D0-8A51047CE1BC"},"chatbotActionSendForm":{"title":"Via a Form title","message":"Via a Form","successedActionId":"32A2B481-DC43-47B4-9B12-60E128347B16","isConfirmationRequired":false,"submitButtonText":"Text on the Submit Button in the Form: Submit","isInputAreaEnabled":true,"confirmButtonText":"Text on the Confirm Button in the Form: Confirm","typingDelay":0.0,"cancelButtonText":"Text on the Cancel Button in the Form: Cancel","failedActionId":"00000000-0000-0000-0000-000000000000","chatbotActionSendFormFields":[{"options":[""],"type":"text","entityId":"00000000-0000-0000-0000-000000000000","variableName":"","ifPrebuiltEntity":true,"isMasked":true,"isRequired":true,"name":"test","order":0,"prebuiltEntityId":"00000000-0000-0000-0000-000000000000"}]},"chatbotActionSendNumericMenu":{"isInputAreaEnabled":true,"otherResponseToActionId":"00000000-0000-0000-0000-000000000000","message":"hello","chatbotActionSendNumericMenuOptions":[{"nextActionId":"C8A26362-6823-4497-89B3-B54B06B2379A","key":"3","order":0,"text":"test"}]},"chatbotActionCollectVariableData":{"typingDelay":1.0,"nextActionId":"18DAA6C1-7468-471D-BB30-E7AE0BE09FFC","variableName":"text","options":[],"isInputAreaEnabled":false,"message":"text","type":"text"},"chatbotActionSetVariableValue":{"fieldId":"00000000-0000-0000-0000-000000000000","value":"1111","customVariableId":"6B2D7C50-300B-4708-B913-086BE822F368","nextActionId":"6F7ED3FD-5C77-4512-AA8B-F5F452575656","ticketingFieldId":"110499d0-5a3e-469f-b8de-9a34e99092b0","variable":"","saveToType":"customVariable"},"chatbotActionDynamics365FindRecordByFetchXml":{"entitySetName":"","fetchXml":"","entity":"","successedActionId":"bbec7c36-9c72-4789-8e07-8951c22eb945","failedActionId":"bbec7c36-9c72-4789-8e07-8951c22eb945","chatbotActionDynamics365FindRecordFieldByFetchXmls":[{"saveToVariable":"","fieldName":""}]},"chatbotActionSendEmail":{"to":"Simon","subject":"API Test","cc":"jansemain","content":"Delete","nextActionId":"60F2F597-5674-41D8-BBFD-0AEAAF787837"},"chatbotActionCollectComment":{"typingDelay":1.0,"nextActionId":"00000000-0000-0000-0000-000000000000","isInputAreaEnabled":false,"message":"What's your comment?"},"chatbotActionChangeAssignee":{"whenAgentOfflineToActionId":"00000000-0000-0000-0000-000000000000","type":"transferToAgent","transferTo":"6CC96F38-5FE2-448C-AFBB-3F3D109CF022"},"chatbotActionCollectCompanyName":{"isInputAreaEnabled":false,"typingDelay":1.0,"message":"What's your company name?","nextActionId":"478EE923-458A-4EAA-A698-98DDB64DCF19"},"chatbotActionTransferZendeskChat":{"transferTo":"","type":"","whenAgentOfflineToActionId":"bbec7c36-9c72-4789-8e07-8951c22eb945"},"chatbotActionStart":{"nextActionId":"ea5369ae-b5cf-4bfa-a5fa-9dac234cf4c5"},"chatbotActionCollectLocation":{"buttonText":"Text on the Send Location Button: Send Location","isInputAreaEnabled":true,"message":"What's your email?","typingDelay":1.0,"successedActionId":"D4247757-441E-44E7-AA0A-8197FE123B28","failedActionId":"00000000-0000-0000-0000-000000000000"},"chatbotActionSalesforceFindRecord":{"fieldToSearchBy":"","object":"","failedActionId":"bbec7c36-9c72-4789-8e07-8951c22eb945","searchValue":"","successedActionId":"bbec7c36-9c72-4789-8e07-8951c22eb945","chatbotActionSalesforceFindRecordFields":[{"saveToVariable":"","fieldName":""}]},"chatbotActionDynamics365CreateRecord":{"ifUpdateDuplicatedRecord":true,"saveRecordIdToVariable":"","nextActionId":"bbec7c36-9c72-4789-8e07-8951c22eb945","entity":"","entitySetName":"","chatbotActionDynamics365CreateRecordFields":[{"fieldName":"","fieldValue":""}]},"chatbotActionContactAgent":{"message":"I'm sorry, I haven't been trained to answer that question yet! Try asking me a different question, or use the button below to connect with a live agent.","optionTextWhenAgentOffline":"Chat with Live Agent","optionTextWhenAgentOnline":"Chat with Live Agent","typingDelay":0.0},"chatbotActionQuickReply":{"typingDelay":0.0,"otherResponseToActionId":"00000000-0000-0000-0000-000000000000","isInputAreaEnabled":true,"message":"custom qp-have message","chatbotActionQuickReplyOptions":[{"order":0,"nextActionId":"177C7AE7-B792-420C-82D3-563564B8647D","text":"goto taskbot "}]}}]}}],"chatbotIntentPrompts":[{"question":"which type","options":["ham","hawayi","pepperoni|{!CustomVariable.aaa}"],"entityId":"00000000-0000-0000-0000-000000000000","prebuiltEntityId":"00000000-0000-0000-0000-000000000000","mappingFieldName":"","variableName":"pizza_type","ifPrebuiltEntity":true,"order":0}]}' ``` Response: HTTP/1.1 201 Created ``` { "id": "54c51763-8241-40a7-bb61-95231a03bb86", "name": "Thanks", "chatbotIntentCategoryId": "3bfcf193-9939-4abd-a832-2625ea02e75b", "chatbotIntentCategory": { "id": "ee705b05-33c0-43b6-ab4a-a138f28b6aa2", "chatbotId": "e8bf0d25-eed6-4a46-a417-318e15019609", "name": "fruit", "order": 1, "parentId": "3bfcf193-9939-4abd-a832-2625ea02e75b" } } ``` ### Update the Chatbot Intent `PUT bot/chatbotIntents/{id}` - #### Parameters: | Name | Type | in | Required | Description | | --- | --- | --- | --- | --- | | `name` | string | body | yes | Name of the intent. | | `chatbotIntentCategoryId` | guid | body | no | Id of the intent category. | | `chatbotIntentQuestions` | [chatbotIntentQuestions[]](/docs/server-api-bot-chatbot-intent-question) | body | no | Reference to Chatbot Intent Question. | | `chatbotIntentAnswers` | [chatbotIntentAnswers[]](/docs/server-api-bot-chatbot-intent-answer) | body | no | Reference to Chatbot Intent Answer. | | `chatbotIntentPrompts` | [chatbotIntentPrompts[]](/docs/server-api-bot-chatbot-intent#chatbot-intent-prompt-json-format) | body | no | Reference to Chatbot Intent Prompt. | - #### Response: [Chatbot Intent](/docs/server-api-bot-chatbot-intent#chatbot-intent-json-format) - #### Example Sample Request: ``` curl https://api11.comm100.io/v4/bot/chatbotIntents/54c51763-8241-40a7-bb61-95231a03bb86 \ -X 'PUT' \ -H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ -D '{"name":"Thanks","chatbotIntentCategoryId":"3bfcf193-9939-4abd-a832-2625ea02e75b","chatbotIntentQuestions":[{"order":0,"content":"Hello","chatbotIntentQuestionKeywords":[{"variableName":"color","startPosition":5,"endPosition":20,"ifPrebuiltEntity":false,"prebuiltEntityId":"00000000-0000-0000-0000-000000000000","entityId":"d394618e-6c2a-444f-b4b3-5b88ed2466ad"}]}],"chatbotIntentAnswers":[{"channelId":"Live Chat","order":0,"collectInfoType":"form","chatbotResponseId":"ecd57b2b-2a7a-4059-8e63-ad5c8e291048","chatbotResponse":{"chatbotActions":[{"xPosition":50,"yPosition":50,"type":"chatbotActionStart","chatbotActionSalesforceFindRecordBySoql":{"soql":"","failedActionId":"bbec7c36-9c72-4789-8e07-8951c22eb945","successedActionId":"bbec7c36-9c72-4789-8e07-8951c22eb945","chatbotActionSalesforceFindRecordFieldBySoqls":[{"fieldName":"","saveToVariable":""}]},"chatbotActionTransferChat":{"transferTo":"87AD4BE9-89F5-4E57-AE9E-2D5FEE8ED3E5","whenAgentOfflineToActionId":"00000000-0000-0000-0000-000000000000","type":"transferToAgent"},"chatbotActionSendMessage":{"nextActionId":"00000000-0000-0000-0000-000000000000","variants":[""],"message":"Hi there! I'm a chatbot, here to help answer your questions.","typingDelay":0.0,"chatbotActionSendMessageLinks":[{"buttonText":"twitter","type":"webview","openIn":"sideWindow","intentId":"00000000-0000-0000-0000-000000000000","url":"https://www.baidu.com","openStyle":"compact","order":0}]},"chatbotActionCollectPhoneNumber":{"nextActionId":"AA310D7E-24AB-422E-8976-B83336700527","isInputAreaEnabled":true,"message":"What's your phone number?","typingDelay":1.0},"chatbotActionSalesforceCreateRecord":{"saveRecordIdToVariable":"","nextActionId":"bbec7c36-9c72-4789-8e07-8951c22eb945","ifUpdateDuplicatedRecord":true,"object":"","chatbotActionSalesforceCreateRecordFields":[{"fieldValue":"","fieldName":""}]},"chatbotActionCollectName":{"isInputAreaEnabled":true,"typingDelay":1.0,"message":"What's your name?","nextActionId":"00000000-0000-0000-0000-000000000000"},"chatbotActionWebhook":{"ifSendChatTranscript":false,"url":"www.baidu.com","otherResponseToActionId":"00000000-0000-0000-0000-000000000000","additionalPostBody":"","chatbotActionWebhookResponseToVariables":[{"order":0,"responseKey":"fdafa","variableName":"2342432432132131"}],"chatbotActionWebhookHeaders":[{"value":"v1","order":0,"key":"k1"}],"chatbotActionWebhookResponseCodeToActions":[{"responseCode":"200","nextActionId":"00000000-0000-0000-0000-000000000000","order":0}]},"chatbotActionGoToTaskbot":{"taskbotId":"F198799B-F8DE-40B4-94A9-004848BE0918"},"chatbotActionSendCannedQuickReply":{"cannedQuickReplyId":"D62DE3F6-A55E-4AB2-9DA3-2AF33849306D","message":"","isInputAreaEnabled":true,"anyOtherResponseActionId":"00000000-0000-0000-0000-000000000000","typingDelay":0.0},"chatbotActionSendImage":{"message":"","typingDelay":0.0,"imageUrl":"","nextActionId":"CC5AF23C-CCA4-4D2D-B25A-4BF891275F30","image":""},"chatbotActionGoToIntent":{"intentId":"4C36FC4D-9CEC-4AB4-9F00-8D8B20EA47A8"},"chatbotActionDynamics365FindRecord":{"successedActionId":"bbec7c36-9c72-4789-8e07-8951c22eb945","searchValue":"","fieldToSearchBy":"","entitySetName":"","failedActionId":"bbec7c36-9c72-4789-8e07-8951c22eb945","entity":"","chatbotActionDynamics365FindRecordFields":[{"saveToVariable":"","fieldName":""}]},"chatbotActionSSOLoginButton":{"typingDelay":0.0,"isInputAreaEnabled":true,"successedActionId":"03DF237A-7F5F-45A8-A44C-042CD9D85E0C","message":"signin message sso","failedActionId":"00000000-0000-0000-0000-000000000000","loginButtonText":"signin-text sso"},"chatbotActionLeaveChat":{},"chatbotActionSendVideo":{"typingDelay":0.0,"message":"","nextActionId":"00000000-0000-0000-0000-000000000000","videoUrl":"https://www.youtube.com/watch?v=0XYWpraTgaY"},"chatbotActionCollectEmail":{"message":"What's your email?","typingDelay":1.0,"isInputAreaEnabled":false,"nextActionId":"478EE923-458A-4EAA-A698-98DDB64DCF19"},"chatbotActionCondition":{"otherCaseActionId":"00000000-0000-0000-0000-000000000000","chatbotActionConditionCases":[{"order":0,"logicalExpression":"","goToActionId":"00000000-0000-0000-0000-000000000000","conditionExpressionType":"all","chatbotActionConditionCaseConditions":[{"order":0,"operator":"is","value":"fdsfsdaf","fieldName":"{!Variable.Name}"}]}]},"chatbotActionBookMeeting":{"failedActionId":"00000000-0000-0000-0000-000000000000","calendlyEventTypeUri":"http://localhost/event_types/15","successedActionId":"00000000-0000-0000-0000-000000000000","integrationCalendlyId":"7E8DFDA2-2117-4796-93D0-8A51047CE1BC"},"chatbotActionSendForm":{"title":"Via a Form title","message":"Via a Form","successedActionId":"32A2B481-DC43-47B4-9B12-60E128347B16","isConfirmationRequired":false,"submitButtonText":"Text on the Submit Button in the Form: Submit","isInputAreaEnabled":true,"confirmButtonText":"Text on the Confirm Button in the Form: Confirm","typingDelay":0.0,"cancelButtonText":"Text on the Cancel Button in the Form: Cancel","failedActionId":"00000000-0000-0000-0000-000000000000","chatbotActionSendFormFields":[{"options":[""],"type":"text","entityId":"00000000-0000-0000-0000-000000000000","variableName":"","ifPrebuiltEntity":true,"isMasked":true,"isRequired":true,"name":"test","order":0,"prebuiltEntityId":"00000000-0000-0000-0000-000000000000"}]},"chatbotActionSendNumericMenu":{"isInputAreaEnabled":true,"otherResponseToActionId":"00000000-0000-0000-0000-000000000000","message":"hello","chatbotActionSendNumericMenuOptions":[{"nextActionId":"C8A26362-6823-4497-89B3-B54B06B2379A","key":"3","order":0,"text":"test"}]},"chatbotActionCollectVariableData":{"typingDelay":1.0,"nextActionId":"18DAA6C1-7468-471D-BB30-E7AE0BE09FFC","variableName":"text","options":[],"isInputAreaEnabled":false,"message":"text","type":"text"},"chatbotActionSetVariableValue":{"fieldId":"00000000-0000-0000-0000-000000000000","value":"1111","customVariableId":"6B2D7C50-300B-4708-B913-086BE822F368","nextActionId":"6F7ED3FD-5C77-4512-AA8B-F5F452575656","ticketingFieldId":"110499d0-5a3e-469f-b8de-9a34e99092b0","variable":"","saveToType":"customVariable"},"chatbotActionDynamics365FindRecordByFetchXml":{"entitySetName":"","fetchXml":"","entity":"","successedActionId":"bbec7c36-9c72-4789-8e07-8951c22eb945","failedActionId":"bbec7c36-9c72-4789-8e07-8951c22eb945","chatbotActionDynamics365FindRecordFieldByFetchXmls":[{"saveToVariable":"","fieldName":""}]},"chatbotActionSendEmail":{"to":"Simon","subject":"API Test","cc":"jansemain","content":"Delete","nextActionId":"60F2F597-5674-41D8-BBFD-0AEAAF787837"},"chatbotActionCollectComment":{"typingDelay":1.0,"nextActionId":"00000000-0000-0000-0000-000000000000","isInputAreaEnabled":false,"message":"What's your comment?"},"chatbotActionChangeAssignee":{"whenAgentOfflineToActionId":"00000000-0000-0000-0000-000000000000","type":"transferToAgent","transferTo":"6CC96F38-5FE2-448C-AFBB-3F3D109CF022"},"chatbotActionCollectCompanyName":{"isInputAreaEnabled":false,"typingDelay":1.0,"message":"What's your company name?","nextActionId":"478EE923-458A-4EAA-A698-98DDB64DCF19"},"chatbotActionTransferZendeskChat":{"transferTo":"","type":"","whenAgentOfflineToActionId":"bbec7c36-9c72-4789-8e07-8951c22eb945"},"chatbotActionStart":{"nextActionId":"ea5369ae-b5cf-4bfa-a5fa-9dac234cf4c5"},"chatbotActionCollectLocation":{"buttonText":"Text on the Send Location Button: Send Location","isInputAreaEnabled":true,"message":"What's your email?","typingDelay":1.0,"successedActionId":"D4247757-441E-44E7-AA0A-8197FE123B28","failedActionId":"00000000-0000-0000-0000-000000000000"},"chatbotActionSalesforceFindRecord":{"fieldToSearchBy":"","object":"","failedActionId":"bbec7c36-9c72-4789-8e07-8951c22eb945","searchValue":"","successedActionId":"bbec7c36-9c72-4789-8e07-8951c22eb945","chatbotActionSalesforceFindRecordFields":[{"saveToVariable":"","fieldName":""}]},"chatbotActionDynamics365CreateRecord":{"ifUpdateDuplicatedRecord":true,"saveRecordIdToVariable":"","nextActionId":"bbec7c36-9c72-4789-8e07-8951c22eb945","entity":"","entitySetName":"","chatbotActionDynamics365CreateRecordFields":[{"fieldName":"","fieldValue":""}]},"chatbotActionContactAgent":{"message":"I'm sorry, I haven't been trained to answer that question yet! Try asking me a different question, or use the button below to connect with a live agent.","optionTextWhenAgentOffline":"Chat with Live Agent","optionTextWhenAgentOnline":"Chat with Live Agent","typingDelay":0.0},"chatbotActionQuickReply":{"typingDelay":0.0,"otherResponseToActionId":"00000000-0000-0000-0000-000000000000","isInputAreaEnabled":true,"message":"custom qp-have message","chatbotActionQuickReplyOptions":[{"order":0,"nextActionId":"177C7AE7-B792-420C-82D3-563564B8647D","text":"goto taskbot "}]}}]}}],"chatbotIntentPrompts":[{"question":"which type","options":["ham","hawayi","pepperoni|{!CustomVariable.aaa}"],"entityId":"00000000-0000-0000-0000-000000000000","prebuiltEntityId":"00000000-0000-0000-0000-000000000000","mappingFieldName":"","variableName":"pizza_type","ifPrebuiltEntity":true,"order":0}]}' ``` Response: HTTP/1.1 200 OK ``` { "id": "54c51763-8241-40a7-bb61-95231a03bb86", "name": "Thanks", "chatbotIntentCategoryId": "3bfcf193-9939-4abd-a832-2625ea02e75b", "chatbotIntentCategory": { "id": "ee705b05-33c0-43b6-ab4a-a138f28b6aa2", "chatbotId": "e8bf0d25-eed6-4a46-a417-318e15019609", "name": "fruit", "order": 1, "parentId": "3bfcf193-9939-4abd-a832-2625ea02e75b" } } ``` ### Remove the Chatbot Intent `DELETE bot/chatbotIntents/{id}` - #### Parameters: No Parameters - #### Response: No Content - #### Example Sample Request: ``` curl https://api11.comm100.io/v4/bot/chatbotIntents/54c51763-8241-40a7-bb61-95231a03bb86 \ -X 'DELETE' \ -H 'Authorization: Bearer {access_token}' \ ``` Response: HTTP/1.1 204 No Content