--- title: "Chatbot Intent Answer" slug: "server-api-bot-chatbot-intent-answer" updated: 2022-07-14T05:36:28Z published: 2022-07-14T05:36:28Z canonical: "developer.comm100.com/server-api-bot-chatbot-intent-answer" --- > ## 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 Answer ## Chatbot Intent Answer - `Chatbot Intent Answers` - Chatbot Intent Answers Manage - `GET bot/chatbotIntentAnswers` - [Get the list of Chatbot Intent Answers](/docs/server-api-bot-chatbot-intent-answer#get-the-list-of-chatbot-intent-answers) - `GET bot/chatbotIntentAnswers/{id}` - [Get a single Chatbot Intent Answer](/docs/server-api-bot-chatbot-intent-answer#get-a-single-chatbot-intent-answer) - `POST bot/chatbotIntentAnswers` - [Create a new Chatbot Intent Answer](/docs/server-api-bot-chatbot-intent-answer#create-a-new-chatbot-intent-answer) - `PUT bot/chatbotIntentAnswers/{id}` - [Update the Chatbot Intent Answer](/docs/server-api-bot-chatbot-intent-answer#update-the-chatbot-intent-answer) - `DELETE bot/chatbotIntentAnswers/{id}` - [Remove the Chatbot Intent Answer](/docs/server-api-bot-chatbot-intent-answer#remove-the-chatbot-intent-answer) ### Chatbot Intent Answer JSON Format Chatbot Intent Answer is represented as simple flat JSON objects with the following keys: | Name | Type | Description | | --- | --- | --- | | `id` | guid | Id of the intent answer. | | `intentId` | guid | Id of the intent. | | `channelId` | string | Channel: Live Chat, Facebook Messenger, Twitter Direct Message, WeChat, WhatsApp, SMS. | | `order` | integer | Must be greater than or equal to 0, ascending order. | | `collectInfoType` | enum | Allowed values are `none`, `form`, `prompt`. | | `chatbotResponseId` | guid | Id of the chatbot response. | | `chatbotResponse` | [chatbotResponse](/docs/server-api-bot-chatbot-intent-answer#chatbot-response-json-format) | Reference to Chatbot Response. | ### Chatbot Response JSON Format: | Name | Type | Description | | --- | --- | --- | | `id` | guid | Id of the chatbotResponse. | | `chatbotActions` | [chatbotActions[]](/docs/server-api-bot-chatbot-intent-answer#chatbot-action-json-format) | Reference to Chatbot Action. | ### Chatbot Action JSON Format: | Name | Type | Description | | --- | --- | --- | | `xPosition` | integer | The action's xPosition (in pixel) in the diagram. | | `yPosition` | integer | The action's yPosition (in pixel) in the diagram. | | `id` | guid | Id of the chatbot action. | | `type` | enum | Allowed values are `chatbotActionSendIVRMenu`, `chatbotActionStart`, `chatbotActionSendVideo`, `chatbotActionTransferChat`, `chatbotActionQuickReply`, `chatbotActionChangeAssignee`, `chatbotActionSalesforceFindRecordBySoql`, `chatbotActionGoToTaskbot`, `chatbotActionCollectVariableData`, `chatbotActionSendImage`, `chatbotActionDynamics365FindRecordByFetchXml`, `chatbotActionCollectLocation`, `chatbotActionSendForm`, `chatbotActionWebhook`, `chatbotActionSendEmail`, `chatbotActionSendCannedQuickReply`, `chatbotActionLeaveChat`, `chatbotActionCollectPhoneNumber`, `chatbotActionGoToIntent`, `chatbotActionSetVariableValue`, `chatbotActionDynamics365CreateRecord`, `chatbotActionCollectEmail`, `chatbotActionTransferZendeskChat`, `chatbotActionContactAgent`, `chatbotActionCollectComment`, `chatbotActionTransferCall`, `chatbotActionDynamics365FindRecord`, `chatbotActionBookMeeting`, `chatbotActionCollectCompanyName`, `chatbotActionSaveValueToField`, `chatbotActionSendMessage`, `chatbotActionSalesforceCreateRecord`, `chatbotActionSSOLoginButton`, `chatbotActionSendNumericMenu`, `chatbotActionCollectName`, `chatbotActionCondition`, `chatbotActionSalesforceFindRecord`. | | `chatbotResponseId` | guid | Id of the chatbot response. | | `chatbotActionStart` | [chatbotActionStart](/docs/server-api-bot-chatbot-intent-answer#chatbot-action-start-json-format) | Reference to Chatbot Action Start. | | `chatbotActionCollectComment` | [chatbotActionCollectComment](/docs/server-api-bot-chatbot-intent-answer#chatbot-action-collect-comment-json-format) | Reference to Chatbot Action Collect Comment. | | `chatbotActionCollectCompanyName` | [chatbotActionCollectCompanyName](/docs/server-api-bot-chatbot-intent-answer#chatbot-action-collect-company-name-json-format) | Reference to Chatbot Action Collect Company Name. | | `chatbotActionCollectEmail` | [chatbotActionCollectEmail](/docs/server-api-bot-chatbot-intent-answer#chatbot-action-collect-email-json-format) | Reference to Chatbot Action Collect Email. | | `chatbotActionCollectLocation` | [chatbotActionCollectLocation](/docs/server-api-bot-chatbot-intent-answer#chatbot-action-collect-location-json-format) | Reference to Chatbot Action Collect Location. | | `chatbotActionCollectName` | [chatbotActionCollectName](/docs/server-api-bot-chatbot-intent-answer#chatbot-action-collect-name-json-format) | Reference to Chatbot Action Collect Name. | | `chatbotActionCollectPhoneNumber` | [chatbotActionCollectPhoneNumber](/docs/server-api-bot-chatbot-intent-answer#chatbot-action-collect-phone-number-json-format) | Reference to Chatbot Action Collect Phone Number. | | `chatbotActionCollectVariableData` | [chatbotActionCollectVariableData](/docs/server-api-bot-chatbot-intent-answer#chatbot-action-collect-variable-data-json-format) | Reference to Chatbot Action Collect Variable Data. | | `chatbotActionGoToTaskbot` | [chatbotActionGoToTaskbot](/docs/server-api-bot-chatbot-intent-answer#chatbot-action-go-to-taskbot-json-format) | Reference to Chatbot Action Go To Taskbot. | | `chatbotActionQuickReply` | [chatbotActionQuickReply](/docs/server-api-bot-chatbot-intent-answer#chatbot-action-quick-reply-json-format) | Reference to Chatbot Action Quick Reply. | | `chatbotActionSendImage` | [chatbotActionSendImage](/docs/server-api-bot-chatbot-intent-answer#chatbot-action-send-image-json-format) | Reference to Chatbot Action Send Image. | | `chatbotActionSendMessage` | [chatbotActionSendMessage](/docs/server-api-bot-chatbot-intent-answer#chatbot-action-send-message-json-format) | Reference to Chatbot Action Send Message. | | `chatbotActionSendVideo` | [chatbotActionSendVideo](/docs/server-api-bot-chatbot-intent-answer#chatbot-action-send-video-json-format) | Reference to Chatbot Action Send Video. | | `chatbotActionSSOLoginButton` | [chatbotActionSSOLoginButton](/docs/server-api-bot-chatbot-intent-answer#chatbot-action-sso-login-button-json-format) | Reference to Chatbot Action SSO Login Button. | | `chatbotActionTransferChat` | [chatbotActionTransferChat](/docs/server-api-bot-chatbot-intent-answer#chatbot-action-transfer-chat-json-format) | Reference to Chatbot Action Transfer Chat. | | `chatbotActionWebhook` | [chatbotActionWebhook](/docs/server-api-bot-chatbot-intent-answer#chatbot-action-webhook-json-format) | Reference to Chatbot Action Webhook. | | `chatbotActionSendEmail` | [chatbotActionSendEmail](/docs/server-api-bot-chatbot-intent-answer#chatbot-action-send-email-json-format) | Reference to Chatbot Action Send Email. | | `chatbotActionBookMeeting` | [chatbotActionBookMeeting](/docs/server-api-bot-chatbot-intent-answer#chatbot-action-book-meeting-json-format) | Reference to Chatbot Action Book Meeting. | | `chatbotActionSendForm` | [chatbotActionSendForm](/docs/server-api-bot-chatbot-intent-answer#chatbot-action-send-form-json-format) | Reference to Chatbot Action Send Form. | | `chatbotActionContactAgent` | [chatbotActionContactAgent](/docs/server-api-bot-chatbot-intent-answer#chatbot-action-contact-agent-json-format) | Reference to Chatbot Action Contact Agent. | | `chatbotActionSendCannedQuickReply` | [chatbotActionSendCannedQuickReply](/docs/server-api-bot-chatbot-intent-answer#chatbot-action-send-canned-quick-reply-json-format) | Reference to Chatbot Action Send Canned Quick Reply. | | `chatbotActionSetVariableValue` | [chatbotActionSetVariableValue](/docs/server-api-bot-chatbot-intent-answer#chatbot-action-set-variable-value-json-format) | Reference to Chatbot Action Set Variable Value. | | `chatbotActionGoToIntent` | [chatbotActionGoToIntent](/docs/server-api-bot-chatbot-intent-answer#chatbot-action-go-to-intent-json-format) | Reference to Chatbot Action Go To Intent. | | `chatbotActionLeaveChat` | [chatbotActionLeaveChat](/docs/server-api-bot-chatbot-intent-answer#chatbot-action-leave-chat-json-format) | Reference to Chatbot Action Leave Chat. | | `chatbotActionSendNumericMenu` | [chatbotActionSendNumericMenu](/docs/server-api-bot-chatbot-intent-answer#chatbot-action-send-numberic-menu-json-format) | Reference to Chatbot Action Send Numberic Menu. | | `chatbotActionChangeAssignee` | [chatbotActionChangeAssignee](/docs/server-api-bot-chatbot-intent-answer#chatbot-action-change-assignee-json-format) | Reference to Chatbot Action Change Assignee. | | `chatbotActionCondition` | [chatbotActionCondition](/docs/server-api-bot-chatbot-intent-answer#chatbot-action-condition-json-format) | Reference to Chatbot Action Condition. | | `chatbotActionTransferZendeskChat` | [chatbotActionTransferZendeskChat](/docs/server-api-bot-chatbot-intent-answer#chatbot-action-transfer-zendesk-chat-json-format) | Reference to Chatbot Action Transfer Zendesk Chat. | | `chatbotActionSalesforceCreateRecord` | [chatbotActionSalesforceCreateRecord](/docs/server-api-bot-chatbot-intent-answer#chatbot-action-salesforce-create-record-json-format) | Reference to Chatbot Action Salesforce Create Record. | | `chatbotActionSalesforceFindRecord` | [chatbotActionSalesforceFindRecord](/docs/server-api-bot-chatbot-intent-answer#chatbot-action-salesforce-find-record-json-format) | Reference to Chatbot Action Salesforce Find Record. | | `chatbotActionSalesforceFindRecordBySoql` | [chatbotActionSalesforceFindRecordBySoql](/docs/server-api-bot-chatbot-intent-answer#chatbot-action-salesforce-find-record-by-soql-json-format) | Reference to Chatbot Action Salesforce Find Record By Soql. | | `chatbotActionDynamics365CreateRecord` | [chatbotActionDynamics365CreateRecord](/docs/server-api-bot-chatbot-intent-answer#chatbot-action-dynamics365-create-record-json-format) | Reference to Chatbot Action Dynamics 365 Create Record. | | `chatbotActionDynamics365FindRecord` | [chatbotActionDynamics365FindRecord](/docs/server-api-bot-chatbot-intent-answer#chatbot-action-dynamics365-find-record-json-format) | Reference to Chatbot Action Dynamics 365 Find Record. | | `chatbotActionDynamics365FindRecordByFetchXml` | [chatbotActionDynamics365FindRecordByFetchXm](/docs/server-api-bot-chatbot-intent-answer#chatbot-action-dynamics365-find-record-by-fetch-xml-json-format) | Reference to Chatbot Action Dynamics 365 Find Record By FetchXml. | ### Chatbot Action Start JSON Format: | Name | Type | Description | | --- | --- | --- | | `chatbotActionId` | guid | Id of the chatbot action. | | `nextActionId` | guid | Id of the next chatbot action. | ### Chatbot Action Collect Comment JSON Format: | Name | Type | Description | | --- | --- | --- | | `typingDelay` | float | TypingDelay is only available when channel is Live Chat. The typing delay in seconds before this message is shown in chat window. | | `chatbotActionId` | guid | Id of the chatbot action. | | `nextActionId` | guid | Id of the next chatbot action. | | `isInputAreaEnabled` | bool | Whether the input area is enabled or not. | | `message` | string | Message text. | ### Chatbot Action Collect Company Name JSON Format: | Name | Type | Description | | --- | --- | --- | | `chatbotActionId` | guid | Id of the chatbot action. | | `isInputAreaEnabled` | bool | Whether the input area is enabled or not. | | `typingDelay` | float | TypingDelay is only available when channel is Live Chat. The typing delay in seconds before this message is shown in chat window. | | `message` | string | Message text. | | `nextActionId` | guid | Id of the next chatbot action. | ### Chatbot Action Collect Email JSON Format: | Name | Type | Description | | --- | --- | --- | | `message` | string | Message text. | | `typingDelay` | float | TypingDelay is only available when channel is Live Chat. The typing delay in seconds before this message is shown in chat window. | | `chatbotActionId` | guid | Id of the chatbot action. | | `isInputAreaEnabled` | bool | Whether the input area is enabled or not. | | `nextActionId` | guid | Id of the next chatbot action. | ### Chatbot Action Collect Location JSON Format: | Name | Type | Description | | --- | --- | --- | | `chatbotActionId` | guid | Id of the chatbot action. | | `buttonText` | string | Text on the button. | | `isInputAreaEnabled` | bool | Whether the input area is enabled or not. | | `message` | string | Message text. | | `typingDelay` | float | TypingDelay is only available when channel is Live Chat. The typing delay in seconds before this message is shown in chat window. | | `successedActionId` | guid | Id of the action to go to when successfully get location info. | | `failedActionId` | guid | Id of the action to go to when can not get location info. | ### Chatbot Action Collect Name JSON Format: | Name | Type | Description | | --- | --- | --- | | `isInputAreaEnabled` | bool | Whether the input area is enabled or not. | | `typingDelay` | float | TypingDelay is only available when channel is Live Chat. The typing delay in seconds before this message is shown in chat window. | | `chatbotActionId` | guid | Id of the chatbot action. | | `message` | string | Message text. | | `nextActionId` | guid | Id of the next chatbot action. | ### Chatbot Action Collect Phone Number JSON Format: | Name | Type | Description | | --- | --- | --- | | `nextActionId` | guid | Id of the next chatbot action. | | `chatbotActionId` | guid | Id of the chatbot action. | | `isInputAreaEnabled` | bool | Whether the input area is enabled or not. | | `message` | string | Message text. | | `typingDelay` | float | TypingDelay is only available when channel is Live Chat. The typing delay in seconds before this message is shown in chat window. | ### Chatbot Action Collect Variable Data JSON Format: | Name | Type | Description | | --- | --- | --- | | `typingDelay` | float | TypingDelay is only available when channel is Live Chat. The typing delay in seconds before this message is shown in chat window. | | `nextActionId` | guid | Id of the next chatbot action. | | `variableName` | string | Can only contain letters and numbers. | | `options` | string [] | Only available when type is singleSelect or multipleSelect. | | `isInputAreaEnabled` | bool | Whether the input area is enabled or not. | | `message` | string | Message text. | | `type` | enum | Allowed values are `checkbox`, `integer`, `date`, `singleSelect`, `textarea`, `email`, `decimal`, `text`, `multipleSelect`, `time`, `password`. | | `chatbotActionId` | guid | Id of the chatbot action. | ### Chatbot Action Go To Taskbot JSON Format: | Name | Type | Description | | --- | --- | --- | | `taskbotId` | guid | Id of the taskbot. | | `chatbotActionId` | guid | Id of the chatbot action. | ### Chatbot Action Quick Reply JSON Format: | Name | Type | Description | | --- | --- | --- | | `typingDelay` | float | TypingDelay is only available when channel is Live Chat. The typing delay in seconds before this message is shown in chat window. | | `otherResponseToActionId` | guid | Id of other responset to action. | | `chatbotActionId` | guid | Id of the chatbot action. | | `isInputAreaEnabled` | bool | Whether the input area is enabled or not. | | `message` | string | Message text. | | `chatbotActionQuickReplyOptions` | [chatbotActionQuickReplyOptions[]](/docs/server-api-bot-chatbot-intent-answer#chatbot-action-quick-reply-option-json-format) | Reference to Chatbot Action Quick Reply Option. | ### Chatbot Action Quick Reply Option JSON Format: | Name | Type | Description | | --- | --- | --- | | `order` | integer | Must be greater than or equal to 0. | | `nextActionId` | guid | Id of the next chatbot action. | | `chatbotActionId` | guid | Id of the chatbot action. | | `id` | guid | Id of the chatbot action quick reply option. | | `text` | string | Text of chatbot action quick reply option. | ### Chatbot Action Send Image JSON Format: | Name | Type | Description | | --- | --- | --- | | `message` | string | Message text. | | `typingDelay` | float | TypingDelay is only available when channel is Live Chat. The typing delay in seconds before this message is shown in chat window. | | `imageUrl` | string | | | `nextActionId` | guid | Id of the next chatbot action. | | `image` | image | URL of the image. | | `chatbotActionId` | guid | Id of the chatbot action. | ### Chatbot Action Send Message JSON Format: | Name | Type | Description | | --- | --- | --- | | `nextActionId` | guid | Id of the next chatbot action. | | `chatbotActionId` | guid | Id of the chatbot action. | | `variants` | string [] | Variants of the chatbot action send message. | | `message` | string | Message text. | | `typingDelay` | float | TypingDelay is only available when channel is Live Chat. The typing delay in seconds before this message is shown in chat window. | | `chatbotActionSendMessageLinks` | [chatbotActionSendMessageLinks[]](/docs/server-api-bot-chatbot-intent-answer#chatbot-action-send-message-link-json-format) | Reference to Chatbot Action Send Message Link. | ### Chatbot Action Send Message Link JSON Format: | Name | Type | Description | | --- | --- | --- | | `id` | guid | Id of the chatbot action send message link. | | `buttonText` | string | Text displaied on the link. | | `type` | enum | Allowed values are `webview`, `intent`, `webpage`. | | `openIn` | enum | Allowed values are `sideWindow`, `newWindow`, `currentWindow`. | | `intentId` | guid | Id of the intent. | | `url` | string | URL of the link, only available when type is Link or Webview. | | `chatbotActionId` | guid | Id of the chatbot action. | | `openStyle` | enum | Allowed values are `compact`, `tall`, `full`. | | `order` | integer | Must be greater than or equal to 0, ascending order. | ### Chatbot Action Send Video JSON Format: | Name | Type | Description | | --- | --- | --- | | `typingDelay` | float | TypingDelay is only available when channel is Live Chat. The typing delay in seconds before this message is shown in chat window. | | `message` | string | Message text. | | `chatbotActionId` | guid | Id of the chatbot action. | | `nextActionId` | guid | Id of the next chatbot action. | | `videoUrl` | string | URL of the video. | ### Chatbot Action SSO Login Button JSON Format: | Name | Type | Description | | --- | --- | --- | | `typingDelay` | float | TypingDelay is only available when channel is Live Chat. The typing delay in seconds before this message is shown in chat window. | | `isInputAreaEnabled` | bool | Whether the input area is enabled or not. | | `successedActionId` | guid | Id of the successed action. | | `message` | string | Message text. | | `failedActionId` | guid | Id of the failed action. | | `chatbotActionId` | guid | Id of the chatbot action. | | `loginButtonText` | string | Text on Login button. | ### Chatbot Action Transfer Chat JSON Format: | Name | Type | Description | | --- | --- | --- | | `transferTo` | guid | Transfer to agent, department or routing rules. | | `whenAgentOfflineToActionId` | guid | Id of when agent offline to action. | | `type` | enum | Allowed values are `transferToAgent`, `transferRoutingRules`, `transferToDepartment`,`transferToChatbot`. | | `chatbotActionId` | guid | Id of the chatbot action. | ### Chatbot Action Webhook JSON Format: | Name | Type | Description | | --- | --- | --- | | `ifSendChatTranscript` | bool | If send the chat transcript to 3rd party system. | | `url` | string | URL of the webhook request. | | `chatbotActionId` | guid | Id of the chatbot action. | | `otherResponseToActionId` | guid | Id of the other response to action. | | `additionalPostBody` | string | The additional post body of the request. | | `chatbotActionWebhookHeaders` | [chatbotActionWebhookHeaders[]](/docs/server-api-bot-chatbot-intent-answer#chatbot-action-webhook-header-json-format) | Reference to Chatbot Action Webhook Header. | | `chatbotActionWebhookResponseCodeToActions` | [chatbotActionWebhookResponseCodeToActions[]](/docs/server-api-bot-chatbot-intent-answer#chatbot-action-webhook-response-code-to-action-json-format) | Reference to Chatbot Action Webhook Response Code To Action. | | `chatbotActionWebhookResponseToVariables` | [chatbotActionWebhookResponseToVariables[]](/docs/server-api-bot-chatbot-intent-answer#chatbot-action-webhook-response-code-to-variable-json-format) | Reference to Chatbot Action Webhook Response Code To Variable. | ### Chatbot Action Webhook Header JSON Format: | Name | Type | Description | | --- | --- | --- | | `value` | string | Value of the chatbot action webhook header. | | `id` | guid | Id of the chatbot action webhook header. | | `order` | integer | Must be greater than or equal to 0, ascending order. | | `key` | string | Key of the chatbot action webhook header. | | `chatbotActionId` | guid | Id of the chatbot action. | ### Chatbot Action Webhook Response Code To Action JSON Format: | Name | Type | Description | | --- | --- | --- | | `responseCode` | string | Response code of the chatbot action webhook. | | `nextActionId` | guid | Id of the next chatbot action. | | `order` | integer | Must be greater than or equal to 0. | | `id` | guid | Id of the chatbot action webhook response code to action. | | `chatbotActionId` | guid | Id of the chatbot action. | ### Chatbot Action Webhook Response Code To Variable JSON Format: | Name | Type | Description | | --- | --- | --- | | `chatbotActionId` | guid | Id of the chatbot action. | | `order` | integer | Must be greater than or equal to 0. | | `id` | guid | Id of the chatbot action webhook response to variable. | | `responseKey` | string | Key of the response. | | `variableName` | string | Name of the variable. | ### Chatbot Action Send Email JSON Format: | Name | Type | Description | | --- | --- | --- | | `to` | string | The email to address. Use commas if there are multiple emails. | | `subject` | string | Email subject. | | `chatbotActionId` | guid | Id of the chatbot action. | | `cc` | string | The email CCs. Use commas if there are multiple emails. | | `content` | string | Email content. | | `nextActionId` | guid | Id of the next chatbot action. | ### Chatbot Action Book Meeting JSON Format: | Name | Type | Description | | --- | --- | --- | | `failedActionId` | guid | Id of the action to go to when book meeting failed. | | `calendlyEventTypeUri` | string | URL of the calendly event type. | | `chatbotActionId` | guid | Id of the chatbot action. | | `successedActionId` | guid | Id of the action to go to when book meeting successed. | | `integrationCalendlyId` | guid | Id of the integration calendly. | ### Chatbot Action Send Form JSON Format: | Name | Type | Description | | --- | --- | --- | | `title` | string | Title of the form. | | `message` | string | Message text. | | `chatbotActionId` | guid | Id of the chatbot action. | | `successedActionId` | guid | Id of the action to go to when send a form successed. | | `isConfirmationRequired` | bool | Whether confirm required or not. | | `submitButtonText` | string | Text on submit button. | | `isInputAreaEnabled` | bool | Whether the input area is enabled or not. | | `confirmButtonText` | string | Text on confirm button. | | `typingDelay` | float | TypingDelay is only available when channel is Live Chat. The typing delay in seconds before this message is shown in chat window. | | `cancelButtonText` | string | Text on cancel button. | | `failedActionId` | guid | Id of the action to go to when send a form failed. | | `chatbotActionSendFormFields` | [chatbotActionSendFormFields[]](/docs/server-api-bot-chatbot-intent-answer#chatbot-action-send-form-field-json-format) | Reference to Chatbot Action Send Form Field. | ### Chatbot Action Send Form Field JSON Format: | Name | Type | Description | | --- | --- | --- | | `options` | string [] | Options of form field, only avaiable when field type is "single select" or "multiple select". | | `type` | enum | Allowed values are `checkbox`, `integer`, `date`, `singleSelect`, `textarea`, `email`, `decimal`, `text`, `multipleSelect`, `time`, `password`. | | `chatbotActionId` | guid | Id of the chatbot action. | | `entityId` | guid | Id of the chatbot entity. | | `variableName` | string | Name of the variable. | | `ifPrebuiltEntity` | bool | Whether the entity is prebuilt or not. | | `isMasked` | bool | Whether the field is masked or not. | | `isRequired` | bool | Whether the field is required or not. | | `name` | string | Field name. | | `id` | guid | Id of the chatbot action send form. | | `order` | integer | Must be greater than or equal to 0. | | `prebuiltEntityId` | guid | Id of the prebuilt entity. | ### Chatbot Action Contact Agent JSON Format: | Name | Type | Description | | --- | --- | --- | | `message` | string | Message text. | | `optionTextWhenAgentOffline` | string | Option text when agent offline. | | `chatbotActionId` | guid | Id of the chatbot action. | | `optionTextWhenAgentOnline` | string | Option text when agent online. | | `typingDelay` | float | TypingDelay is only available when channel is Live Chat. The typing delay in seconds before this message is shown in chat window. | ### Chatbot Action Send Canned Quick Reply JSON Format: | Name | Type | Description | | --- | --- | --- | | `cannedQuickReplyId` | guid | Id of the canned quick reply. | | `chatbotActionId` | guid | Id of the chatbot action. | | `message` | string | Message text. | | `isInputAreaEnabled` | bool | Whether the input area is enabled or not. | | `anyOtherResponseActionId` | guid | Id of the any other response action. | | `typingDelay` | float | TypingDelay is only available when channel is Live Chat. The typing delay in seconds before this message is shown in chat window. | ### Chatbot Action Set Variable Value JSON Format: | Name | Type | Description | | --- | --- | --- | | `fieldId` | guid | Id of the field. | | `value` | string | Variable value. | | `customVariableId` | guid | Id of the custom variable. | | `nextActionId` | guid | Id of the next chatbot action. | | `ticketingFieldId` | guid | Id of the ticketing field. | | `variable` | string | | | `chatbotActionId` | guid | Id of the chatbot action. | | `saveToType` | enum | Allowed values are `customVariable`, `ticketingField`, `variable`, `preChatFormField`. | | `customVariable` | [customVariable](/docs/customvariable) | Reference to Custom Variable. | | `ticketingField` | [ticketingField](/docs/ticketingfield) | Reference to Field. | | `ticketingField` | [ticketingField](/docs/ticketingfield) | Reference to Field. | ### Chatbot Action Go To Intent JSON Format: | Name | Type | Description | | --- | --- | --- | | `intentId` | guid | Id of the intent. | | `chatbotActionId` | guid | Id of the chatbot action. | ### Chatbot Action Leave Chat JSON Format: | Name | Type | Description | | --- | --- | --- | | `chatbotActionId` | guid | Id of the chatbot action. | ### Chatbot Action Send Numberic Menu JSON Format: | Name | Type | Description | | --- | --- | --- | | `isInputAreaEnabled` | bool | Whether the input area is enabled or not. | | `chatbotActionId` | guid | Id of the chatbot action. | | `otherResponseToActionId` | guid | Id of the other response to action. | | `message` | string | Message text. | | `chatbotActionSendNumericMenuOptions` | [chatbotActionSendNumericMenuOptions[]](/docs/server-api-bot-chatbot-intent-answer#chatbot-action-send-numberic-menu-option-json-format) | Reference to Chatbot Action Send Numberic Menu Option. | ### Chatbot Action Send Numberic Menu Option JSON Format: | Name | Type | Description | | --- | --- | --- | | `nextActionId` | guid | Id of the next chatbot action. | | `id` | guid | Id of the chatbot action send numeric menu option. | | `key` | string | Key of the option. | | `chatbotActionId` | guid | Id of the chatbot action. | | `order` | integer | Must be greater than or equal to 0. | | `text` | string | Text of the option. | ### Chatbot Action Change Assignee JSON Format: | Name | Type | Description | | --- | --- | --- | | `whenAgentOfflineToActionId` | guid | Id of the when agent offline to action. | | `type` | enum | Allowed values are `transferRoutingRules`, `transferToAgent`, `transferToDepartment`. | | `chatbotActionId` | guid | Id of the chatbot action. | | `transferTo` | guid | Id of the transfer to. | ### Chatbot Action Condition JSON Format: | Name | Type | Description | | --- | --- | --- | | `chatbotActionId` | guid | Id of the chatbot action. | | `otherCaseActionId` | guid | Id of the other case action. | | `chatbotActionConditionCases` | [chatbotActionConditionCases[]](/docs/server-api-bot-chatbot-intent-answer#chatbot-action-condition-case-json-format) | Reference to Chatbot Action Condition Case. | ### Chatbot Action Condition Case JSON Format: | Name | Type | Description | | --- | --- | --- | | `order` | integer | Must be greater than or equal to 0. | | `id` | guid | Id of the chatbot action condition case. | | `logicalExpression` | string | Logical expression. | | `goToActionId` | guid | Id of the chatbot action to go to. | | `chatbotActionId` | guid | Id of the chatbot action. | | `conditionExpressionType` | enum | Allowed values are `all`, `any`, `logicalExpression`. | | `chatbotActionConditionCaseConditions` | [chatbotActionConditionCaseConditions[]](/docs/server-api-bot-chatbot-intent-answer#chatbot-action-condition-case-condition-json-format) | Reference to Chatbot Action Condition Case Condition. | ### Chatbot Action Condition Case Condition JSON Format: | Name | Type | Description | | --- | --- | --- | | `order` | integer | Must be greater than or equal to 0. | | `operator` | enum | Operation of the condition.Allowed values are `is`, `isNot`, `contains`, `notContains`, `regularExpression`, `isLessThan`, `isMoreThan`, `isOneOf`, `isNotIn`, `isEmpty`, `isNotEmpty`. | | `value` | string | Value of the field name. | | `chatbotActionConditionCaseId` | guid | Id of the chatbot action condition case. | | `id` | guid | Id of the chatbot action condition case condition. | | `fieldName` | string | Field name. | ### Chatbot Action Transfer Zendesk Chat JSON Format: | Name | Type | Description | | --- | --- | --- | | `transferTo` | string | Name of the transfer to. | | `type` | enum | Allowed values are `randomTransfer`, `fixedTransfer`. | | `whenAgentOfflineToActionId` | string | Id of the chatbot action when agent offline to go to. | | `chatbotActionId` | guid | Id of the chatbot action. | ### Chatbot Action Salesforce Create Record JSON Format: | Name | Type | Description | | --- | --- | --- | | `saveRecordIdToVariable` | string | Name of the variable which save record Id. | | `nextActionId` | guid | Id of the next chatbot action. | | `ifUpdateDuplicatedRecord` | bool | Whether the record update when is duplicated or not. | | `object` | string | Name of the salesforce object . | | `chatbotActionId` | guid | Id of the chatbot action. | | `chatbotActionSalesforceCreateRecordFields` | [chatbotActionSalesforceCreateRecordFields[]](/docs/server-api-bot-chatbot-intent-answer#chatbot-action-salesforce-create-record-field-json-format) | Reference to Chatbot Action Salesforce Create Record Field. | ### Chatbot Action Salesforce Create Record Field JSON Format: | Name | Type | Description | | --- | --- | --- | | `fieldValue` | string | Value of the Salesforce Create Record Field. | | `fieldName` | string | Name of the Salesforce Create Record Field. | | `id` | guid | Id of the chatbot action. | | `chatbotActionId` | guid | Id of the chatbot action. | ### Chatbot Action Salesforce Find Record JSON Format: | Name | Type | Description | | --- | --- | --- | | `fieldToSearchBy` | string | Name of the field to search by. | | `failedActionId` | guid | Id of the failed action. | | `searchValue` | bool | The value to search. | | `object` | string | Name of the salesforce object . | | `chatbotActionId` | guid | Id of the chatbot action. | | `successedActionId` | guid | Id of the successed action. | | `chatbotActionSalesforceFindRecordFields` | [chatbotActionSalesforceFindRecordFields[]](/docs/server-api-bot-chatbot-intent-answer#chatbot-action-salesforce-find-record-field-json-format) | Reference to Chatbot Action Salesforce Find Record Field. | ### Chatbot Action Salesforce Find Record Field JSON Format: | Name | Type | Description | | --- | --- | --- | | `saveToVariable` | string | Name of the variable which save the record field. | | `fieldName` | string | Name of the Salesforce Find Record Field. | | `id` | guid | Id of the chatbot action. | | `chatbotActionId` | guid | Id of the chatbot action. | ### Chatbot Action Salesforce Find Record By Soql JSON Format: | Name | Type | Description | | --- | --- | --- | | `soql` | string | The soql to find record. | | `chatbotActionId` | guid | Id of the chatbot action. | | `failedActionId` | guid | Id of the failed action. | | `successedActionId` | guid | Id of the successed action. | | `chatbotActionSalesforceFindRecordFieldBySoqls` | [chatbotActionSalesforceFindRecordFieldBySoqls[]](/docs/server-api-bot-chatbot-intent-answer#chatbot-action-salesforce-find-record-field-by-soql-json-format) | Reference to Chatbot Action Salesforce Find Record Field By Soql. | ### Chatbot Action Salesforce Find Record Field By Soql JSON Format: | Name | Type | Description | | --- | --- | --- | | `saveToVariable` | string | Name of the variable which save the record field. | | `fieldName` | string | Name of the Salesforce Find Record Field. | | `id` | guid | Id of the chatbot action. | | `chatbotActionId` | guid | Id of the chatbot action. | ### Chatbot Action Dynamics365 Create Record JSON Format: | Name | Type | Description | | --- | --- | --- | | `saveRecordIdToVariable` | string | Name of the variable which save record Id. | | `nextActionId` | guid | Id of the next chatbot action. | | `ifUpdateDuplicatedRecord` | bool | Whether the record update when is duplicated or not. | | `entity` | string | Dynamics365 entity . | | `entitySetName` | string | Dynamics365 entity Name . | | `chatbotActionId` | guid | Id of the chatbot action. | | `chatbotActionDynamics365CreateRecordFields` | [chatbotActionDynamics365CreateRecordFields[]](/docs/server-api-bot-chatbot-intent-answer#chatbot-action-dynamics365-create-record-field-json-format) | Reference to Chatbot Action Dynamics365 Create Record Field. | ### Chatbot Action Dynamics365 Create Record Field JSON Format: | Name | Type | Description | | --- | --- | --- | | `fieldValue` | string | Value of the Dynamics365 Create Record Field. | | `fieldName` | string | Name of the Dynamics365 Create Record Field. | | `id` | guid | Id of the chatbot action. | | `chatbotActionId` | guid | Id of the chatbot action. | ### Chatbot Action Dynamics365 Find Record JSON Format: | Name | Type | Description | | --- | --- | --- | | `fieldToSearchBy` | string | Name of the field to search by. | | `failedActionId` | guid | Id of the failed action. | | `searchValue` | bool | The value to search. | | `entity` | string | Dynamics365 entity . | | `entitySetName` | string | Dynamics365 entity Name . | | `chatbotActionId` | guid | Id of the chatbot action. | | `successedActionId` | guid | Id of the successed action. | | `chatbotActionDynamics365FindRecordFields` | [chatbotActionDynamics365FindRecordFields[]](/docs/server-api-bot-chatbot-intent-answer#chatbot-action-dynamics365-find-record-field-json-format) | Reference to Chatbot Action Dynamics365 Find Record Field. | ### Chatbot Action Dynamics365 Find Record Field JSON Format: | Name | Type | Description | | --- | --- | --- | | `saveToVariable` | string | Name of the variable which save the record field. | | `fieldName` | string | Name of the Salesforce Find Record Field. | | `id` | guid | Id of the chatbot action. | | `chatbotActionId` | guid | Id of the chatbot action. | ### Chatbot Action Dynamics365 Find Record By Fetch Xml JSON Format: | Name | Type | Description | | --- | --- | --- | | `fetchXml` | string | The fetchXml to find record. | | `entity` | string | Dynamics365 entity . | | `entitySetName` | string | Dynamics365 entity Name . | | `chatbotActionId` | guid | Id of the chatbot action. | | `failedActionId` | guid | Id of the failed action. | | `successedActionId` | guid | Id of the successed action. | | `chatbotActionDynamics365FindRecordFieldByFetchXmls` | [chatbotActionDynamics365FindRecordFieldByFetchXmls[]](/docs/server-api-bot-chatbot-intent-answer#chatbot-action-dynamics365-find-record-field-by-fetch-xml-json-format) | Reference to Chatbot Action Dynamics365 Find Record Field By Fetch Xml. | ### Chatbot Action Dynamics365 Find Record Field By Fetch Xml JSON Format: | Name | Type | Description | | --- | --- | --- | | `saveToVariable` | string | Name of the variable which save the record field. | | `fieldName` | string | Name of the Salesforce Find Record Field. | | `id` | guid | Id of the chatbot action. | | `chatbotActionId` | guid | Id of the chatbot action. | ### Get the list of Chatbot Intent Answers `GET bot/chatbotIntentAnswers` - #### Parameters: | Name | Type | in | Required | Description | | --- | --- | --- | --- | --- | | `include` | string | query | no | Allowed value is "chatbotResponse". | - #### Response: An array of [Chatbot Intent Answer](/docs/server-api-bot-chatbot-intent-answer#chatbot-intent-answer-json-format) - #### Example Sample Request: ``` curl https://api11.comm100.io/v4/bot/chatbotIntentAnswers \ -X 'GET' \ -H 'Authorization: Bearer {access_token}' \ ``` Response: HTTP/1.1 200 OK ``` [ { "id": "ad63659e-4595-454a-9401-e33d9df7b640", "intentId": "54c51763-8241-40a7-bb61-95231a03bb86", "channelId": "Live Chat", "order": 0, "collectInfoType": "form", "chatbotResponseId": "ecd57b2b-2a7a-4059-8e63-ad5c8e291048", "chatbotResponse": { "id": "e8bf0d25-eed6-4a46-a417-318e15019609", "chatbotActions": [ { "xPosition": 50, "yPosition": 50, "id": "99AC0127-87DB-432B-B1A8-0000567BE2FB", "type": "chatbotActionStart", "chatbotResponseId": "e8bf0d25-eed6-4a46-a417-318e15019609", "chatbotActionStart": { "chatbotActionId": "99AC0127-87DB-432B-B1A8-0000567BE2FB", "nextActionId": "ea5369ae-b5cf-4bfa-a5fa-9dac234cf4c5" }, "chatbotActionCollectComment": { "typingDelay": 1.0, "chatbotActionId": "B81DAE9A-E89E-4267-AFB6-04131E9E8FD7", "nextActionId": "00000000-0000-0000-0000-000000000000", "isInputAreaEnabled": false, "message": "What's your comment?" }, "chatbotActionCollectCompanyName": { "chatbotActionId": "59BD2CB6-8CBF-4CCE-AED6-19BB69A2D657", "isInputAreaEnabled": false, "typingDelay": 1.0, "message": "What's your company name?", "nextActionId": "478EE923-458A-4EAA-A698-98DDB64DCF19" }, "chatbotActionCollectEmail": { "message": "What's your email?", "typingDelay": 1.0, "chatbotActionId": "E33EF495-C94C-4677-9B7F-01AA05B74F54", "isInputAreaEnabled": false, "nextActionId": "478EE923-458A-4EAA-A698-98DDB64DCF19" }, "chatbotActionCollectLocation": { "chatbotActionId": "5AEDCED1-B677-4861-A8B6-002B5819C036", "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" }, "chatbotActionCollectName": { "isInputAreaEnabled": true, "typingDelay": 1.0, "chatbotActionId": "33D4B0A1-19EA-4449-B7D3-0F4D94B6FF46", "message": "What's your name?", "nextActionId": "00000000-0000-0000-0000-000000000000" }, "chatbotActionCollectPhoneNumber": { "nextActionId": "AA310D7E-24AB-422E-8976-B83336700527", "chatbotActionId": "21DA2E94-DB52-407B-A96A-023FB0B13420", "isInputAreaEnabled": true, "message": "What's your phone number?", "typingDelay": 1.0 }, "chatbotActionCollectVariableData": { "typingDelay": 1.0, "nextActionId": "18DAA6C1-7468-471D-BB30-E7AE0BE09FFC", "variableName": "text", "options": [], "isInputAreaEnabled": false, "message": "text", "type": "text", "chatbotActionId": "A7573C4C-A676-4212-9AD6-0CA6E171F7CA" }, "chatbotActionGoToTaskbot": { "taskbotId": "F198799B-F8DE-40B4-94A9-004848BE0918", "chatbotActionId": "55A474CC-4074-49DE-BEB9-184C1D7E13FC" }, "chatbotActionQuickReply": { "typingDelay": 0.0, "otherResponseToActionId": "00000000-0000-0000-0000-000000000000", "chatbotActionId": "6C358A2D-FED6-49D6-B987-01C8E4701CD6", "isInputAreaEnabled": true, "message": "custom qp-have message", "chatbotActionQuickReplyOptions": [ { "order": 0, "nextActionId": "177C7AE7-B792-420C-82D3-563564B8647D", "chatbotActionId": "C5077D4D-9897-4258-B418-EBEF5E8F51D7", "id": "8076723A-2980-4CED-89D7-00234C234DBE", "text": "goto taskbot " } ] }, "chatbotActionSendImage": { "message": "", "typingDelay": 0.0, "imageUrl": "", "nextActionId": "CC5AF23C-CCA4-4D2D-B25A-4BF891275F30", "image": "", "chatbotActionId": "CDACFBDE-BE26-40DC-95C2-002C1F37E161" }, "chatbotActionSendMessage": { "nextActionId": "00000000-0000-0000-0000-000000000000", "chatbotActionId": "DC79CBB7-B581-4481-BEE9-0007CC28C6D7", "variants": [ "" ], "message": "Hi there! I'm a chatbot, here to help answer your questions.", "typingDelay": 0.0, "chatbotActionSendMessageLinks": [ { "id": "2DFD43D3-A953-471A-BD6B-0008BEBB5264", "buttonText": "twitter", "type": "webview", "openIn": "sideWindow", "intentId": "00000000-0000-0000-0000-000000000000", "url": "https://www.baidu.com", "chatbotActionId": "E3A4A33C-1929-4862-B5CF-CCB6F71B0359", "openStyle": "compact", "order": 0 } ] }, "chatbotActionSendVideo": { "typingDelay": 0.0, "message": "", "chatbotActionId": "8596A4AD-CBF4-404F-8175-00D624BD5C02", "nextActionId": "00000000-0000-0000-0000-000000000000", "videoUrl": "https://www.youtube.com/watch?v=0XYWpraTgaY" }, "chatbotActionSSOLoginButton": { "typingDelay": 0.0, "isInputAreaEnabled": true, "successedActionId": "03DF237A-7F5F-45A8-A44C-042CD9D85E0C", "message": "signin message sso", "failedActionId": "00000000-0000-0000-0000-000000000000", "chatbotActionId": "F2935DC6-4FC1-4F66-9FB2-00105F31C34D", "loginButtonText": "signin-text sso" }, "chatbotActionTransferChat": { "transferTo": "87AD4BE9-89F5-4E57-AE9E-2D5FEE8ED3E5", "whenAgentOfflineToActionId": "00000000-0000-0000-0000-000000000000", "type": "transferToAgent", "chatbotActionId": "CA4989CE-1D34-4F32-8AA9-019F788FE0A9" }, "chatbotActionWebhook": { "ifSendChatTranscript": false, "url": "www.baidu.com", "chatbotActionId": "8627E871-BB36-45EC-AAD2-001BF039548B", "otherResponseToActionId": "00000000-0000-0000-0000-000000000000", "additionalPostBody": "", "chatbotActionWebhookHeaders": [ { "value": "v1", "id": "480DCC60-77F5-4A6C-B93E-008EA33F4874", "order": 0, "key": "k1", "chatbotActionId": "CC964045-886D-4EE2-B5F9-500407B67199" } ], "chatbotActionWebhookResponseCodeToActions": [ { "responseCode": "200", "nextActionId": "00000000-0000-0000-0000-000000000000", "order": 0, "id": "87199352-7B7B-4A44-9952-00276F291F1F", "chatbotActionId": "9284D918-E1D3-4D7E-8F6C-2B1A15529505" } ], "chatbotActionWebhookResponseToVariables": [ { "chatbotActionId": "9E03760E-03B6-488F-85DB-72D395AB26EE", "order": 0, "id": "B859FE33-817F-4654-8C84-2BC332304AA4", "responseKey": "fdafa", "variableName": "2342432432132131" } ] }, "chatbotActionSendEmail": { "to": "Simon", "subject": "API Test", "chatbotActionId": "2DFE48BD-D7CE-4ECD-8C98-2B00BB5A665F", "cc": "jansemain", "content": "Delete", "nextActionId": "60F2F597-5674-41D8-BBFD-0AEAAF787837" }, "chatbotActionBookMeeting": { "failedActionId": "00000000-0000-0000-0000-000000000000", "calendlyEventTypeUri": "http://localhost/event_types/15", "chatbotActionId": "087826DE-7DA2-4E9E-B348-8E41B6EFD8CF", "successedActionId": "00000000-0000-0000-0000-000000000000", "integrationCalendlyId": "7E8DFDA2-2117-4796-93D0-8A51047CE1BC" }, "chatbotActionSendForm": { "title": "Via a Form title", "message": "Via a Form", "chatbotActionId": "14BFE247-AA16-4D2A-8639-003944A72AE3", "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", "chatbotActionId": "BEAD6DFE-0EC2-4862-A601-9D6F7596063B", "entityId": "00000000-0000-0000-0000-000000000000", "variableName": "", "ifPrebuiltEntity": true, "isMasked": true, "isRequired": true, "name": "test", "id": "AFA6F9DF-AA97-44ED-99DE-E22F9A7E9F01", "order": 0, "prebuiltEntityId": "00000000-0000-0000-0000-000000000000" } ] }, "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", "chatbotActionId": "520F4EB3-807E-4C85-88D7-0002BA6181A6", "optionTextWhenAgentOnline": "Chat with Live Agent", "typingDelay": 0.0 }, "chatbotActionSendCannedQuickReply": { "cannedQuickReplyId": "D62DE3F6-A55E-4AB2-9DA3-2AF33849306D", "chatbotActionId": "FE618181-724D-4A25-A8FA-000570E5B0A5", "message": "", "isInputAreaEnabled": true, "anyOtherResponseActionId": "00000000-0000-0000-0000-000000000000", "typingDelay": 0.0 }, "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": "", "chatbotActionId": "5A1F13F9-4E76-432B-8919-011CCEF7F48F", "saveToType": "customVariable", "customVariable": { "id": "6BB15329-7C46-EB11-8100-00155D081D0B", "name": "c_v_name", "value": "c_v_value", "hyperlink": "{!Visitor.IP}", "type": "text" }, "ticketingField": { "isSystem": false, "isRequired": false, "type": "dropdownList", "name": "My Select", "systemName": "", "length": 256, "helpText": "My custom select.", "defaultValue": "op1", "linkURL": "", "id": "110499d0-5a3e-469f-b8de-9a34e99092b0", "order": 1, "fieldOptions": [ { "id": "8bf39eb8-be1e-48b7-b324-85e152f42432", "fieldId": "110499d0-5a3e-469f-b8de-9a34e99092b0", "value": "op1", "order": 1, "displayText": "op1" } ] } }, "chatbotActionGoToIntent": { "intentId": "4C36FC4D-9CEC-4AB4-9F00-8D8B20EA47A8", "chatbotActionId": "2D133B3C-2B67-4D2A-B0A5-0050CD10F2DD" }, "chatbotActionLeaveChat": { "chatbotActionId": "EC859694-3DD8-45FF-90CE-88D7CB4A928E" }, "chatbotActionSendNumericMenu": { "isInputAreaEnabled": true, "chatbotActionId": "3F05B173-8776-4621-84AC-46AB8B4E1AD5", "otherResponseToActionId": "00000000-0000-0000-0000-000000000000", "message": "hello", "chatbotActionSendNumericMenuOptions": [ { "nextActionId": "C8A26362-6823-4497-89B3-B54B06B2379A", "id": "AA4BECC8-8C84-4C73-9629-037E434AE7B7", "key": "3", "chatbotActionId": "85B9D2D3-C045-4D85-A7D9-789D1A9DD5D2", "order": 0, "text": "test" } ] }, "chatbotActionChangeAssignee": { "whenAgentOfflineToActionId": "00000000-0000-0000-0000-000000000000", "type": "transferToAgent", "chatbotActionId": "77AE7E44-6DC9-47D4-92C9-0326077F2D59", "transferTo": "6CC96F38-5FE2-448C-AFBB-3F3D109CF022" }, "chatbotActionCondition": { "chatbotActionId": "40278B68-ABCF-4FE9-9D24-09902CD64803", "otherCaseActionId": "00000000-0000-0000-0000-000000000000", "chatbotActionConditionCases": [ { "order": 0, "id": "8FC74E84-72CB-41A7-BC7F-0281D21C2FE4", "logicalExpression": "", "goToActionId": "00000000-0000-0000-0000-000000000000", "chatbotActionId": "D5FD270C-70FB-4443-ACDF-3CA489549728", "conditionExpressionType": "all", "chatbotActionConditionCaseConditions": [ { "order": 0, "operator": "is", "value": "fdsfsdaf", "chatbotActionConditionCaseId": "AFA6F9DF-AA97-44ED-99DE-E22F9A7E9F01", "id": "A2D29F26-5F2D-4167-954F-01927F439919", "fieldName": "{!Variable.Name}" } ] } ] }, "chatbotActionTransferZendeskChat": { "transferTo": "", "type": "", "whenAgentOfflineToActionId": "bbec7c36-9c72-4789-8e07-8951c22eb945", "chatbotActionId": "" }, "chatbotActionSalesforceCreateRecord": { "saveRecordIdToVariable": "", "nextActionId": "bbec7c36-9c72-4789-8e07-8951c22eb945", "ifUpdateDuplicatedRecord": true, "object": "", "chatbotActionId": "", "chatbotActionSalesforceCreateRecordFields": [ { "fieldValue": "", "chatbotActionId": "", "id": "bbec7c36-9c72-4789-8e07-8951c22eb945", "fieldName": "" } ] }, "chatbotActionSalesforceFindRecord": { "fieldToSearchBy": "", "object": "", "failedActionId": "bbec7c36-9c72-4789-8e07-8951c22eb945", "searchValue": "", "chatbotActionId": "", "successedActionId": "bbec7c36-9c72-4789-8e07-8951c22eb945", "chatbotActionSalesforceFindRecordFields": [ { "saveToVariable": "", "chatbotActionId": "", "id": "bbec7c36-9c72-4789-8e07-8951c22eb945", "fieldName": "" } ] }, "chatbotActionSalesforceFindRecordBySoql": { "chatbotActionId": "", "soql": "", "failedActionId": "bbec7c36-9c72-4789-8e07-8951c22eb945", "successedActionId": "bbec7c36-9c72-4789-8e07-8951c22eb945", "chatbotActionSalesforceFindRecordFieldBySoqls": [ { "id": "bbec7c36-9c72-4789-8e07-8951c22eb945", "chatbotActionId": "", "fieldName": "", "saveToVariable": "" } ] }, "chatbotActionDynamics365CreateRecord": { "ifUpdateDuplicatedRecord": true, "saveRecordIdToVariable": "", "nextActionId": "bbec7c36-9c72-4789-8e07-8951c22eb945", "entity": "", "entitySetName": "", "chatbotActionId": "", "chatbotActionDynamics365CreateRecordFields": [ { "id": "bbec7c36-9c72-4789-8e07-8951c22eb945", "fieldName": "", "chatbotActionId": "", "fieldValue": "" } ] }, "chatbotActionDynamics365FindRecord": { "successedActionId": "bbec7c36-9c72-4789-8e07-8951c22eb945", "searchValue": "", "chatbotActionId": "", "fieldToSearchBy": "", "entitySetName": "", "failedActionId": "bbec7c36-9c72-4789-8e07-8951c22eb945", "entity": "", "chatbotActionDynamics365FindRecordFields": [ { "saveToVariable": "", "id": "bbec7c36-9c72-4789-8e07-8951c22eb945", "chatbotActionId": "", "fieldName": "" } ] }, "chatbotActionDynamics365FindRecordByFetchXml": { "entitySetName": "", "fetchXml": "", "entity": "", "successedActionId": "bbec7c36-9c72-4789-8e07-8951c22eb945", "failedActionId": "bbec7c36-9c72-4789-8e07-8951c22eb945", "chatbotActionId": "", "chatbotActionDynamics365FindRecordFieldByFetchXmls": [ { "saveToVariable": "", "id": "bbec7c36-9c72-4789-8e07-8951c22eb945", "chatbotActionId": "", "fieldName": "" } ] } } ] } } ] ``` ### Get a single Chatbot Intent Answer `GET bot/chatbotIntentAnswers/{id}` - #### Parameters: | Name | Type | in | Required | Description | | --- | --- | --- | --- | --- | | `include` | string | query | no | Allowed value is "chatbotResponse". | - #### Response: [Chatbot Intent Answer](/docs/server-api-bot-chatbot-intent-answer#chatbot-intent-answer-json-format) - #### Example Sample Request: ``` curl https://api11.comm100.io/v4/bot/chatbotIntentAnswers/ad63659e-4595-454a-9401-e33d9df7b640 \ -X 'GET' \ -H 'Authorization: Bearer {access_token}' \ ``` Response: HTTP/1.1 200 OK ``` { "id": "ad63659e-4595-454a-9401-e33d9df7b640", "intentId": "54c51763-8241-40a7-bb61-95231a03bb86", "channelId": "Live Chat", "order": 0, "collectInfoType": "form", "chatbotResponseId": "ecd57b2b-2a7a-4059-8e63-ad5c8e291048", "chatbotResponse": { "id": "e8bf0d25-eed6-4a46-a417-318e15019609", "chatbotActions": [ { "xPosition": 50, "yPosition": 50, "id": "99AC0127-87DB-432B-B1A8-0000567BE2FB", "type": "chatbotActionStart", "chatbotResponseId": "e8bf0d25-eed6-4a46-a417-318e15019609", "chatbotActionStart": { "chatbotActionId": "99AC0127-87DB-432B-B1A8-0000567BE2FB", "nextActionId": "ea5369ae-b5cf-4bfa-a5fa-9dac234cf4c5" }, "chatbotActionCollectComment": { "typingDelay": 1.0, "chatbotActionId": "B81DAE9A-E89E-4267-AFB6-04131E9E8FD7", "nextActionId": "00000000-0000-0000-0000-000000000000", "isInputAreaEnabled": false, "message": "What's your comment?" }, "chatbotActionCollectCompanyName": { "chatbotActionId": "59BD2CB6-8CBF-4CCE-AED6-19BB69A2D657", "isInputAreaEnabled": false, "typingDelay": 1.0, "message": "What's your company name?", "nextActionId": "478EE923-458A-4EAA-A698-98DDB64DCF19" }, "chatbotActionCollectEmail": { "message": "What's your email?", "typingDelay": 1.0, "chatbotActionId": "E33EF495-C94C-4677-9B7F-01AA05B74F54", "isInputAreaEnabled": false, "nextActionId": "478EE923-458A-4EAA-A698-98DDB64DCF19" }, "chatbotActionCollectLocation": { "chatbotActionId": "5AEDCED1-B677-4861-A8B6-002B5819C036", "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" }, "chatbotActionCollectName": { "isInputAreaEnabled": true, "typingDelay": 1.0, "chatbotActionId": "33D4B0A1-19EA-4449-B7D3-0F4D94B6FF46", "message": "What's your name?", "nextActionId": "00000000-0000-0000-0000-000000000000" }, "chatbotActionCollectPhoneNumber": { "nextActionId": "AA310D7E-24AB-422E-8976-B83336700527", "chatbotActionId": "21DA2E94-DB52-407B-A96A-023FB0B13420", "isInputAreaEnabled": true, "message": "What's your phone number?", "typingDelay": 1.0 }, "chatbotActionCollectVariableData": { "typingDelay": 1.0, "nextActionId": "18DAA6C1-7468-471D-BB30-E7AE0BE09FFC", "variableName": "text", "options": [], "isInputAreaEnabled": false, "message": "text", "type": "text", "chatbotActionId": "A7573C4C-A676-4212-9AD6-0CA6E171F7CA" }, "chatbotActionGoToTaskbot": { "taskbotId": "F198799B-F8DE-40B4-94A9-004848BE0918", "chatbotActionId": "55A474CC-4074-49DE-BEB9-184C1D7E13FC" }, "chatbotActionQuickReply": { "typingDelay": 0.0, "otherResponseToActionId": "00000000-0000-0000-0000-000000000000", "chatbotActionId": "6C358A2D-FED6-49D6-B987-01C8E4701CD6", "isInputAreaEnabled": true, "message": "custom qp-have message", "chatbotActionQuickReplyOptions": [ { "order": 0, "nextActionId": "177C7AE7-B792-420C-82D3-563564B8647D", "chatbotActionId": "C5077D4D-9897-4258-B418-EBEF5E8F51D7", "id": "8076723A-2980-4CED-89D7-00234C234DBE", "text": "goto taskbot " } ] }, "chatbotActionSendImage": { "message": "", "typingDelay": 0.0, "imageUrl": "", "nextActionId": "CC5AF23C-CCA4-4D2D-B25A-4BF891275F30", "image": "", "chatbotActionId": "CDACFBDE-BE26-40DC-95C2-002C1F37E161" }, "chatbotActionSendMessage": { "nextActionId": "00000000-0000-0000-0000-000000000000", "chatbotActionId": "DC79CBB7-B581-4481-BEE9-0007CC28C6D7", "variants": [ "" ], "message": "Hi there! I'm a chatbot, here to help answer your questions.", "typingDelay": 0.0, "chatbotActionSendMessageLinks": [ { "id": "2DFD43D3-A953-471A-BD6B-0008BEBB5264", "buttonText": "twitter", "type": "webview", "openIn": "sideWindow", "intentId": "00000000-0000-0000-0000-000000000000", "url": "https://www.baidu.com", "chatbotActionId": "E3A4A33C-1929-4862-B5CF-CCB6F71B0359", "openStyle": "compact", "order": 0 } ] }, "chatbotActionSendVideo": { "typingDelay": 0.0, "message": "", "chatbotActionId": "8596A4AD-CBF4-404F-8175-00D624BD5C02", "nextActionId": "00000000-0000-0000-0000-000000000000", "videoUrl": "https://www.youtube.com/watch?v=0XYWpraTgaY" }, "chatbotActionSSOLoginButton": { "typingDelay": 0.0, "isInputAreaEnabled": true, "successedActionId": "03DF237A-7F5F-45A8-A44C-042CD9D85E0C", "message": "signin message sso", "failedActionId": "00000000-0000-0000-0000-000000000000", "chatbotActionId": "F2935DC6-4FC1-4F66-9FB2-00105F31C34D", "loginButtonText": "signin-text sso" }, "chatbotActionTransferChat": { "transferTo": "87AD4BE9-89F5-4E57-AE9E-2D5FEE8ED3E5", "whenAgentOfflineToActionId": "00000000-0000-0000-0000-000000000000", "type": "transferToAgent", "chatbotActionId": "CA4989CE-1D34-4F32-8AA9-019F788FE0A9" }, "chatbotActionWebhook": { "ifSendChatTranscript": false, "url": "www.baidu.com", "chatbotActionId": "8627E871-BB36-45EC-AAD2-001BF039548B", "otherResponseToActionId": "00000000-0000-0000-0000-000000000000", "additionalPostBody": "", "chatbotActionWebhookHeaders": [ { "value": "v1", "id": "480DCC60-77F5-4A6C-B93E-008EA33F4874", "order": 0, "key": "k1", "chatbotActionId": "CC964045-886D-4EE2-B5F9-500407B67199" } ], "chatbotActionWebhookResponseCodeToActions": [ { "responseCode": "200", "nextActionId": "00000000-0000-0000-0000-000000000000", "order": 0, "id": "87199352-7B7B-4A44-9952-00276F291F1F", "chatbotActionId": "9284D918-E1D3-4D7E-8F6C-2B1A15529505" } ], "chatbotActionWebhookResponseToVariables": [ { "chatbotActionId": "9E03760E-03B6-488F-85DB-72D395AB26EE", "order": 0, "id": "B859FE33-817F-4654-8C84-2BC332304AA4", "responseKey": "fdafa", "variableName": "2342432432132131" } ] }, "chatbotActionSendEmail": { "to": "Simon", "subject": "API Test", "chatbotActionId": "2DFE48BD-D7CE-4ECD-8C98-2B00BB5A665F", "cc": "jansemain", "content": "Delete", "nextActionId": "60F2F597-5674-41D8-BBFD-0AEAAF787837" }, "chatbotActionBookMeeting": { "failedActionId": "00000000-0000-0000-0000-000000000000", "calendlyEventTypeUri": "http://localhost/event_types/15", "chatbotActionId": "087826DE-7DA2-4E9E-B348-8E41B6EFD8CF", "successedActionId": "00000000-0000-0000-0000-000000000000", "integrationCalendlyId": "7E8DFDA2-2117-4796-93D0-8A51047CE1BC" }, "chatbotActionSendForm": { "title": "Via a Form title", "message": "Via a Form", "chatbotActionId": "14BFE247-AA16-4D2A-8639-003944A72AE3", "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", "chatbotActionId": "BEAD6DFE-0EC2-4862-A601-9D6F7596063B", "entityId": "00000000-0000-0000-0000-000000000000", "variableName": "", "ifPrebuiltEntity": true, "isMasked": true, "isRequired": true, "name": "test", "id": "AFA6F9DF-AA97-44ED-99DE-E22F9A7E9F01", "order": 0, "prebuiltEntityId": "00000000-0000-0000-0000-000000000000" } ] }, "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", "chatbotActionId": "520F4EB3-807E-4C85-88D7-0002BA6181A6", "optionTextWhenAgentOnline": "Chat with Live Agent", "typingDelay": 0.0 }, "chatbotActionSendCannedQuickReply": { "cannedQuickReplyId": "D62DE3F6-A55E-4AB2-9DA3-2AF33849306D", "chatbotActionId": "FE618181-724D-4A25-A8FA-000570E5B0A5", "message": "", "isInputAreaEnabled": true, "anyOtherResponseActionId": "00000000-0000-0000-0000-000000000000", "typingDelay": 0.0 }, "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": "", "chatbotActionId": "5A1F13F9-4E76-432B-8919-011CCEF7F48F", "saveToType": "customVariable", "customVariable": { "id": "6BB15329-7C46-EB11-8100-00155D081D0B", "name": "c_v_name", "value": "c_v_value", "hyperlink": "{!Visitor.IP}", "type": "text" }, "ticketingField": { "isSystem": false, "isRequired": false, "type": "dropdownList", "name": "My Select", "systemName": "", "length": 256, "helpText": "My custom select.", "defaultValue": "op1", "linkURL": "", "id": "110499d0-5a3e-469f-b8de-9a34e99092b0", "order": 1, "fieldOptions": [ { "id": "8bf39eb8-be1e-48b7-b324-85e152f42432", "fieldId": "110499d0-5a3e-469f-b8de-9a34e99092b0", "value": "op1", "order": 1, "displayText": "op1" } ] } }, "chatbotActionGoToIntent": { "intentId": "4C36FC4D-9CEC-4AB4-9F00-8D8B20EA47A8", "chatbotActionId": "2D133B3C-2B67-4D2A-B0A5-0050CD10F2DD" }, "chatbotActionLeaveChat": { "chatbotActionId": "EC859694-3DD8-45FF-90CE-88D7CB4A928E" }, "chatbotActionSendNumericMenu": { "isInputAreaEnabled": true, "chatbotActionId": "3F05B173-8776-4621-84AC-46AB8B4E1AD5", "otherResponseToActionId": "00000000-0000-0000-0000-000000000000", "message": "hello", "chatbotActionSendNumericMenuOptions": [ { "nextActionId": "C8A26362-6823-4497-89B3-B54B06B2379A", "id": "AA4BECC8-8C84-4C73-9629-037E434AE7B7", "key": "3", "chatbotActionId": "85B9D2D3-C045-4D85-A7D9-789D1A9DD5D2", "order": 0, "text": "test" } ] }, "chatbotActionChangeAssignee": { "whenAgentOfflineToActionId": "00000000-0000-0000-0000-000000000000", "type": "transferToAgent", "chatbotActionId": "77AE7E44-6DC9-47D4-92C9-0326077F2D59", "transferTo": "6CC96F38-5FE2-448C-AFBB-3F3D109CF022" }, "chatbotActionCondition": { "chatbotActionId": "40278B68-ABCF-4FE9-9D24-09902CD64803", "otherCaseActionId": "00000000-0000-0000-0000-000000000000", "chatbotActionConditionCases": [ { "order": 0, "id": "8FC74E84-72CB-41A7-BC7F-0281D21C2FE4", "logicalExpression": "", "goToActionId": "00000000-0000-0000-0000-000000000000", "chatbotActionId": "D5FD270C-70FB-4443-ACDF-3CA489549728", "conditionExpressionType": "all", "chatbotActionConditionCaseConditions": [ { "order": 0, "operator": "is", "value": "fdsfsdaf", "chatbotActionConditionCaseId": "AFA6F9DF-AA97-44ED-99DE-E22F9A7E9F01", "id": "A2D29F26-5F2D-4167-954F-01927F439919", "fieldName": "{!Variable.Name}" } ] } ] }, "chatbotActionTransferZendeskChat": { "transferTo": "", "type": "", "whenAgentOfflineToActionId": "bbec7c36-9c72-4789-8e07-8951c22eb945", "chatbotActionId": "" }, "chatbotActionSalesforceCreateRecord": { "saveRecordIdToVariable": "", "nextActionId": "bbec7c36-9c72-4789-8e07-8951c22eb945", "ifUpdateDuplicatedRecord": true, "object": "", "chatbotActionId": "", "chatbotActionSalesforceCreateRecordFields": [ { "fieldValue": "", "chatbotActionId": "", "id": "bbec7c36-9c72-4789-8e07-8951c22eb945", "fieldName": "" } ] }, "chatbotActionSalesforceFindRecord": { "fieldToSearchBy": "", "object": "", "failedActionId": "bbec7c36-9c72-4789-8e07-8951c22eb945", "searchValue": "", "chatbotActionId": "", "successedActionId": "bbec7c36-9c72-4789-8e07-8951c22eb945", "chatbotActionSalesforceFindRecordFields": [ { "saveToVariable": "", "chatbotActionId": "", "id": "bbec7c36-9c72-4789-8e07-8951c22eb945", "fieldName": "" } ] }, "chatbotActionSalesforceFindRecordBySoql": { "chatbotActionId": "", "soql": "", "failedActionId": "bbec7c36-9c72-4789-8e07-8951c22eb945", "successedActionId": "bbec7c36-9c72-4789-8e07-8951c22eb945", "chatbotActionSalesforceFindRecordFieldBySoqls": [ { "id": "bbec7c36-9c72-4789-8e07-8951c22eb945", "chatbotActionId": "", "fieldName": "", "saveToVariable": "" } ] }, "chatbotActionDynamics365CreateRecord": { "ifUpdateDuplicatedRecord": true, "saveRecordIdToVariable": "", "nextActionId": "bbec7c36-9c72-4789-8e07-8951c22eb945", "entity": "", "entitySetName": "", "chatbotActionId": "", "chatbotActionDynamics365CreateRecordFields": [ { "id": "bbec7c36-9c72-4789-8e07-8951c22eb945", "fieldName": "", "chatbotActionId": "", "fieldValue": "" } ] }, "chatbotActionDynamics365FindRecord": { "successedActionId": "bbec7c36-9c72-4789-8e07-8951c22eb945", "searchValue": "", "chatbotActionId": "", "fieldToSearchBy": "", "entitySetName": "", "failedActionId": "bbec7c36-9c72-4789-8e07-8951c22eb945", "entity": "", "chatbotActionDynamics365FindRecordFields": [ { "saveToVariable": "", "id": "bbec7c36-9c72-4789-8e07-8951c22eb945", "chatbotActionId": "", "fieldName": "" } ] }, "chatbotActionDynamics365FindRecordByFetchXml": { "entitySetName": "", "fetchXml": "", "entity": "", "successedActionId": "bbec7c36-9c72-4789-8e07-8951c22eb945", "failedActionId": "bbec7c36-9c72-4789-8e07-8951c22eb945", "chatbotActionId": "", "chatbotActionDynamics365FindRecordFieldByFetchXmls": [ { "saveToVariable": "", "id": "bbec7c36-9c72-4789-8e07-8951c22eb945", "chatbotActionId": "", "fieldName": "" } ] } } ] } } ``` ### Create a new Chatbot Intent Answer `POST bot/chatbotIntentAnswers` - #### Parameters: | Name | Type | in | Required | Description | | --- | --- | --- | --- | --- | | `intentId` | guid | body | yes | Id of the intent. | | `channelId` | string | body | yes | Channel: Live Chat, Facebook Messenger, Twitter Direct Message, WeChat, WhatsApp, SMS. | | `order` | integer | body | no | Must be greater than or equal to 0, ascending order. | | `collectInfoType` | string | body | no | Allowed values are "none", "form", "prompt". | | `chatbotResponseId` | guid | body | no | Id of the chatbot response. | | `chatbotResponse` | [chatbotResponse](/docs/server-api-bot-chatbot-intent-answer#chatbot-response-json-format) | body | no | Reference to Chatbot Response. | - #### Response: [Chatbot Intent Answer](/docs/server-api-bot-chatbot-intent-answer#chatbot-intent-answer-json-format) - #### Example Sample Request: ``` curl https://api11.comm100.io/v4/bot/chatbotIntentAnswers \ -X 'POST' \ -H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ -D '{"intentId":"54c51763-8241-40a7-bb61-95231a03bb86","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 "}]}}]}}' ``` Response: HTTP/1.1 201 Created ``` { "id": "ad63659e-4595-454a-9401-e33d9df7b640", "intentId": "54c51763-8241-40a7-bb61-95231a03bb86", "channelId": "Live Chat", "order": 0, "collectInfoType": "form", "chatbotResponseId": "ecd57b2b-2a7a-4059-8e63-ad5c8e291048", "chatbotResponse": { "id": "e8bf0d25-eed6-4a46-a417-318e15019609", "chatbotActions": [ { "xPosition": 50, "yPosition": 50, "id": "99AC0127-87DB-432B-B1A8-0000567BE2FB", "type": "chatbotActionStart", "chatbotResponseId": "e8bf0d25-eed6-4a46-a417-318e15019609", "chatbotActionStart": { "chatbotActionId": "99AC0127-87DB-432B-B1A8-0000567BE2FB", "nextActionId": "ea5369ae-b5cf-4bfa-a5fa-9dac234cf4c5" }, "chatbotActionCollectComment": { "typingDelay": 1.0, "chatbotActionId": "B81DAE9A-E89E-4267-AFB6-04131E9E8FD7", "nextActionId": "00000000-0000-0000-0000-000000000000", "isInputAreaEnabled": false, "message": "What's your comment?" }, "chatbotActionCollectCompanyName": { "chatbotActionId": "59BD2CB6-8CBF-4CCE-AED6-19BB69A2D657", "isInputAreaEnabled": false, "typingDelay": 1.0, "message": "What's your company name?", "nextActionId": "478EE923-458A-4EAA-A698-98DDB64DCF19" }, "chatbotActionCollectEmail": { "message": "What's your email?", "typingDelay": 1.0, "chatbotActionId": "E33EF495-C94C-4677-9B7F-01AA05B74F54", "isInputAreaEnabled": false, "nextActionId": "478EE923-458A-4EAA-A698-98DDB64DCF19" }, "chatbotActionCollectLocation": { "chatbotActionId": "5AEDCED1-B677-4861-A8B6-002B5819C036", "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" }, "chatbotActionCollectName": { "isInputAreaEnabled": true, "typingDelay": 1.0, "chatbotActionId": "33D4B0A1-19EA-4449-B7D3-0F4D94B6FF46", "message": "What's your name?", "nextActionId": "00000000-0000-0000-0000-000000000000" }, "chatbotActionCollectPhoneNumber": { "nextActionId": "AA310D7E-24AB-422E-8976-B83336700527", "chatbotActionId": "21DA2E94-DB52-407B-A96A-023FB0B13420", "isInputAreaEnabled": true, "message": "What's your phone number?", "typingDelay": 1.0 }, "chatbotActionCollectVariableData": { "typingDelay": 1.0, "nextActionId": "18DAA6C1-7468-471D-BB30-E7AE0BE09FFC", "variableName": "text", "options": [], "isInputAreaEnabled": false, "message": "text", "type": "text", "chatbotActionId": "A7573C4C-A676-4212-9AD6-0CA6E171F7CA" }, "chatbotActionGoToTaskbot": { "taskbotId": "F198799B-F8DE-40B4-94A9-004848BE0918", "chatbotActionId": "55A474CC-4074-49DE-BEB9-184C1D7E13FC" }, "chatbotActionQuickReply": { "typingDelay": 0.0, "otherResponseToActionId": "00000000-0000-0000-0000-000000000000", "chatbotActionId": "6C358A2D-FED6-49D6-B987-01C8E4701CD6", "isInputAreaEnabled": true, "message": "custom qp-have message", "chatbotActionQuickReplyOptions": [ { "order": 0, "nextActionId": "177C7AE7-B792-420C-82D3-563564B8647D", "chatbotActionId": "C5077D4D-9897-4258-B418-EBEF5E8F51D7", "id": "8076723A-2980-4CED-89D7-00234C234DBE", "text": "goto taskbot " } ] }, "chatbotActionSendImage": { "message": "", "typingDelay": 0.0, "imageUrl": "", "nextActionId": "CC5AF23C-CCA4-4D2D-B25A-4BF891275F30", "image": "", "chatbotActionId": "CDACFBDE-BE26-40DC-95C2-002C1F37E161" }, "chatbotActionSendMessage": { "nextActionId": "00000000-0000-0000-0000-000000000000", "chatbotActionId": "DC79CBB7-B581-4481-BEE9-0007CC28C6D7", "variants": [ "" ], "message": "Hi there! I'm a chatbot, here to help answer your questions.", "typingDelay": 0.0, "chatbotActionSendMessageLinks": [ { "id": "2DFD43D3-A953-471A-BD6B-0008BEBB5264", "buttonText": "twitter", "type": "webview", "openIn": "sideWindow", "intentId": "00000000-0000-0000-0000-000000000000", "url": "https://www.baidu.com", "chatbotActionId": "E3A4A33C-1929-4862-B5CF-CCB6F71B0359", "openStyle": "compact", "order": 0 } ] }, "chatbotActionSendVideo": { "typingDelay": 0.0, "message": "", "chatbotActionId": "8596A4AD-CBF4-404F-8175-00D624BD5C02", "nextActionId": "00000000-0000-0000-0000-000000000000", "videoUrl": "https://www.youtube.com/watch?v=0XYWpraTgaY" }, "chatbotActionSSOLoginButton": { "typingDelay": 0.0, "isInputAreaEnabled": true, "successedActionId": "03DF237A-7F5F-45A8-A44C-042CD9D85E0C", "message": "signin message sso", "failedActionId": "00000000-0000-0000-0000-000000000000", "chatbotActionId": "F2935DC6-4FC1-4F66-9FB2-00105F31C34D", "loginButtonText": "signin-text sso" }, "chatbotActionTransferChat": { "transferTo": "87AD4BE9-89F5-4E57-AE9E-2D5FEE8ED3E5", "whenAgentOfflineToActionId": "00000000-0000-0000-0000-000000000000", "type": "transferToAgent", "chatbotActionId": "CA4989CE-1D34-4F32-8AA9-019F788FE0A9" }, "chatbotActionWebhook": { "ifSendChatTranscript": false, "url": "www.baidu.com", "chatbotActionId": "8627E871-BB36-45EC-AAD2-001BF039548B", "otherResponseToActionId": "00000000-0000-0000-0000-000000000000", "additionalPostBody": "", "chatbotActionWebhookHeaders": [ { "value": "v1", "id": "480DCC60-77F5-4A6C-B93E-008EA33F4874", "order": 0, "key": "k1", "chatbotActionId": "CC964045-886D-4EE2-B5F9-500407B67199" } ], "chatbotActionWebhookResponseCodeToActions": [ { "responseCode": "200", "nextActionId": "00000000-0000-0000-0000-000000000000", "order": 0, "id": "87199352-7B7B-4A44-9952-00276F291F1F", "chatbotActionId": "9284D918-E1D3-4D7E-8F6C-2B1A15529505" } ], "chatbotActionWebhookResponseToVariables": [ { "chatbotActionId": "9E03760E-03B6-488F-85DB-72D395AB26EE", "order": 0, "id": "B859FE33-817F-4654-8C84-2BC332304AA4", "responseKey": "fdafa", "variableName": "2342432432132131" } ] }, "chatbotActionSendEmail": { "to": "Simon", "subject": "API Test", "chatbotActionId": "2DFE48BD-D7CE-4ECD-8C98-2B00BB5A665F", "cc": "jansemain", "content": "Delete", "nextActionId": "60F2F597-5674-41D8-BBFD-0AEAAF787837" }, "chatbotActionBookMeeting": { "failedActionId": "00000000-0000-0000-0000-000000000000", "calendlyEventTypeUri": "http://localhost/event_types/15", "chatbotActionId": "087826DE-7DA2-4E9E-B348-8E41B6EFD8CF", "successedActionId": "00000000-0000-0000-0000-000000000000", "integrationCalendlyId": "7E8DFDA2-2117-4796-93D0-8A51047CE1BC" }, "chatbotActionSendForm": { "title": "Via a Form title", "message": "Via a Form", "chatbotActionId": "14BFE247-AA16-4D2A-8639-003944A72AE3", "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", "chatbotActionId": "BEAD6DFE-0EC2-4862-A601-9D6F7596063B", "entityId": "00000000-0000-0000-0000-000000000000", "variableName": "", "ifPrebuiltEntity": true, "isMasked": true, "isRequired": true, "name": "test", "id": "AFA6F9DF-AA97-44ED-99DE-E22F9A7E9F01", "order": 0, "prebuiltEntityId": "00000000-0000-0000-0000-000000000000" } ] }, "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", "chatbotActionId": "520F4EB3-807E-4C85-88D7-0002BA6181A6", "optionTextWhenAgentOnline": "Chat with Live Agent", "typingDelay": 0.0 }, "chatbotActionSendCannedQuickReply": { "cannedQuickReplyId": "D62DE3F6-A55E-4AB2-9DA3-2AF33849306D", "chatbotActionId": "FE618181-724D-4A25-A8FA-000570E5B0A5", "message": "", "isInputAreaEnabled": true, "anyOtherResponseActionId": "00000000-0000-0000-0000-000000000000", "typingDelay": 0.0 }, "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": "", "chatbotActionId": "5A1F13F9-4E76-432B-8919-011CCEF7F48F", "saveToType": "customVariable", "customVariable": { "id": "6BB15329-7C46-EB11-8100-00155D081D0B", "name": "c_v_name", "value": "c_v_value", "hyperlink": "{!Visitor.IP}", "type": "text" }, "ticketingField": { "isSystem": false, "isRequired": false, "type": "dropdownList", "name": "My Select", "systemName": "", "length": 256, "helpText": "My custom select.", "defaultValue": "op1", "linkURL": "", "id": "110499d0-5a3e-469f-b8de-9a34e99092b0", "order": 1, "fieldOptions": [ { "id": "8bf39eb8-be1e-48b7-b324-85e152f42432", "fieldId": "110499d0-5a3e-469f-b8de-9a34e99092b0", "value": "op1", "order": 1, "displayText": "op1" } ] } }, "chatbotActionGoToIntent": { "intentId": "4C36FC4D-9CEC-4AB4-9F00-8D8B20EA47A8", "chatbotActionId": "2D133B3C-2B67-4D2A-B0A5-0050CD10F2DD" }, "chatbotActionLeaveChat": { "chatbotActionId": "EC859694-3DD8-45FF-90CE-88D7CB4A928E" }, "chatbotActionSendNumericMenu": { "isInputAreaEnabled": true, "chatbotActionId": "3F05B173-8776-4621-84AC-46AB8B4E1AD5", "otherResponseToActionId": "00000000-0000-0000-0000-000000000000", "message": "hello", "chatbotActionSendNumericMenuOptions": [ { "nextActionId": "C8A26362-6823-4497-89B3-B54B06B2379A", "id": "AA4BECC8-8C84-4C73-9629-037E434AE7B7", "key": "3", "chatbotActionId": "85B9D2D3-C045-4D85-A7D9-789D1A9DD5D2", "order": 0, "text": "test" } ] }, "chatbotActionChangeAssignee": { "whenAgentOfflineToActionId": "00000000-0000-0000-0000-000000000000", "type": "transferToAgent", "chatbotActionId": "77AE7E44-6DC9-47D4-92C9-0326077F2D59", "transferTo": "6CC96F38-5FE2-448C-AFBB-3F3D109CF022" }, "chatbotActionCondition": { "chatbotActionId": "40278B68-ABCF-4FE9-9D24-09902CD64803", "otherCaseActionId": "00000000-0000-0000-0000-000000000000", "chatbotActionConditionCases": [ { "order": 0, "id": "8FC74E84-72CB-41A7-BC7F-0281D21C2FE4", "logicalExpression": "", "goToActionId": "00000000-0000-0000-0000-000000000000", "chatbotActionId": "D5FD270C-70FB-4443-ACDF-3CA489549728", "conditionExpressionType": "all", "chatbotActionConditionCaseConditions": [ { "order": 0, "operator": "is", "value": "fdsfsdaf", "chatbotActionConditionCaseId": "AFA6F9DF-AA97-44ED-99DE-E22F9A7E9F01", "id": "A2D29F26-5F2D-4167-954F-01927F439919", "fieldName": "{!Variable.Name}" } ] } ] }, "chatbotActionTransferZendeskChat": { "transferTo": "", "type": "", "whenAgentOfflineToActionId": "bbec7c36-9c72-4789-8e07-8951c22eb945", "chatbotActionId": "" }, "chatbotActionSalesforceCreateRecord": { "saveRecordIdToVariable": "", "nextActionId": "bbec7c36-9c72-4789-8e07-8951c22eb945", "ifUpdateDuplicatedRecord": true, "object": "", "chatbotActionId": "", "chatbotActionSalesforceCreateRecordFields": [ { "fieldValue": "", "chatbotActionId": "", "id": "bbec7c36-9c72-4789-8e07-8951c22eb945", "fieldName": "" } ] }, "chatbotActionSalesforceFindRecord": { "fieldToSearchBy": "", "object": "", "failedActionId": "bbec7c36-9c72-4789-8e07-8951c22eb945", "searchValue": "", "chatbotActionId": "", "successedActionId": "bbec7c36-9c72-4789-8e07-8951c22eb945", "chatbotActionSalesforceFindRecordFields": [ { "saveToVariable": "", "chatbotActionId": "", "id": "bbec7c36-9c72-4789-8e07-8951c22eb945", "fieldName": "" } ] }, "chatbotActionSalesforceFindRecordBySoql": { "chatbotActionId": "", "soql": "", "failedActionId": "bbec7c36-9c72-4789-8e07-8951c22eb945", "successedActionId": "bbec7c36-9c72-4789-8e07-8951c22eb945", "chatbotActionSalesforceFindRecordFieldBySoqls": [ { "id": "bbec7c36-9c72-4789-8e07-8951c22eb945", "chatbotActionId": "", "fieldName": "", "saveToVariable": "" } ] }, "chatbotActionDynamics365CreateRecord": { "ifUpdateDuplicatedRecord": true, "saveRecordIdToVariable": "", "nextActionId": "bbec7c36-9c72-4789-8e07-8951c22eb945", "entity": "", "entitySetName": "", "chatbotActionId": "", "chatbotActionDynamics365CreateRecordFields": [ { "id": "bbec7c36-9c72-4789-8e07-8951c22eb945", "fieldName": "", "chatbotActionId": "", "fieldValue": "" } ] }, "chatbotActionDynamics365FindRecord": { "successedActionId": "bbec7c36-9c72-4789-8e07-8951c22eb945", "searchValue": "", "chatbotActionId": "", "fieldToSearchBy": "", "entitySetName": "", "failedActionId": "bbec7c36-9c72-4789-8e07-8951c22eb945", "entity": "", "chatbotActionDynamics365FindRecordFields": [ { "saveToVariable": "", "id": "bbec7c36-9c72-4789-8e07-8951c22eb945", "chatbotActionId": "", "fieldName": "" } ] }, "chatbotActionDynamics365FindRecordByFetchXml": { "entitySetName": "", "fetchXml": "", "entity": "", "successedActionId": "bbec7c36-9c72-4789-8e07-8951c22eb945", "failedActionId": "bbec7c36-9c72-4789-8e07-8951c22eb945", "chatbotActionId": "", "chatbotActionDynamics365FindRecordFieldByFetchXmls": [ { "saveToVariable": "", "id": "bbec7c36-9c72-4789-8e07-8951c22eb945", "chatbotActionId": "", "fieldName": "" } ] } } ] } } ``` ### Update the Chatbot Intent Answer `PUT bot/chatbotIntentAnswers/{id}` - #### Parameters: | Name | Type | in | Required | Description | | --- | --- | --- | --- | --- | | `intentId` | guid | body | yes | Id of the intent. | | `channelId` | string | body | yes | Channel: Live Chat, Facebook Messenger, Twitter Direct Message, WeChat, WhatsApp, SMS. | | `order` | integer | body | no | Must be greater than or equal to 0, ascending order. | | `collectInfoType` | string | body | no | Allowed values are "none", "form", "prompt". | | `chatbotResponseId` | guid | body | no | Id of the chatbot response. | | `chatbotResponse` | [chatbotResponse](/docs/server-api-bot-chatbot-intent-answer#chatbot-response-json-format) | body | no | Reference to Chatbot Response. | - #### Response: [Chatbot Intent Answer](/docs/server-api-bot-chatbot-intent-answer#chatbot-intent-answer-json-format) - #### Example Sample Request: ``` curl https://api11.comm100.io/v4/bot/chatbotIntentAnswers/ad63659e-4595-454a-9401-e33d9df7b640 \ -X 'PUT' \ -H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ -D '{"intentId":"54c51763-8241-40a7-bb61-95231a03bb86","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 "}]}}]}}' ``` Response: HTTP/1.1 200 OK ``` { "id": "ad63659e-4595-454a-9401-e33d9df7b640", "intentId": "54c51763-8241-40a7-bb61-95231a03bb86", "channelId": "Live Chat", "order": 0, "collectInfoType": "form", "chatbotResponseId": "ecd57b2b-2a7a-4059-8e63-ad5c8e291048", "chatbotResponse": { "id": "e8bf0d25-eed6-4a46-a417-318e15019609", "chatbotActions": [ { "xPosition": 50, "yPosition": 50, "id": "99AC0127-87DB-432B-B1A8-0000567BE2FB", "type": "chatbotActionStart", "chatbotResponseId": "e8bf0d25-eed6-4a46-a417-318e15019609", "chatbotActionStart": { "chatbotActionId": "99AC0127-87DB-432B-B1A8-0000567BE2FB", "nextActionId": "ea5369ae-b5cf-4bfa-a5fa-9dac234cf4c5" }, "chatbotActionCollectComment": { "typingDelay": 1.0, "chatbotActionId": "B81DAE9A-E89E-4267-AFB6-04131E9E8FD7", "nextActionId": "00000000-0000-0000-0000-000000000000", "isInputAreaEnabled": false, "message": "What's your comment?" }, "chatbotActionCollectCompanyName": { "chatbotActionId": "59BD2CB6-8CBF-4CCE-AED6-19BB69A2D657", "isInputAreaEnabled": false, "typingDelay": 1.0, "message": "What's your company name?", "nextActionId": "478EE923-458A-4EAA-A698-98DDB64DCF19" }, "chatbotActionCollectEmail": { "message": "What's your email?", "typingDelay": 1.0, "chatbotActionId": "E33EF495-C94C-4677-9B7F-01AA05B74F54", "isInputAreaEnabled": false, "nextActionId": "478EE923-458A-4EAA-A698-98DDB64DCF19" }, "chatbotActionCollectLocation": { "chatbotActionId": "5AEDCED1-B677-4861-A8B6-002B5819C036", "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" }, "chatbotActionCollectName": { "isInputAreaEnabled": true, "typingDelay": 1.0, "chatbotActionId": "33D4B0A1-19EA-4449-B7D3-0F4D94B6FF46", "message": "What's your name?", "nextActionId": "00000000-0000-0000-0000-000000000000" }, "chatbotActionCollectPhoneNumber": { "nextActionId": "AA310D7E-24AB-422E-8976-B83336700527", "chatbotActionId": "21DA2E94-DB52-407B-A96A-023FB0B13420", "isInputAreaEnabled": true, "message": "What's your phone number?", "typingDelay": 1.0 }, "chatbotActionCollectVariableData": { "typingDelay": 1.0, "nextActionId": "18DAA6C1-7468-471D-BB30-E7AE0BE09FFC", "variableName": "text", "options": [], "isInputAreaEnabled": false, "message": "text", "type": "text", "chatbotActionId": "A7573C4C-A676-4212-9AD6-0CA6E171F7CA" }, "chatbotActionGoToTaskbot": { "taskbotId": "F198799B-F8DE-40B4-94A9-004848BE0918", "chatbotActionId": "55A474CC-4074-49DE-BEB9-184C1D7E13FC" }, "chatbotActionQuickReply": { "typingDelay": 0.0, "otherResponseToActionId": "00000000-0000-0000-0000-000000000000", "chatbotActionId": "6C358A2D-FED6-49D6-B987-01C8E4701CD6", "isInputAreaEnabled": true, "message": "custom qp-have message", "chatbotActionQuickReplyOptions": [ { "order": 0, "nextActionId": "177C7AE7-B792-420C-82D3-563564B8647D", "chatbotActionId": "C5077D4D-9897-4258-B418-EBEF5E8F51D7", "id": "8076723A-2980-4CED-89D7-00234C234DBE", "text": "goto taskbot " } ] }, "chatbotActionSendImage": { "message": "", "typingDelay": 0.0, "imageUrl": "", "nextActionId": "CC5AF23C-CCA4-4D2D-B25A-4BF891275F30", "image": "", "chatbotActionId": "CDACFBDE-BE26-40DC-95C2-002C1F37E161" }, "chatbotActionSendMessage": { "nextActionId": "00000000-0000-0000-0000-000000000000", "chatbotActionId": "DC79CBB7-B581-4481-BEE9-0007CC28C6D7", "variants": [ "" ], "message": "Hi there! I'm a chatbot, here to help answer your questions.", "typingDelay": 0.0, "chatbotActionSendMessageLinks": [ { "id": "2DFD43D3-A953-471A-BD6B-0008BEBB5264", "buttonText": "twitter", "type": "webview", "openIn": "sideWindow", "intentId": "00000000-0000-0000-0000-000000000000", "url": "https://www.baidu.com", "chatbotActionId": "E3A4A33C-1929-4862-B5CF-CCB6F71B0359", "openStyle": "compact", "order": 0 } ] }, "chatbotActionSendVideo": { "typingDelay": 0.0, "message": "", "chatbotActionId": "8596A4AD-CBF4-404F-8175-00D624BD5C02", "nextActionId": "00000000-0000-0000-0000-000000000000", "videoUrl": "https://www.youtube.com/watch?v=0XYWpraTgaY" }, "chatbotActionSSOLoginButton": { "typingDelay": 0.0, "isInputAreaEnabled": true, "successedActionId": "03DF237A-7F5F-45A8-A44C-042CD9D85E0C", "message": "signin message sso", "failedActionId": "00000000-0000-0000-0000-000000000000", "chatbotActionId": "F2935DC6-4FC1-4F66-9FB2-00105F31C34D", "loginButtonText": "signin-text sso" }, "chatbotActionTransferChat": { "transferTo": "87AD4BE9-89F5-4E57-AE9E-2D5FEE8ED3E5", "whenAgentOfflineToActionId": "00000000-0000-0000-0000-000000000000", "type": "transferToAgent", "chatbotActionId": "CA4989CE-1D34-4F32-8AA9-019F788FE0A9" }, "chatbotActionWebhook": { "ifSendChatTranscript": false, "url": "www.baidu.com", "chatbotActionId": "8627E871-BB36-45EC-AAD2-001BF039548B", "otherResponseToActionId": "00000000-0000-0000-0000-000000000000", "additionalPostBody": "", "chatbotActionWebhookHeaders": [ { "value": "v1", "id": "480DCC60-77F5-4A6C-B93E-008EA33F4874", "order": 0, "key": "k1", "chatbotActionId": "CC964045-886D-4EE2-B5F9-500407B67199" } ], "chatbotActionWebhookResponseCodeToActions": [ { "responseCode": "200", "nextActionId": "00000000-0000-0000-0000-000000000000", "order": 0, "id": "87199352-7B7B-4A44-9952-00276F291F1F", "chatbotActionId": "9284D918-E1D3-4D7E-8F6C-2B1A15529505" } ], "chatbotActionWebhookResponseToVariables": [ { "chatbotActionId": "9E03760E-03B6-488F-85DB-72D395AB26EE", "order": 0, "id": "B859FE33-817F-4654-8C84-2BC332304AA4", "responseKey": "fdafa", "variableName": "2342432432132131" } ] }, "chatbotActionSendEmail": { "to": "Simon", "subject": "API Test", "chatbotActionId": "2DFE48BD-D7CE-4ECD-8C98-2B00BB5A665F", "cc": "jansemain", "content": "Delete", "nextActionId": "60F2F597-5674-41D8-BBFD-0AEAAF787837" }, "chatbotActionBookMeeting": { "failedActionId": "00000000-0000-0000-0000-000000000000", "calendlyEventTypeUri": "http://localhost/event_types/15", "chatbotActionId": "087826DE-7DA2-4E9E-B348-8E41B6EFD8CF", "successedActionId": "00000000-0000-0000-0000-000000000000", "integrationCalendlyId": "7E8DFDA2-2117-4796-93D0-8A51047CE1BC" }, "chatbotActionSendForm": { "title": "Via a Form title", "message": "Via a Form", "chatbotActionId": "14BFE247-AA16-4D2A-8639-003944A72AE3", "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", "chatbotActionId": "BEAD6DFE-0EC2-4862-A601-9D6F7596063B", "entityId": "00000000-0000-0000-0000-000000000000", "variableName": "", "ifPrebuiltEntity": true, "isMasked": true, "isRequired": true, "name": "test", "id": "AFA6F9DF-AA97-44ED-99DE-E22F9A7E9F01", "order": 0, "prebuiltEntityId": "00000000-0000-0000-0000-000000000000" } ] }, "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", "chatbotActionId": "520F4EB3-807E-4C85-88D7-0002BA6181A6", "optionTextWhenAgentOnline": "Chat with Live Agent", "typingDelay": 0.0 }, "chatbotActionSendCannedQuickReply": { "cannedQuickReplyId": "D62DE3F6-A55E-4AB2-9DA3-2AF33849306D", "chatbotActionId": "FE618181-724D-4A25-A8FA-000570E5B0A5", "message": "", "isInputAreaEnabled": true, "anyOtherResponseActionId": "00000000-0000-0000-0000-000000000000", "typingDelay": 0.0 }, "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": "", "chatbotActionId": "5A1F13F9-4E76-432B-8919-011CCEF7F48F", "saveToType": "customVariable", "customVariable": { "id": "6BB15329-7C46-EB11-8100-00155D081D0B", "name": "c_v_name", "value": "c_v_value", "hyperlink": "{!Visitor.IP}", "type": "text" }, "ticketingField": { "isSystem": false, "isRequired": false, "type": "dropdownList", "name": "My Select", "systemName": "", "length": 256, "helpText": "My custom select.", "defaultValue": "op1", "linkURL": "", "id": "110499d0-5a3e-469f-b8de-9a34e99092b0", "order": 1, "fieldOptions": [ { "id": "8bf39eb8-be1e-48b7-b324-85e152f42432", "fieldId": "110499d0-5a3e-469f-b8de-9a34e99092b0", "value": "op1", "order": 1, "displayText": "op1" } ] } }, "chatbotActionGoToIntent": { "intentId": "4C36FC4D-9CEC-4AB4-9F00-8D8B20EA47A8", "chatbotActionId": "2D133B3C-2B67-4D2A-B0A5-0050CD10F2DD" }, "chatbotActionLeaveChat": { "chatbotActionId": "EC859694-3DD8-45FF-90CE-88D7CB4A928E" }, "chatbotActionSendNumericMenu": { "isInputAreaEnabled": true, "chatbotActionId": "3F05B173-8776-4621-84AC-46AB8B4E1AD5", "otherResponseToActionId": "00000000-0000-0000-0000-000000000000", "message": "hello", "chatbotActionSendNumericMenuOptions": [ { "nextActionId": "C8A26362-6823-4497-89B3-B54B06B2379A", "id": "AA4BECC8-8C84-4C73-9629-037E434AE7B7", "key": "3", "chatbotActionId": "85B9D2D3-C045-4D85-A7D9-789D1A9DD5D2", "order": 0, "text": "test" } ] }, "chatbotActionChangeAssignee": { "whenAgentOfflineToActionId": "00000000-0000-0000-0000-000000000000", "type": "transferToAgent", "chatbotActionId": "77AE7E44-6DC9-47D4-92C9-0326077F2D59", "transferTo": "6CC96F38-5FE2-448C-AFBB-3F3D109CF022" }, "chatbotActionCondition": { "chatbotActionId": "40278B68-ABCF-4FE9-9D24-09902CD64803", "otherCaseActionId": "00000000-0000-0000-0000-000000000000", "chatbotActionConditionCases": [ { "order": 0, "id": "8FC74E84-72CB-41A7-BC7F-0281D21C2FE4", "logicalExpression": "", "goToActionId": "00000000-0000-0000-0000-000000000000", "chatbotActionId": "D5FD270C-70FB-4443-ACDF-3CA489549728", "conditionExpressionType": "all", "chatbotActionConditionCaseConditions": [ { "order": 0, "operator": "is", "value": "fdsfsdaf", "chatbotActionConditionCaseId": "AFA6F9DF-AA97-44ED-99DE-E22F9A7E9F01", "id": "A2D29F26-5F2D-4167-954F-01927F439919", "fieldName": "{!Variable.Name}" } ] } ] }, "chatbotActionTransferZendeskChat": { "transferTo": "", "type": "", "whenAgentOfflineToActionId": "bbec7c36-9c72-4789-8e07-8951c22eb945", "chatbotActionId": "" }, "chatbotActionSalesforceCreateRecord": { "saveRecordIdToVariable": "", "nextActionId": "bbec7c36-9c72-4789-8e07-8951c22eb945", "ifUpdateDuplicatedRecord": true, "object": "", "chatbotActionId": "", "chatbotActionSalesforceCreateRecordFields": [ { "fieldValue": "", "chatbotActionId": "", "id": "bbec7c36-9c72-4789-8e07-8951c22eb945", "fieldName": "" } ] }, "chatbotActionSalesforceFindRecord": { "fieldToSearchBy": "", "object": "", "failedActionId": "bbec7c36-9c72-4789-8e07-8951c22eb945", "searchValue": "", "chatbotActionId": "", "successedActionId": "bbec7c36-9c72-4789-8e07-8951c22eb945", "chatbotActionSalesforceFindRecordFields": [ { "saveToVariable": "", "chatbotActionId": "", "id": "bbec7c36-9c72-4789-8e07-8951c22eb945", "fieldName": "" } ] }, "chatbotActionSalesforceFindRecordBySoql": { "chatbotActionId": "", "soql": "", "failedActionId": "bbec7c36-9c72-4789-8e07-8951c22eb945", "successedActionId": "bbec7c36-9c72-4789-8e07-8951c22eb945", "chatbotActionSalesforceFindRecordFieldBySoqls": [ { "id": "bbec7c36-9c72-4789-8e07-8951c22eb945", "chatbotActionId": "", "fieldName": "", "saveToVariable": "" } ] }, "chatbotActionDynamics365CreateRecord": { "ifUpdateDuplicatedRecord": true, "saveRecordIdToVariable": "", "nextActionId": "bbec7c36-9c72-4789-8e07-8951c22eb945", "entity": "", "entitySetName": "", "chatbotActionId": "", "chatbotActionDynamics365CreateRecordFields": [ { "id": "bbec7c36-9c72-4789-8e07-8951c22eb945", "fieldName": "", "chatbotActionId": "", "fieldValue": "" } ] }, "chatbotActionDynamics365FindRecord": { "successedActionId": "bbec7c36-9c72-4789-8e07-8951c22eb945", "searchValue": "", "chatbotActionId": "", "fieldToSearchBy": "", "entitySetName": "", "failedActionId": "bbec7c36-9c72-4789-8e07-8951c22eb945", "entity": "", "chatbotActionDynamics365FindRecordFields": [ { "saveToVariable": "", "id": "bbec7c36-9c72-4789-8e07-8951c22eb945", "chatbotActionId": "", "fieldName": "" } ] }, "chatbotActionDynamics365FindRecordByFetchXml": { "entitySetName": "", "fetchXml": "", "entity": "", "successedActionId": "bbec7c36-9c72-4789-8e07-8951c22eb945", "failedActionId": "bbec7c36-9c72-4789-8e07-8951c22eb945", "chatbotActionId": "", "chatbotActionDynamics365FindRecordFieldByFetchXmls": [ { "saveToVariable": "", "id": "bbec7c36-9c72-4789-8e07-8951c22eb945", "chatbotActionId": "", "fieldName": "" } ] } } ] } } ``` ### Remove the Chatbot Intent Answer `DELETE bot/chatbotIntentAnswers/{id}` - #### Parameters: No Parameters - #### Response: No Content - #### Example Sample Request: ``` curl https://api11.comm100.io/v4/bot/chatbotIntentAnswers/ad63659e-4595-454a-9401-e33d9df7b640 \ -X 'DELETE' \ -H 'Authorization: Bearer {access_token}' \ ``` Response: HTTP/1.1 204 No Content