--- title: "Taskbot Version" slug: "server-api-bot-taskbot-version" updated: 2022-07-14T03:03:45Z published: 2022-07-14T03:03:45Z canonical: "developer.comm100.com/server-api-bot-taskbot-version" --- > ## 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. # Taskbot Version ## Taskbot Version - `Taskbot Versions` - Taskbot Versions Manage - `GET bot/taskbotVersions` - [Get the list of Taskbot Versions](/docs/server-api-bot-taskbot-version#get-the-list-of-taskbot-versions) - `GET bot/taskbotVersions/{id}` - [Get a single Taskbot Version](/docs/server-api-bot-taskbot-version#get-a-single-taskbot-version) - `POST bot/taskbotVersions` - [Create a new Taskbot Version](/docs/server-api-bot-taskbot-version#create-a-new-taskbot-version) - `Taskbot Actions` - Taskbot Actions Manage - `GET bot/taskbotActions` - [Get the list of Taskbot Actions](/docs/server-api-bot-taskbot-version#get-the-list-of-taskbot-actions) - `GET bot/taskbotActions/{id}` - [Get a single Taskbot Action](/docs/server-api-bot-taskbot-version#get-a-single-taskbot-action) - `POST bot/taskbotActions` - [Create a new Taskbot Action](/docs/server-api-bot-taskbot-version#create-a-new-taskbot-action) - `PUT bot/taskbotActions/{id}` - [Update the Taskbot Action](/docs/server-api-bot-taskbot-version#update-the-taskbot-action) - `DELETE bot/taskbotActions/{id}` - [Remove the Taskbot Action](/docs/server-api-bot-taskbot-version#remove-the-taskbot-action) - `Taskbot Starts` - Taskbot Starts Manage - `GET bot/taskbotActions/{id}/taskbotStart` - [Get a single Taskbot Start](/docs/server-api-bot-taskbot-version#get-a-single-taskbot-start) - `PUT bot/taskbotActions/{id}/taskbotStart` - [Update the Taskbot Start](/docs/server-api-bot-taskbot-version#update-the-taskbot-start) - `Taskbot Collect Comments` - Taskbot Collect Comments Manage - `GET bot/taskbotActions/{id}/taskbotCollectComment` - [Get a single Taskbot Collect Comment](/docs/server-api-bot-taskbot-version#get-a-single-taskbot-collect-comment) - `PUT bot/taskbotActions/{id}/taskbotCollectComment` - [Update the Taskbot Collect Comment](/docs/server-api-bot-taskbot-version#update-the-taskbot-collect-comment) - `Taskbot Collect Company Names` - Taskbot Collect Company Names Manage - `GET bot/taskbotActions/{id}/taskbotCollectCompanyName` - [Get a single Taskbot Collect Company Name](/docs/server-api-bot-taskbot-version#get-a-single-taskbot-collect-company-name) - `PUT bot/taskbotActions/{id}/taskbotCollectCompanyName` - [Update the Taskbot Collect Company Name](/docs/server-api-bot-taskbot-version#update-the-taskbot-collect-company-name) - `Taskbot Collect Emails` - Taskbot Collect Emails Manage - `GET bot/taskbotActions/{id}/taskbotCollectEmail` - [Get a single Taskbot Collect Email](/docs/server-api-bot-taskbot-version#get-a-single-taskbot-collect-email) - `PUT bot/taskbotActions/{id}/taskbotCollectEmail` - [Update the Taskbot Collect Email](/docs/server-api-bot-taskbot-version#update-the-taskbot-collect-email) - `Taskbot Send Emails` - Taskbot Send Emails Manage - `GET bot/taskbotActions/{id}/taskbotSendEmail` - [Get a single Taskbot Send Email](/docs/server-api-bot-taskbot-version#get-a-single-taskbot-send-email) - `PUT bot/taskbotActions/{id}/taskbotSendEmail` - [Update the Taskbot Send Email](/docs/server-api-bot-taskbot-version#update-the-taskbot-send-email) - `Taskbot Book Meetings` - Taskbot Book Meetings Manage - `GET bot/taskbotActions/{id}/taskbotBookMeeting` - [Get a single Taskbot Book Meeting](/docs/server-api-bot-taskbot-version#get-a-single-taskbot-book-meeting) - `PUT bot/taskbotActions/{id}/taskbotBookMeeting` - [Update the Taskbot Book Meeting](/docs/server-api-bot-taskbot-version#update-the-taskbot-book-meeting) - `Taskbot Collect Locations` - Taskbot Collect Locations Manage - `GET bot/taskbotActions/{id}/taskbotCollectLocation` - [Get a single Taskbot Collect Location](/docs/server-api-bot-taskbot-version#get-a-single-taskbot-collect-location) - `PUT bot/taskbotActions/{id}/taskbotCollectLocation` - [Update the Taskbot Collect Location](/docs/server-api-bot-taskbot-version#update-the-taskbot-collect-location) - `Taskbot Collect Names` - Taskbot Collect Names Manage - `GET bot/taskbotActions/{id}/taskbotCollectName` - [Get a single Taskbot Collect Name](/docs/server-api-bot-taskbot-version#get-a-single-taskbot-collect-name) - `PUT bot/taskbotActions/{id}/taskbotCollectName` - [Update the Taskbot Collect Name](/docs/server-api-bot-taskbot-version#update-the-taskbot-collect-name) - `Taskbot Collect Phone Numbers` - Taskbot Collect Phone Numbers Manage - `GET bot/taskbotActions/{id}/taskbotCollectPhoneNumber` - [Get a single Taskbot Collect Phone Number](/docs/server-api-bot-taskbot-version#get-a-single-taskbot-collect-phone-number) - `PUT bot/taskbotActions/{id}/taskbotCollectPhoneNumber` - [Update the Taskbot Collect Phone Number](/docs/server-api-bot-taskbot-version#update-the-taskbot-collect-phone-number) - `Taskbot Collect Variable Datas` - Taskbot Collect Variable Datas Manage - `GET bot/taskbotActions/{id}/taskbotCollectVariableData` - [Get a single Taskbot Collect Variable Data](/docs/server-api-bot-taskbot-version#get-a-single-taskbot-collect-variable-data) - `PUT bot/taskbotActions/{id}/taskbotCollectVariableData` - [Update the Taskbot Collect Variable Data](/docs/server-api-bot-taskbot-version#update-the-taskbot-collect-variable-data) - `Taskbot Go To Taskbots` - Taskbot Go To Taskbots Manage - `GET bot/taskbotActions/{id}/taskbotGotoTaskbot` - [Get a single Taskbot Go To Taskbot](/docs/server-api-bot-taskbot-version#get-a-single-taskbot-go-to-taskbot) - `PUT bot/taskbotActions/{id}/taskbotGotoTaskbot` - [Update the Taskbot Go To Taskbot](/docs/server-api-bot-taskbot-version#update-the-taskbot-go-to-taskbot) - `Taskbot Quick Replies` - Taskbot Quick Replies Manage - `GET bot/taskbotActions/{id}/taskbotQuickReply` - [Get a single Taskbot Quick Reply](/docs/server-api-bot-taskbot-version#get-a-single-taskbot-quick-reply) - `PUT bot/taskbotActions/{id}/taskbotQuickReply` - [Update the Taskbot Quick Reply](/docs/server-api-bot-taskbot-version#update-the-taskbot-quick-reply) - `Taskbot Quick Reply Options` - Taskbot Quick Reply Options Manage - `GET bot/taskbotQuickReplyOptions` - [Get the list of Taskbot Quick Reply Options](/docs/server-api-bot-taskbot-version#get-the-list-of-taskbot-quick-reply-options) - `GET bot/taskbotQuickReplyOptions/{id}` - [Get a single Taskbot Quick Reply Option](/docs/server-api-bot-taskbot-version#get-a-single-taskbot-quick-reply-option) - `POST bot/taskbotQuickReplyOptions` - [Create a new Taskbot Quick Reply Option](/docs/server-api-bot-taskbot-version#create-a-new-taskbot-quick-reply-option) - `PUT bot/taskbotQuickReplyOptions/{id}` - [Update the Taskbot Quick Reply Option](/docs/server-api-bot-taskbot-version#update-the-taskbot-quick-reply-option) - `DELETE bot/taskbotQuickReplyOptions/{id}` - [Remove the Taskbot Quick Reply Option](/docs/server-api-bot-taskbot-version#remove-the-taskbot-quick-reply-option) - `Taskbot Send Images` - Taskbot Send Images Manage - `GET bot/taskbotActions/{id}/taskbotSendImage` - [Get a single Taskbot Send Image](/docs/server-api-bot-taskbot-version#get-a-single-taskbot-send-image) - `PUT bot/taskbotActions/{id}/taskbotSendImage` - [Update the Taskbot Send Image](/docs/server-api-bot-taskbot-version#update-the-taskbot-send-image) - `Taskbot Send Messages` - Taskbot Send Messages Manage - `GET bot/taskbotActions/{id}/taskbotSendMessage` - [Get a single Taskbot Send Message](/docs/server-api-bot-taskbot-version#get-a-single-taskbot-send-message) - `PUT bot/taskbotActions/{id}/taskbotSendMessage` - [Update the Taskbot Send Message](/docs/server-api-bot-taskbot-version#update-the-taskbot-send-message) - `Taskbot Send Message Buttons` - Taskbot Send Message Buttons Manage - `GET bot/taskbotSendMessageButtons` - [Get the list of Taskbot Send Message Buttons](/docs/server-api-bot-taskbot-version#get-the-list-of-taskbot-send-message-buttons) - `GET bot/taskbotSendMessageButtons/{id}` - [Get a single Taskbot Send Message Button](/docs/server-api-bot-taskbot-version#get-a-single-taskbot-send-message-button) - `POST bot/taskbotSendMessageButtons` - [Create a new Taskbot Send Message Button](/docs/server-api-bot-taskbot-version#create-a-new-taskbot-send-message-button) - `PUT bot/taskbotSendMessageButtons/{id}` - [Update the Taskbot Send Message Button](/docs/server-api-bot-taskbot-version#update-the-taskbot-send-message-button) - `DELETE bot/taskbotSendMessageButtons/{id}` - [Remove the Taskbot Send Message Button](/docs/server-api-bot-taskbot-version#remove-the-taskbot-send-message-button) - `Taskbot Send Videos` - Taskbot Send Videos Manage - `GET bot/taskbotActions/{id}/taskbotSendVideo` - [Get a single Taskbot Send Video](/docs/server-api-bot-taskbot-version#get-a-single-taskbot-send-video) - `PUT bot/taskbotActions/{id}/taskbotSendVideo` - [Update the Taskbot Send Video](/docs/server-api-bot-taskbot-version#update-the-taskbot-send-video) - `Taskbot SSO Login Buttons` - Taskbot SSO Login Buttons Manage - `GET bot/taskbotActions/{id}/taskbotSSOLoginButton` - [Get a single Taskbot SSO Login Button](/docs/server-api-bot-taskbot-version#get-a-single-taskbot-sso-login-button) - `PUT bot/taskbotActions/{id}/taskbotSSOLoginButton` - [Update the Taskbot SSO Login Button](/docs/server-api-bot-taskbot-version#update-the-taskbot-sso-login-button) - `Taskbot Webhooks` - Taskbot Webhooks Manage - `GET bot/taskbotActions/{id}/taskbotWebhook` - [Get a single Taskbot Webhook](/docs/server-api-bot-taskbot-version#get-a-single-taskbot-webhook) - `PUT bot/taskbotActions/{id}/taskbotWebhook` - [Update the Taskbot Webhook](/docs/server-api-bot-taskbot-version#update-the-taskbot-webhook) - `Taskbot Webhook Headers` - Taskbot Webhook Headers Manage - `GET bot/taskbotWebhookHeaders` - [Get the list of Taskbot Webhook Headers](/docs/server-api-bot-taskbot-version#get-the-list-of-taskbot-webhook-headers) - `GET bot/taskbotWebhookHeaders/{id}` - [Get a single Taskbot Webhook Header](/docs/server-api-bot-taskbot-version#get-a-single-taskbot-webhook-header) - `POST bot/taskbotWebhookHeaders` - [Create a new Taskbot Webhook Header](/docs/server-api-bot-taskbot-version#create-a-new-taskbot-webhook-header) - `PUT bot/taskbotWebhookHeaders/{id}` - [Update the Taskbot Webhook Header](/docs/server-api-bot-taskbot-version#update-the-taskbot-webhook-header) - `DELETE bot/taskbotWebhookHeaders/{id}` - [Remove the Taskbot Webhook Header](/docs/server-api-bot-taskbot-version#remove-the-taskbot-webhook-header) - `Taskbot Webhook Response To Variables` - Taskbot Webhook Response To Variables Manage - `GET bot/taskbotWebhookResponseToVariables` - [Get the list of Taskbot Webhook Response To Variables](/docs/server-api-bot-taskbot-version#get-the-list-of-taskbot-webhook-response-to-variables) - `GET bot/taskbotWebhookResponseToVariables/{id}` - [Get a single Taskbot Webhook Response To Variable](/docs/server-api-bot-taskbot-version#get-a-single-taskbot-webhook-response-to-variable) - `POST bot/taskbotWebhookResponseToVariables` - [Create a new Taskbot Webhook Response To Variable](/docs/server-api-bot-taskbot-version#create-a-new-taskbot-webhook-response-to-variable) - `PUT bot/taskbotWebhookResponseToVariables/{id}` - [Update the Taskbot Webhook Response To Variable](/docs/server-api-bot-taskbot-version#update-the-taskbot-webhook-response-to-variable) - `DELETE bot/taskbotWebhookResponseToVariables/{id}` - [Remove the Taskbot Webhook Response To Variable](/docs/server-api-bot-taskbot-version#remove-the-taskbot-webhook-response-to-variable) - `Taskbot Webhook Response Code To Actions` - Taskbot Webhook Response Code To Actions Manage - `GET bot/taskbotWebhookResponseCodeToActions` - [Get the list of Taskbot Webhook Response Code To Actions](/docs/server-api-bot-taskbot-version#get-the-list-of-taskbot-webhook-response-code-to-actions) - `GET bot/taskbotWebhookResponseCodeToActions/{id}` - [Get a single Taskbot Webhook Response Code To Action](/docs/server-api-bot-taskbot-version#get-a-single-taskbot-webhook-response-code-to-action) - `POST bot/taskbotWebhookResponseCodeToActions` - [Create a new Taskbot Webhook Response Code To Action](/docs/server-api-bot-taskbot-version#create-a-new-taskbot-webhook-response-code-to-action) - `PUT bot/taskbotWebhookResponseCodeToActions/{id}` - [Update the Taskbot Webhook Response Code To Action](/docs/server-api-bot-taskbot-version#update-the-taskbot-webhook-response-code-to-action) - `DELETE bot/taskbotWebhookResponseCodeToActions/{id}` - [Remove the Taskbot Webhook Response Code To Action](/docs/server-api-bot-taskbot-version#remove-the-taskbot-webhook-response-code-to-action) ### Taskbot Version JSON Format Taskbot Version is represented as simple flat JSON objects with the following keys: | Name | Type | Description | | --- | --- | --- | | `id` | guid | Id of the taskbot version. | | `taskbotId` | guid | Id of the taskbot. | | `createdTime` | datetime | Taskbot created time. | | `taskbotActions` | [taskbotActions[]](/docs/server-api-bot-taskbot-version#taskbot-action-json-format) | Reference to Taskbot Action. | ### Get the list of Taskbot Versions `GET bot/taskbotVersions` - #### Parameters: | Name | Type | in | Required | Description | | --- | --- | --- | --- | --- | | `taskbotId` | guid | query | no | Id of the taskbot. | | `include` | string | query | no | Allowed value is "taskbotAction". | - #### Response: An array of [Taskbot Version](/docs/server-api-bot-taskbot-version#taskbot-version-json-format) - #### Example Sample Request: ``` curl https://api11.comm100.io/v4/bot/taskbotVersions \ -X 'GET' \ -H 'Authorization: Bearer {access_token}' \ ``` Response: HTTP/1.1 200 OK ``` [ { "id": "00000000-0000-0000-0000-000000000000", "taskbotId": "00000000-0000-0000-0000-000000000000", "createdTime": "2021-04-07T05:59:17.887Z", "taskbotActions": [ { "taskbotVersionId": "7A6A35A3-814A-EB11-8100-00155D081D0B", "xPosition": 50, "yPosition": 50, "type": "taskbotStart", "id": "A762827E-0D4B-EB11-8100-00155D081D0B", "taskbotStart": { "taskbotActionId": "F8A7A50B-B049-EB11-8100-00155D081D0B", "nextActionId": "d2be5b63-24dc-4c14-9926-788e9af54760" }, "taskbotCollectComment": { "typingDelay": 1.0, "message": "text", "nextActionId": "D4C7158C-644A-EB11-8100-00155D081D0B", "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B" }, "taskbotCollectCompanyName": { "typingDelay": 1.0, "message": "text", "nextActionId": "D4C7158C-644A-EB11-8100-00155D081D0B", "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B" }, "taskbotCollectEmail": { "typingDelay": 1.0, "message": "text", "nextActionId": "D4C7158C-644A-EB11-8100-00155D081D0B", "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B" }, "taskbotSendEmail": { "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "subject": "subject", "content": "content", "to": "test@comm100.com", "cc": "test1@comm100.com", "nextActionId": "9F813BFF-E65A-EB11-8101-00155D081D0B" }, "taskbotBookMeeting": { "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "failedActionId": "b3d0be60-e7a6-47e2-82b9-b30b31806663", "successActionId": "bbec7c36-9c72-4789-8e07-8951c22eb945", "integrationCalendlyId": "c2c165b7-d5ce-40e5-a492-f586f514a062", "calendlyEventTypeUri": "https://..." }, "taskbotCollectLocation": { "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "typingDelay": 1.0, "message": "shareLocation", "buttonText": "button", "successActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "failedActionId": "D6C7158C-644A-EB11-8100-00155D081D0B" }, "taskbotCollectName": { "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "nextActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "message": "text", "typingDelay": 1.0 }, "taskbotCollectPhoneNumber": { "typingDelay": 1.0, "message": "text", "nextActionId": "D4C7158C-644A-EB11-8100-00155D081D0B", "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B" }, "taskbotCollectVariableData": { "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "nextActionId": "D4C7158C-644A-EB11-8100-00155D081D0B", "variableName": "name", "options": "option1", "message": "text", "typingDelay": 1.0, "type": "text" }, "taskbotGotoTaskbot": { "taskbotActionId": "4E8E8CE8-AD49-EB11-8100-00155D081D0B", "taskbotId": "4E8E8CE8-AD49-EB11-8100-00155D081D0B" }, "taskbotQuickReply": { "taskbotActionId": "D0948954-AE49-EB11-8100-00155D081D0B", "typingDelay": 1.0, "message": "link to baidu", "otherResponseToActionId": "4CB9B085-AC49-EB11-8100-00155D081D0B", "taskbotQuickReplyOptions": [ { "id": "EF948954-AE49-EB11-8100-00155D081D0B", "taskbotActionId": "D0948954-AE49-EB11-8100-00155D081D0B", "text": "Baidu", "order": 0, "nextActionId": "F5948954-AE49-EB11-8100-00155D081D0B" } ] }, "taskbotSendImage": { "taskbotActionId": "7AE8FDBF-504A-EB11-8100-00155D081D0B", "nextActionId": "8AE8FDBF-504A-EB11-8100-00155D081D0B", "typingDelay": 1.0, "message": "test", "image": "https://api11.comm100.io/v4/Bot/taskbotSendImages/7AE8FDBF-504A-EB11-8100-00155D081D0B/image", "imageUrl": "" }, "taskbotSendMessage": { "taskbotActionId": "F8A7A50B-B049-EB11-8100-00155D081D0B", "typingDelay": 1.0, "message": "hi", "nextActionId": "76ef3d7c-372f-4c34-8642-e51496accdfc", "taskbotSendMessageButtons": [ { "id": "a0831b44-a2d0-4bed-96c4-43f7eb69b095", "taskbotActionId": "E4099BB1-774A-EB11-8100-00155D081D0B", "buttonText": "test", "url": "https://...", "order": 1, "type": "link", "openIn": "currentWindow", "openStyle": "compact" } ] }, "taskbotSendVideo": { "taskbotActionId": "4CB9B085-AC49-EB11-8100-00155D081D0B", "nextActionId": "D0948954-AE49-EB11-8100-00155D081D0B", "typingDelay": 1.0, "message": "test", "videoUrl": "https://..." }, "taskbotSSOLoginButton": { "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "typingDelay": 1.0, "message": "To get personized service, you need to login first.", "loginButtonText": "login", "loginInActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "failedActionId": "D6C7158C-644A-EB11-8100-00155D081D0B" }, "taskbotTransferChat": { "taskbotActionId": "B0101911-4E4A-EB11-8100-00155D081D0B", "type": "transferToDepartment", "transferTo": "EF101911-4E4A-EB11-8100-00155D081D0B", "whenAgentOfflineToActionId": "5A101911-4E4A-EB11-8100-00155D081D0B" }, "taskbotWebhook": { "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "url": "https://...", "ifSendChatTranscript": false, "additionalPostBody": "", "otherResponseToActionId": "4CB006E2-BA49-EB11-8100-00155D081D0B", "taskbotWebhookHeaders": [ { "id": "4DB006E2-BA49-EB11-8100-00155D081D0B", "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "key": "key", "value": "value", "order": 1 } ], "taskbotWebhookResponseToVariables": [ { "id": "D4C7158C-644A-EB11-8100-00155D081D0B", "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "variableName": "name", "responseKey": "text", "order": 1 } ], "taskbotWebhookResponseCodeToActions": [ { "id": "4DB006E2-BA49-EB11-8100-00155D081D0B", "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "responseCode": "", "nextActionId": "5AB006E2-BA49-EB11-8100-00155D081D0B", "order": 1 } ] } } ] } ] ``` ### Get a single Taskbot Version `GET bot/taskbotVersions/{id}` - #### Parameters: | Name | Type | in | Required | Description | | --- | --- | --- | --- | --- | | `include` | string | query | no | Allowed value is "taskbotAction". | - #### Response: [Taskbot Version](/docs/server-api-bot-taskbot-version#taskbot-version-json-format) - #### Example Sample Request: ``` curl https://api11.comm100.io/v4/bot/taskbotVersions/00000000-0000-0000-0000-000000000000 \ -X 'GET' \ -H 'Authorization: Bearer {access_token}' \ ``` Response: HTTP/1.1 200 OK ``` { "id": "00000000-0000-0000-0000-000000000000", "taskbotId": "00000000-0000-0000-0000-000000000000", "createdTime": "2021-04-07T05:59:17.887Z", "taskbotActions": [ { "taskbotVersionId": "7A6A35A3-814A-EB11-8100-00155D081D0B", "xPosition": 50, "yPosition": 50, "type": "taskbotStart", "id": "A762827E-0D4B-EB11-8100-00155D081D0B", "taskbotStart": { "taskbotActionId": "F8A7A50B-B049-EB11-8100-00155D081D0B", "nextActionId": "d2be5b63-24dc-4c14-9926-788e9af54760" }, "taskbotCollectComment": { "typingDelay": 1.0, "message": "text", "nextActionId": "D4C7158C-644A-EB11-8100-00155D081D0B", "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B" }, "taskbotCollectCompanyName": { "typingDelay": 1.0, "message": "text", "nextActionId": "D4C7158C-644A-EB11-8100-00155D081D0B", "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B" }, "taskbotCollectEmail": { "typingDelay": 1.0, "message": "text", "nextActionId": "D4C7158C-644A-EB11-8100-00155D081D0B", "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B" }, "taskbotSendEmail": { "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "subject": "subject", "content": "content", "to": "test@comm100.com", "cc": "test1@comm100.com", "nextActionId": "9F813BFF-E65A-EB11-8101-00155D081D0B" }, "taskbotBookMeeting": { "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "failedActionId": "b3d0be60-e7a6-47e2-82b9-b30b31806663", "successActionId": "bbec7c36-9c72-4789-8e07-8951c22eb945", "integrationCalendlyId": "c2c165b7-d5ce-40e5-a492-f586f514a062", "calendlyEventTypeUri": "https://..." }, "taskbotCollectLocation": { "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "typingDelay": 1.0, "message": "shareLocation", "buttonText": "button", "successActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "failedActionId": "D6C7158C-644A-EB11-8100-00155D081D0B" }, "taskbotCollectName": { "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "nextActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "message": "text", "typingDelay": 1.0 }, "taskbotCollectPhoneNumber": { "typingDelay": 1.0, "message": "text", "nextActionId": "D4C7158C-644A-EB11-8100-00155D081D0B", "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B" }, "taskbotCollectVariableData": { "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "nextActionId": "D4C7158C-644A-EB11-8100-00155D081D0B", "variableName": "name", "options": "option1", "message": "text", "typingDelay": 1.0, "type": "text" }, "taskbotGotoTaskbot": { "taskbotActionId": "4E8E8CE8-AD49-EB11-8100-00155D081D0B", "taskbotId": "4E8E8CE8-AD49-EB11-8100-00155D081D0B" }, "taskbotQuickReply": { "taskbotActionId": "D0948954-AE49-EB11-8100-00155D081D0B", "typingDelay": 1.0, "message": "link to baidu", "otherResponseToActionId": "4CB9B085-AC49-EB11-8100-00155D081D0B", "taskbotQuickReplyOptions": [ { "id": "EF948954-AE49-EB11-8100-00155D081D0B", "taskbotActionId": "D0948954-AE49-EB11-8100-00155D081D0B", "text": "Baidu", "order": 0, "nextActionId": "F5948954-AE49-EB11-8100-00155D081D0B" } ] }, "taskbotSendImage": { "taskbotActionId": "7AE8FDBF-504A-EB11-8100-00155D081D0B", "nextActionId": "8AE8FDBF-504A-EB11-8100-00155D081D0B", "typingDelay": 1.0, "message": "test", "image": "https://api11.comm100.io/v4/Bot/taskbotSendImages/7AE8FDBF-504A-EB11-8100-00155D081D0B/image", "imageUrl": "" }, "taskbotSendMessage": { "taskbotActionId": "F8A7A50B-B049-EB11-8100-00155D081D0B", "typingDelay": 1.0, "message": "hi", "nextActionId": "76ef3d7c-372f-4c34-8642-e51496accdfc", "taskbotSendMessageButtons": [ { "id": "a0831b44-a2d0-4bed-96c4-43f7eb69b095", "taskbotActionId": "E4099BB1-774A-EB11-8100-00155D081D0B", "buttonText": "test", "url": "https://...", "order": 1, "type": "link", "openIn": "currentWindow", "openStyle": "compact" } ] }, "taskbotSendVideo": { "taskbotActionId": "4CB9B085-AC49-EB11-8100-00155D081D0B", "nextActionId": "D0948954-AE49-EB11-8100-00155D081D0B", "typingDelay": 1.0, "message": "test", "videoUrl": "https://..." }, "taskbotSSOLoginButton": { "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "typingDelay": 1.0, "message": "To get personized service, you need to login first.", "loginButtonText": "login", "loginInActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "failedActionId": "D6C7158C-644A-EB11-8100-00155D081D0B" }, "taskbotTransferChat": { "taskbotActionId": "B0101911-4E4A-EB11-8100-00155D081D0B", "type": "transferToDepartment", "transferTo": "EF101911-4E4A-EB11-8100-00155D081D0B", "whenAgentOfflineToActionId": "5A101911-4E4A-EB11-8100-00155D081D0B" }, "taskbotWebhook": { "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "url": "https://...", "ifSendChatTranscript": false, "additionalPostBody": "", "otherResponseToActionId": "4CB006E2-BA49-EB11-8100-00155D081D0B", "taskbotWebhookHeaders": [ { "id": "4DB006E2-BA49-EB11-8100-00155D081D0B", "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "key": "key", "value": "value", "order": 1 } ], "taskbotWebhookResponseToVariables": [ { "id": "D4C7158C-644A-EB11-8100-00155D081D0B", "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "variableName": "name", "responseKey": "text", "order": 1 } ], "taskbotWebhookResponseCodeToActions": [ { "id": "4DB006E2-BA49-EB11-8100-00155D081D0B", "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "responseCode": "", "nextActionId": "5AB006E2-BA49-EB11-8100-00155D081D0B", "order": 1 } ] } } ] } ``` ### Create a new Taskbot Version `POST bot/taskbotVersions` - #### Parameters: | Name | Type | in | Required | Description | | --- | --- | --- | --- | --- | | `taskbotId` | guid | body | yes | Id of the taskbot. | | `createdTime` | datetime | body | no | Taskbot created time. | | `taskbotActions` | [taskbotActions[]](/docs/server-api-bot-taskbot-version#taskbot-action-json-format) | body | no | Reference to Taskbot Action. | - #### Response: [Taskbot Version](/docs/server-api-bot-taskbot-version#taskbot-version-json-format) - #### Example Sample Request: ``` curl https://api11.comm100.io/v4/bot/taskbotVersions \ -X 'POST' \ -H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ -D '{"taskbotId":"00000000-0000-0000-0000-000000000000","createdTime":"2021-04-07T05:59:17.887Z","taskbotActions":[{"xPosition":50,"yPosition":50,"type":"taskbotStart","taskbotStart":{"nextActionId":"d2be5b63-24dc-4c14-9926-788e9af54760"},"taskbotSendMessage":{"typingDelay":1.0,"message":"hi","nextActionId":"76ef3d7c-372f-4c34-8642-e51496accdfc","taskbotSendMessageButtons":[{"buttonText":"test","url":"https://...","order":1,"type":"link","openIn":"currentWindow","openStyle":"compact"}]},"taskbotSendImage":{"nextActionId":"8AE8FDBF-504A-EB11-8100-00155D081D0B","typingDelay":1.0,"message":"test","image":"","imageUrl":""},"taskbotSendVideo":{"nextActionId":"D0948954-AE49-EB11-8100-00155D081D0B","typingDelay":1.0,"message":"test","videoUrl":"https://..."},"taskbotSSOLoginButton":{"typingDelay":1.0,"message":"To get personized service, you need to login first.","loginButtonText":"login","loginInActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","failedActionId":"D6C7158C-644A-EB11-8100-00155D081D0B"},"taskbotCollectLocation":{"typingDelay":1.0,"message":"shareLocation","buttonText":"button","successActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","failedActionId":"D6C7158C-644A-EB11-8100-00155D081D0B"},"taskbotCollectName":{"nextActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","message":"text","typingDelay":1.0},"taskbotCollectEmail":{"typingDelay":1.0,"message":"text","nextActionId":"D4C7158C-644A-EB11-8100-00155D081D0B"},"taskbotCollectPhoneNumber":{"typingDelay":1.0,"message":"text","nextActionId":"D4C7158C-644A-EB11-8100-00155D081D0B"},"taskbotCollectCompanyName":{"typingDelay":1.0,"message":"text","nextActionId":"D4C7158C-644A-EB11-8100-00155D081D0B"},"taskbotCollectComment":{"typingDelay":1.0,"message":"text","nextActionId":"D4C7158C-644A-EB11-8100-00155D081D0B"},"taskbotCollectVariableData":{"nextActionId":"D4C7158C-644A-EB11-8100-00155D081D0B","variableName":"name","options":"option1","message":"text","typingDelay":1.0,"type":"text"},"taskbotWebhook":{"url":"https://...","ifSendChatTranscript":false,"additionalPostBody":"","otherResponseToActionId":"4CB006E2-BA49-EB11-8100-00155D081D0B","taskbotWebhookHeaders":[{"key":"key","value":"value","order":1}],"taskbotWebhookResponseToVariables":[{"variableName":"name","responseKey":"text","order":1}],"taskbotWebhookResponseCodeToActions":[{"responseCode":"","nextActionId":"5AB006E2-BA49-EB11-8100-00155D081D0B","order":1}]},"taskbotSendEmail":{"subject":"subject","content":"content","to":"test@comm100.com","cc":"test1@comm100.com","nextActionId":"9F813BFF-E65A-EB11-8101-00155D081D0B"},"taskbotBookMeeting":{"failedActionId":"b3d0be60-e7a6-47e2-82b9-b30b31806663","successActionId":"bbec7c36-9c72-4789-8e07-8951c22eb945","integrationCalendlyId":"c2c165b7-d5ce-40e5-a492-f586f514a062","calendlyEventTypeUri":"https://..."},"taskbotGotoTaskbot":{"taskbotId":"4E8E8CE8-AD49-EB11-8100-00155D081D0B"},"taskbotTransferChat":{"type":"transferToDepartment","transferTo":"EF101911-4E4A-EB11-8100-00155D081D0B","whenAgentOfflineToActionId":"5A101911-4E4A-EB11-8100-00155D081D0B"},"taskbotQuickReply":{"typingDelay":1.0,"message":"link to baidu","otherResponseToActionId":"4CB9B085-AC49-EB11-8100-00155D081D0B","taskbotQuickReplyOptions":[{"text":"Baidu","order":0,"nextActionId":"F5948954-AE49-EB11-8100-00155D081D0B"}]}}]}' ``` Response: HTTP/1.1 201 Created ``` { "id": "00000000-0000-0000-0000-000000000000", "taskbotId": "00000000-0000-0000-0000-000000000000", "createdTime": "2021-04-07T05:59:17.887Z", "taskbotActions": [ { "taskbotVersionId": "7A6A35A3-814A-EB11-8100-00155D081D0B", "xPosition": 50, "yPosition": 50, "type": "taskbotStart", "id": "A762827E-0D4B-EB11-8100-00155D081D0B", "taskbotStart": { "taskbotActionId": "F8A7A50B-B049-EB11-8100-00155D081D0B", "nextActionId": "d2be5b63-24dc-4c14-9926-788e9af54760" }, "taskbotCollectComment": { "typingDelay": 1.0, "message": "text", "nextActionId": "D4C7158C-644A-EB11-8100-00155D081D0B", "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B" }, "taskbotCollectCompanyName": { "typingDelay": 1.0, "message": "text", "nextActionId": "D4C7158C-644A-EB11-8100-00155D081D0B", "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B" }, "taskbotCollectEmail": { "typingDelay": 1.0, "message": "text", "nextActionId": "D4C7158C-644A-EB11-8100-00155D081D0B", "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B" }, "taskbotSendEmail": { "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "subject": "subject", "content": "content", "to": "test@comm100.com", "cc": "test1@comm100.com", "nextActionId": "9F813BFF-E65A-EB11-8101-00155D081D0B" }, "taskbotBookMeeting": { "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "failedActionId": "b3d0be60-e7a6-47e2-82b9-b30b31806663", "successActionId": "bbec7c36-9c72-4789-8e07-8951c22eb945", "integrationCalendlyId": "c2c165b7-d5ce-40e5-a492-f586f514a062", "calendlyEventTypeUri": "https://..." }, "taskbotCollectLocation": { "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "typingDelay": 1.0, "message": "shareLocation", "buttonText": "button", "successActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "failedActionId": "D6C7158C-644A-EB11-8100-00155D081D0B" }, "taskbotCollectName": { "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "nextActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "message": "text", "typingDelay": 1.0 }, "taskbotCollectPhoneNumber": { "typingDelay": 1.0, "message": "text", "nextActionId": "D4C7158C-644A-EB11-8100-00155D081D0B", "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B" }, "taskbotCollectVariableData": { "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "nextActionId": "D4C7158C-644A-EB11-8100-00155D081D0B", "variableName": "name", "options": "option1", "message": "text", "typingDelay": 1.0, "type": "text" }, "taskbotGotoTaskbot": { "taskbotActionId": "4E8E8CE8-AD49-EB11-8100-00155D081D0B", "taskbotId": "4E8E8CE8-AD49-EB11-8100-00155D081D0B" }, "taskbotQuickReply": { "taskbotActionId": "D0948954-AE49-EB11-8100-00155D081D0B", "typingDelay": 1.0, "message": "link to baidu", "otherResponseToActionId": "4CB9B085-AC49-EB11-8100-00155D081D0B", "taskbotQuickReplyOptions": [ { "id": "EF948954-AE49-EB11-8100-00155D081D0B", "taskbotActionId": "D0948954-AE49-EB11-8100-00155D081D0B", "text": "Baidu", "order": 0, "nextActionId": "F5948954-AE49-EB11-8100-00155D081D0B" } ] }, "taskbotSendImage": { "taskbotActionId": "7AE8FDBF-504A-EB11-8100-00155D081D0B", "nextActionId": "8AE8FDBF-504A-EB11-8100-00155D081D0B", "typingDelay": 1.0, "message": "test", "image": "https://api11.comm100.io/v4/Bot/taskbotSendImages/7AE8FDBF-504A-EB11-8100-00155D081D0B/image", "imageUrl": "" }, "taskbotSendMessage": { "taskbotActionId": "F8A7A50B-B049-EB11-8100-00155D081D0B", "typingDelay": 1.0, "message": "hi", "nextActionId": "76ef3d7c-372f-4c34-8642-e51496accdfc", "taskbotSendMessageButtons": [ { "id": "a0831b44-a2d0-4bed-96c4-43f7eb69b095", "taskbotActionId": "E4099BB1-774A-EB11-8100-00155D081D0B", "buttonText": "test", "url": "https://...", "order": 1, "type": "link", "openIn": "currentWindow", "openStyle": "compact" } ] }, "taskbotSendVideo": { "taskbotActionId": "4CB9B085-AC49-EB11-8100-00155D081D0B", "nextActionId": "D0948954-AE49-EB11-8100-00155D081D0B", "typingDelay": 1.0, "message": "test", "videoUrl": "https://..." }, "taskbotSSOLoginButton": { "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "typingDelay": 1.0, "message": "To get personized service, you need to login first.", "loginButtonText": "login", "loginInActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "failedActionId": "D6C7158C-644A-EB11-8100-00155D081D0B" }, "taskbotTransferChat": { "taskbotActionId": "B0101911-4E4A-EB11-8100-00155D081D0B", "type": "transferToDepartment", "transferTo": "EF101911-4E4A-EB11-8100-00155D081D0B", "whenAgentOfflineToActionId": "5A101911-4E4A-EB11-8100-00155D081D0B" }, "taskbotWebhook": { "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "url": "https://...", "ifSendChatTranscript": false, "additionalPostBody": "", "otherResponseToActionId": "4CB006E2-BA49-EB11-8100-00155D081D0B", "taskbotWebhookHeaders": [ { "id": "4DB006E2-BA49-EB11-8100-00155D081D0B", "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "key": "key", "value": "value", "order": 1 } ], "taskbotWebhookResponseToVariables": [ { "id": "D4C7158C-644A-EB11-8100-00155D081D0B", "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "variableName": "name", "responseKey": "text", "order": 1 } ], "taskbotWebhookResponseCodeToActions": [ { "id": "4DB006E2-BA49-EB11-8100-00155D081D0B", "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "responseCode": "", "nextActionId": "5AB006E2-BA49-EB11-8100-00155D081D0B", "order": 1 } ] } } ] } ``` ### Taskbot Action JSON Format Taskbot Action is represented as simple flat JSON objects with the following keys: | Name | Type | Description | | --- | --- | --- | | `taskbotVersionId` | guid | Id of the taskbot version. | | `xPosition` | integer | The action's xPosition(in pixel) in the diagram. | | `yPosition` | integer | The action's yPosition(in pixel) in the diagram. | | `type` | enum | Type of the taskbotAction.Allowed values are `taskbotStart`, `taskbotSendMessage`, `taskbotSendImage`, `taskbotSendVideo`, `taskbotSSOLoginButton`, `taskbotCollectLocation`, `taskbotCollectName`, `taskbotCollectEmail`, `taskbotCollectPhoneNumber`, `taskbotCollectCompanyName`, `taskbotCollectComment`, `taskbotCollectVariableData`, `taskbotWebhook`, `taskbotSendEmail`, `taskbotBookMeeting`, `taskbotGotoTaskbot`, `taskbotTransferChat`, `taskbotQuickReply`. | | `id` | guid | Id of the taskbot action. | | `taskbotStart` | [taskbotStart](/docs/server-api-bot-taskbot-version#taskbot-start-json-format) | Reference to Taskbot Start. | | `taskbotCollectComment` | [taskbotCollectComment](/docs/server-api-bot-taskbot-version#taskbot-collect-comment-json-format) | Reference to Taskbot Collect Comment. | | `taskbotCollectCompanyName` | [taskbotCollectCompanyName](/docs/server-api-bot-taskbot-version#taskbot-collect-company-name-json-format) | Reference to Taskbot Collect Company Name. | | `taskbotCollectEmail` | [taskbotCollectEmail](/docs/server-api-bot-taskbot-version#taskbot-collect-email-json-format) | Reference to Taskbot Collect Email. | | `taskbotSendEmail` | [taskbotSendEmail](/docs/server-api-bot-taskbot-version#taskbot-send-email-json-format) | Reference to Taskbot Send Email. | | `taskbotBookMeeting` | [taskbotBookMeeting](/docs/server-api-bot-taskbot-version#taskbot-book-meeting-json-format) | Reference to Taskbot Book Meeting. | | `taskbotCollectLocation` | [taskbotCollectLocation](/docs/server-api-bot-taskbot-version#taskbot-collect-location-json-format) | Reference to Taskbot Collect Location. | | `taskbotCollectName` | [taskbotCollectName](/docs/server-api-bot-taskbot-version#taskbot-collect-name-json-format) | Reference to Taskbot Collect Name. | | `taskbotCollectPhoneNumber` | [taskbotCollectPhoneNumber](/docs/server-api-bot-taskbot-version#taskbot-collect-phone-number-json-format) | Reference to Taskbot Collect Phone Number. | | `taskbotCollectVariableData` | [taskbotCollectVariableData](/docs/server-api-bot-taskbot-version#taskbot-collect-variable-data-json-format) | Reference to Taskbot Collect Variable Data. | | `taskbotGotoTaskbot` | [taskbotGotoTaskbot](/docs/server-api-bot-taskbot-version#taskbot-go-to-taskbot-json-format) | Reference to Taskbot Go To Taskbot. | | `taskbotQuickReply` | [taskbotQuickReply](/docs/server-api-bot-taskbot-version#taskbot-quick-reply-json-format) | Reference to Taskbot Quick Reply. | | `taskbotSendImage` | [taskbotSendImage](/docs/server-api-bot-taskbot-version#taskbot-send-image-json-format) | Reference to Taskbot Send Image. | | `taskbotSendMessage` | [taskbotSendMessage](/docs/server-api-bot-taskbot-version#taskbot-send-message-json-format) | Reference to Taskbot Send Message. | | `taskbotSendVideo` | [taskbotSendVideo](/docs/server-api-bot-taskbot-version#taskbot-send-video-json-format) | Reference to Taskbot Send Video. | | `taskbotSSOLoginButton` | [taskbotSSOLoginButton](/docs/server-api-bot-taskbot-version#taskbot-sso-login-button-json-format) | Reference to Taskbot SSO Login Button. | | `taskbotTransferChat` | [taskbotTransferChat](/docs/taskbottransferchat) | Reference to Taskbot Transfer Chat. | | `taskbotWebhook` | [taskbotWebhook](/docs/server-api-bot-taskbot-version#taskbot-webhook-json-format) | Reference to Taskbot Webhook. | ### Get the list of Taskbot Actions `GET bot/taskbotActions` - #### Parameters: | Name | Type | in | Required | Description | | --- | --- | --- | --- | --- | | `include` | string | query | no | Allowed values are "taskbotStart", "taskbotCollectComment", "taskbotCollectCompanyName", "taskbotCollectEmail", "taskbotCollectLocation", "taskbotCollectName", "taskbotCollectPhoneNumber", "taskbotCollectVariableData", "taskbotGotoTaskbot", "taskbotQuickReply", "taskbotSendImage", "taskbotSendMessage", "taskbotSendVideo", "taskbotSSOLoginButton", "taskbotWebhook", "taskbotSendEmail", "taskbotBookMeeting". | - #### Response: An array of [Taskbot Action](/docs/server-api-bot-taskbot-version#taskbot-action-json-format) - #### Example Sample Request: ``` curl https://api11.comm100.io/v4/bot/taskbotActions \ -X 'GET' \ -H 'Authorization: Bearer {access_token}' \ ``` Response: HTTP/1.1 200 OK ``` [ { "taskbotVersionId": "7A6A35A3-814A-EB11-8100-00155D081D0B", "xPosition": 50, "yPosition": 50, "type": "taskbotStart", "id": "A762827E-0D4B-EB11-8100-00155D081D0B", "taskbotStart": { "taskbotActionId": "F8A7A50B-B049-EB11-8100-00155D081D0B", "nextActionId": "d2be5b63-24dc-4c14-9926-788e9af54760" }, "taskbotCollectComment": { "typingDelay": 1.0, "message": "text", "nextActionId": "D4C7158C-644A-EB11-8100-00155D081D0B", "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B" }, "taskbotCollectCompanyName": { "typingDelay": 1.0, "message": "text", "nextActionId": "D4C7158C-644A-EB11-8100-00155D081D0B", "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B" }, "taskbotCollectEmail": { "typingDelay": 1.0, "message": "text", "nextActionId": "D4C7158C-644A-EB11-8100-00155D081D0B", "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B" }, "taskbotSendEmail": { "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "subject": "subject", "content": "content", "to": "test@comm100.com", "cc": "test1@comm100.com", "nextActionId": "9F813BFF-E65A-EB11-8101-00155D081D0B" }, "taskbotBookMeeting": { "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "failedActionId": "b3d0be60-e7a6-47e2-82b9-b30b31806663", "successActionId": "bbec7c36-9c72-4789-8e07-8951c22eb945", "integrationCalendlyId": "c2c165b7-d5ce-40e5-a492-f586f514a062", "calendlyEventTypeUri": "https://..." }, "taskbotCollectLocation": { "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "typingDelay": 1.0, "message": "shareLocation", "buttonText": "button", "successActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "failedActionId": "D6C7158C-644A-EB11-8100-00155D081D0B" }, "taskbotCollectName": { "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "nextActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "message": "text", "typingDelay": 1.0 }, "taskbotCollectPhoneNumber": { "typingDelay": 1.0, "message": "text", "nextActionId": "D4C7158C-644A-EB11-8100-00155D081D0B", "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B" }, "taskbotCollectVariableData": { "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "nextActionId": "D4C7158C-644A-EB11-8100-00155D081D0B", "variableName": "name", "options": "option1", "message": "text", "typingDelay": 1.0, "type": "text" }, "taskbotGotoTaskbot": { "taskbotActionId": "4E8E8CE8-AD49-EB11-8100-00155D081D0B", "taskbotId": "4E8E8CE8-AD49-EB11-8100-00155D081D0B" }, "taskbotQuickReply": { "taskbotActionId": "D0948954-AE49-EB11-8100-00155D081D0B", "typingDelay": 1.0, "message": "link to baidu", "otherResponseToActionId": "4CB9B085-AC49-EB11-8100-00155D081D0B", "taskbotQuickReplyOptions": [ { "id": "EF948954-AE49-EB11-8100-00155D081D0B", "taskbotActionId": "D0948954-AE49-EB11-8100-00155D081D0B", "text": "Baidu", "order": 0, "nextActionId": "F5948954-AE49-EB11-8100-00155D081D0B" } ] }, "taskbotSendImage": { "taskbotActionId": "7AE8FDBF-504A-EB11-8100-00155D081D0B", "nextActionId": "8AE8FDBF-504A-EB11-8100-00155D081D0B", "typingDelay": 1.0, "message": "test", "image": "https://api11.comm100.io/v4/Bot/taskbotSendImages/7AE8FDBF-504A-EB11-8100-00155D081D0B/image", "imageUrl": "" }, "taskbotSendMessage": { "taskbotActionId": "F8A7A50B-B049-EB11-8100-00155D081D0B", "typingDelay": 1.0, "message": "hi", "nextActionId": "76ef3d7c-372f-4c34-8642-e51496accdfc", "taskbotSendMessageButtons": [ { "id": "a0831b44-a2d0-4bed-96c4-43f7eb69b095", "taskbotActionId": "E4099BB1-774A-EB11-8100-00155D081D0B", "buttonText": "test", "url": "https://...", "order": 1, "type": "link", "openIn": "currentWindow", "openStyle": "compact" } ] }, "taskbotSendVideo": { "taskbotActionId": "4CB9B085-AC49-EB11-8100-00155D081D0B", "nextActionId": "D0948954-AE49-EB11-8100-00155D081D0B", "typingDelay": 1.0, "message": "test", "videoUrl": "https://..." }, "taskbotSSOLoginButton": { "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "typingDelay": 1.0, "message": "To get personized service, you need to login first.", "loginButtonText": "login", "loginInActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "failedActionId": "D6C7158C-644A-EB11-8100-00155D081D0B" }, "taskbotTransferChat": { "taskbotActionId": "B0101911-4E4A-EB11-8100-00155D081D0B", "type": "transferToDepartment", "transferTo": "EF101911-4E4A-EB11-8100-00155D081D0B", "whenAgentOfflineToActionId": "5A101911-4E4A-EB11-8100-00155D081D0B" }, "taskbotWebhook": { "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "url": "https://...", "ifSendChatTranscript": false, "additionalPostBody": "", "otherResponseToActionId": "4CB006E2-BA49-EB11-8100-00155D081D0B", "taskbotWebhookHeaders": [ { "id": "4DB006E2-BA49-EB11-8100-00155D081D0B", "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "key": "key", "value": "value", "order": 1 } ], "taskbotWebhookResponseToVariables": [ { "id": "D4C7158C-644A-EB11-8100-00155D081D0B", "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "variableName": "name", "responseKey": "text", "order": 1 } ], "taskbotWebhookResponseCodeToActions": [ { "id": "4DB006E2-BA49-EB11-8100-00155D081D0B", "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "responseCode": "", "nextActionId": "5AB006E2-BA49-EB11-8100-00155D081D0B", "order": 1 } ] } } ] ``` ### Get a single Taskbot Action `GET bot/taskbotActions/{id}` - #### Parameters: | Name | Type | in | Required | Description | | --- | --- | --- | --- | --- | | `include` | string | query | no | Allowed values are "taskbotStart", "taskbotCollectComment", "taskbotCollectCompanyName", "taskbotCollectEmail", "taskbotCollectLocation", "taskbotCollectName", "taskbotCollectPhoneNumber", "taskbotCollectVariableData", "taskbotGotoTaskbot", "taskbotQuickReply", "taskbotSendImage", "taskbotSendMessage", "taskbotSendVideo", "taskbotSSOLoginButton", "taskbotWebhook", "taskbotSendEmail", "taskbotBookMeeting". | - #### Response: [Taskbot Action](/docs/server-api-bot-taskbot-version#taskbot-action-json-format) - #### Example Sample Request: ``` curl https://api11.comm100.io/v4/bot/taskbotActions/A762827E-0D4B-EB11-8100-00155D081D0B \ -X 'GET' \ -H 'Authorization: Bearer {access_token}' \ ``` Response: HTTP/1.1 200 OK ``` { "taskbotVersionId": "7A6A35A3-814A-EB11-8100-00155D081D0B", "xPosition": 50, "yPosition": 50, "type": "taskbotStart", "id": "A762827E-0D4B-EB11-8100-00155D081D0B", "taskbotStart": { "taskbotActionId": "F8A7A50B-B049-EB11-8100-00155D081D0B", "nextActionId": "d2be5b63-24dc-4c14-9926-788e9af54760" }, "taskbotCollectComment": { "typingDelay": 1.0, "message": "text", "nextActionId": "D4C7158C-644A-EB11-8100-00155D081D0B", "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B" }, "taskbotCollectCompanyName": { "typingDelay": 1.0, "message": "text", "nextActionId": "D4C7158C-644A-EB11-8100-00155D081D0B", "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B" }, "taskbotCollectEmail": { "typingDelay": 1.0, "message": "text", "nextActionId": "D4C7158C-644A-EB11-8100-00155D081D0B", "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B" }, "taskbotSendEmail": { "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "subject": "subject", "content": "content", "to": "test@comm100.com", "cc": "test1@comm100.com", "nextActionId": "9F813BFF-E65A-EB11-8101-00155D081D0B" }, "taskbotBookMeeting": { "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "failedActionId": "b3d0be60-e7a6-47e2-82b9-b30b31806663", "successActionId": "bbec7c36-9c72-4789-8e07-8951c22eb945", "integrationCalendlyId": "c2c165b7-d5ce-40e5-a492-f586f514a062", "calendlyEventTypeUri": "https://..." }, "taskbotCollectLocation": { "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "typingDelay": 1.0, "message": "shareLocation", "buttonText": "button", "successActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "failedActionId": "D6C7158C-644A-EB11-8100-00155D081D0B" }, "taskbotCollectName": { "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "nextActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "message": "text", "typingDelay": 1.0 }, "taskbotCollectPhoneNumber": { "typingDelay": 1.0, "message": "text", "nextActionId": "D4C7158C-644A-EB11-8100-00155D081D0B", "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B" }, "taskbotCollectVariableData": { "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "nextActionId": "D4C7158C-644A-EB11-8100-00155D081D0B", "variableName": "name", "options": "option1", "message": "text", "typingDelay": 1.0, "type": "text" }, "taskbotGotoTaskbot": { "taskbotActionId": "4E8E8CE8-AD49-EB11-8100-00155D081D0B", "taskbotId": "4E8E8CE8-AD49-EB11-8100-00155D081D0B" }, "taskbotQuickReply": { "taskbotActionId": "D0948954-AE49-EB11-8100-00155D081D0B", "typingDelay": 1.0, "message": "link to baidu", "otherResponseToActionId": "4CB9B085-AC49-EB11-8100-00155D081D0B", "taskbotQuickReplyOptions": [ { "id": "EF948954-AE49-EB11-8100-00155D081D0B", "taskbotActionId": "D0948954-AE49-EB11-8100-00155D081D0B", "text": "Baidu", "order": 0, "nextActionId": "F5948954-AE49-EB11-8100-00155D081D0B" } ] }, "taskbotSendImage": { "taskbotActionId": "7AE8FDBF-504A-EB11-8100-00155D081D0B", "nextActionId": "8AE8FDBF-504A-EB11-8100-00155D081D0B", "typingDelay": 1.0, "message": "test", "image": "https://api11.comm100.io/v4/Bot/taskbotSendImages/7AE8FDBF-504A-EB11-8100-00155D081D0B/image", "imageUrl": "" }, "taskbotSendMessage": { "taskbotActionId": "F8A7A50B-B049-EB11-8100-00155D081D0B", "typingDelay": 1.0, "message": "hi", "nextActionId": "76ef3d7c-372f-4c34-8642-e51496accdfc", "taskbotSendMessageButtons": [ { "id": "a0831b44-a2d0-4bed-96c4-43f7eb69b095", "taskbotActionId": "E4099BB1-774A-EB11-8100-00155D081D0B", "buttonText": "test", "url": "https://...", "order": 1, "type": "link", "openIn": "currentWindow", "openStyle": "compact" } ] }, "taskbotSendVideo": { "taskbotActionId": "4CB9B085-AC49-EB11-8100-00155D081D0B", "nextActionId": "D0948954-AE49-EB11-8100-00155D081D0B", "typingDelay": 1.0, "message": "test", "videoUrl": "https://..." }, "taskbotSSOLoginButton": { "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "typingDelay": 1.0, "message": "To get personized service, you need to login first.", "loginButtonText": "login", "loginInActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "failedActionId": "D6C7158C-644A-EB11-8100-00155D081D0B" }, "taskbotTransferChat": { "taskbotActionId": "B0101911-4E4A-EB11-8100-00155D081D0B", "type": "transferToDepartment", "transferTo": "EF101911-4E4A-EB11-8100-00155D081D0B", "whenAgentOfflineToActionId": "5A101911-4E4A-EB11-8100-00155D081D0B" }, "taskbotWebhook": { "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "url": "https://...", "ifSendChatTranscript": false, "additionalPostBody": "", "otherResponseToActionId": "4CB006E2-BA49-EB11-8100-00155D081D0B", "taskbotWebhookHeaders": [ { "id": "4DB006E2-BA49-EB11-8100-00155D081D0B", "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "key": "key", "value": "value", "order": 1 } ], "taskbotWebhookResponseToVariables": [ { "id": "D4C7158C-644A-EB11-8100-00155D081D0B", "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "variableName": "name", "responseKey": "text", "order": 1 } ], "taskbotWebhookResponseCodeToActions": [ { "id": "4DB006E2-BA49-EB11-8100-00155D081D0B", "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "responseCode": "", "nextActionId": "5AB006E2-BA49-EB11-8100-00155D081D0B", "order": 1 } ] } } ``` ### Create a new Taskbot Action `POST bot/taskbotActions` - #### Parameters: | Name | Type | in | Required | Description | | --- | --- | --- | --- | --- | | `taskbotVersionId` | guid | body | yes | Id of the taskbot version. | | `xPosition` | integer | body | no | The action's xPosition(in pixel) in the diagram. | | `yPosition` | integer | body | no | The action's yPosition(in pixel) in the diagram. | | `type` | enum | body | yes | Type of the taskbotAction.Allowed values are `taskbotStart`, `taskbotSendMessage`, `taskbotSendImage`, `taskbotSendVideo`, `taskbotSSOLoginButton`, `taskbotCollectLocation`, `taskbotCollectName`, `taskbotCollectEmail`, `taskbotCollectPhoneNumber`, `taskbotCollectCompanyName`, `taskbotCollectComment`, `taskbotCollectVariableData`, `taskbotWebhook`, `taskbotSendEmail`, `taskbotBookMeeting`, `taskbotGotoTaskbot`, `taskbotTransferChat`, `taskbotQuickReply`. | | `taskbotStart` | [taskbotStart](/docs/server-api-bot-taskbot-version#taskbot-start-json-format) | body | no | Reference to Taskbot Start. | | `taskbotSendMessage` | [taskbotSendMessage](/docs/server-api-bot-taskbot-version#taskbot-send-message-json-format) | body | no | Reference to Taskbot Send Message. | | `taskbotSendImage` | [taskbotSendImage](/docs/server-api-bot-taskbot-version#taskbot-send-image-json-format) | body | no | Reference to Taskbot Send Image. | | `taskbotSendVideo` | [taskbotSendVideo](/docs/server-api-bot-taskbot-version#taskbot-send-video-json-format) | body | no | Reference to Taskbot Send Video. | | `taskbotSSOLoginButton` | [taskbotSSOLoginButton](/docs/server-api-bot-taskbot-version#taskbot-sso-login-button-json-format) | body | no | Reference to Taskbot SSO Login Button. | | `taskbotCollectLocation` | [taskbotCollectLocation](/docs/server-api-bot-taskbot-version#taskbot-collect-location-json-format) | body | no | Reference to Taskbot Collect Location. | | `taskbotCollectName` | [taskbotCollectName](/docs/server-api-bot-taskbot-version#taskbot-collect-name-json-format) | body | no | Reference to Taskbot Collect Name. | | `taskbotCollectEmail` | [taskbotCollectEmail](/docs/server-api-bot-taskbot-version#taskbot-collect-email-json-format) | body | no | Reference to Taskbot Collect Email. | | `taskbotCollectPhoneNumber` | [taskbotCollectPhoneNumber](/docs/server-api-bot-taskbot-version#taskbot-collect-phone-number-json-format) | body | no | Reference to Taskbot Collect Phone Number. | | `taskbotCollectCompanyName` | [taskbotCollectCompanyName](/docs/server-api-bot-taskbot-version#taskbot-collect-company-name-json-format) | body | no | Reference to Taskbot Collect Company Name. | | `taskbotCollectComment` | [taskbotCollectComment](/docs/server-api-bot-taskbot-version#taskbot-collect-comment-json-format) | body | no | Reference to Taskbot Collect Comment. | | `taskbotCollectVariableData` | [taskbotCollectVariableData](/docs/server-api-bot-taskbot-version#taskbot-collect-variable-data-json-format) | body | no | Reference to Taskbot Collect Variable Data. | | `taskbotWebhook` | [taskbotWebhook](/docs/server-api-bot-taskbot-version#taskbot-webhook-json-format) | body | no | Reference to Taskbot Webhook. | | `taskbotSendEmail` | [taskbotSendEmail](/docs/server-api-bot-taskbot-version#taskbot-send-email-json-format) | body | no | Reference to Taskbot Send Email. | | `taskbotBookMeeting` | [taskbotBookMeeting](/docs/server-api-bot-taskbot-version#taskbot-book-meeting-json-format) | body | no | Reference to Taskbot Book Meeting. | | `taskbotGotoTaskbot` | [taskbotGotoTaskbot](/docs/server-api-bot-taskbot-version#taskbot-go-to-taskbot-json-format) | body | no | Reference to Taskbot Go To Taskbot. | | `taskbotTransferChat` | [taskbotTransferChat](/docs/server-api-bot-taskbot-version#taskbot-transfer-chat-json-format) | body | no | Reference to Taskbot Transfer Chat. | | `taskbotQuickReply` | [taskbotQuickReply](/docs/server-api-bot-taskbot-version#taskbot-quick-reply-json-format) | body | no | Reference to Taskbot Quick Reply. | - #### Response: [Taskbot Action](/docs/server-api-bot-taskbot-version#taskbot-action-json-format) - #### Example Sample Request: ``` curl https://api11.comm100.io/v4/bot/taskbotActions \ -X 'POST' \ -H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ -D '{"taskbotVersionId":"7A6A35A3-814A-EB11-8100-00155D081D0B","xPosition":50,"yPosition":50,"type":"taskbotStart","taskbotStart":{"nextActionId":"d2be5b63-24dc-4c14-9926-788e9af54760"},"taskbotSendMessage":{"typingDelay":1.0,"message":"hi","nextActionId":"76ef3d7c-372f-4c34-8642-e51496accdfc","taskbotSendMessageButtons":[{"buttonText":"test","url":"https://...","order":1,"type":"link","openIn":"currentWindow","openStyle":"compact"}]},"taskbotSendImage":{"nextActionId":"8AE8FDBF-504A-EB11-8100-00155D081D0B","typingDelay":1.0,"message":"test","image":"","imageUrl":""},"taskbotSendVideo":{"nextActionId":"D0948954-AE49-EB11-8100-00155D081D0B","typingDelay":1.0,"message":"test","videoUrl":"https://..."},"taskbotSSOLoginButton":{"typingDelay":1.0,"message":"To get personized service, you need to login first.","loginButtonText":"login","loginInActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","failedActionId":"D6C7158C-644A-EB11-8100-00155D081D0B"},"taskbotCollectLocation":{"typingDelay":1.0,"message":"shareLocation","buttonText":"button","successActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","failedActionId":"D6C7158C-644A-EB11-8100-00155D081D0B"},"taskbotCollectName":{"nextActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","message":"text","typingDelay":1.0},"taskbotCollectEmail":{"typingDelay":1.0,"message":"text","nextActionId":"D4C7158C-644A-EB11-8100-00155D081D0B"},"taskbotCollectPhoneNumber":{"typingDelay":1.0,"message":"text","nextActionId":"D4C7158C-644A-EB11-8100-00155D081D0B"},"taskbotCollectCompanyName":{"typingDelay":1.0,"message":"text","nextActionId":"D4C7158C-644A-EB11-8100-00155D081D0B"},"taskbotCollectComment":{"typingDelay":1.0,"message":"text","nextActionId":"D4C7158C-644A-EB11-8100-00155D081D0B"},"taskbotCollectVariableData":{"nextActionId":"D4C7158C-644A-EB11-8100-00155D081D0B","variableName":"name","options":"option1","message":"text","typingDelay":1.0,"type":"text"},"taskbotWebhook":{"url":"https://...","ifSendChatTranscript":false,"additionalPostBody":"","otherResponseToActionId":"4CB006E2-BA49-EB11-8100-00155D081D0B","taskbotWebhookHeaders":[{"key":"key","value":"value","order":1}],"taskbotWebhookResponseToVariables":[{"variableName":"name","responseKey":"text","order":1}],"taskbotWebhookResponseCodeToActions":[{"responseCode":"","nextActionId":"5AB006E2-BA49-EB11-8100-00155D081D0B","order":1}]},"taskbotSendEmail":{"subject":"subject","content":"content","to":"test@comm100.com","cc":"test1@comm100.com","nextActionId":"9F813BFF-E65A-EB11-8101-00155D081D0B"},"taskbotBookMeeting":{"failedActionId":"b3d0be60-e7a6-47e2-82b9-b30b31806663","successActionId":"bbec7c36-9c72-4789-8e07-8951c22eb945","integrationCalendlyId":"c2c165b7-d5ce-40e5-a492-f586f514a062","calendlyEventTypeUri":"https://..."},"taskbotGotoTaskbot":{"taskbotId":"4E8E8CE8-AD49-EB11-8100-00155D081D0B"},"taskbotTransferChat":{"type":"transferToDepartment","transferTo":"EF101911-4E4A-EB11-8100-00155D081D0B","whenAgentOfflineToActionId":"5A101911-4E4A-EB11-8100-00155D081D0B"},"taskbotQuickReply":{"typingDelay":1.0,"message":"link to baidu","otherResponseToActionId":"4CB9B085-AC49-EB11-8100-00155D081D0B","taskbotQuickReplyOptions":[{"text":"Baidu","order":0,"nextActionId":"F5948954-AE49-EB11-8100-00155D081D0B"}]}}' ``` Response: HTTP/1.1 201 Created ``` { "taskbotVersionId": "7A6A35A3-814A-EB11-8100-00155D081D0B", "xPosition": 50, "yPosition": 50, "type": "taskbotStart", "id": "A762827E-0D4B-EB11-8100-00155D081D0B", "taskbotStart": { "taskbotActionId": "F8A7A50B-B049-EB11-8100-00155D081D0B", "nextActionId": "d2be5b63-24dc-4c14-9926-788e9af54760" }, "taskbotCollectComment": { "typingDelay": 1.0, "message": "text", "nextActionId": "D4C7158C-644A-EB11-8100-00155D081D0B", "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B" }, "taskbotCollectCompanyName": { "typingDelay": 1.0, "message": "text", "nextActionId": "D4C7158C-644A-EB11-8100-00155D081D0B", "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B" }, "taskbotCollectEmail": { "typingDelay": 1.0, "message": "text", "nextActionId": "D4C7158C-644A-EB11-8100-00155D081D0B", "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B" }, "taskbotSendEmail": { "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "subject": "subject", "content": "content", "to": "test@comm100.com", "cc": "test1@comm100.com", "nextActionId": "9F813BFF-E65A-EB11-8101-00155D081D0B" }, "taskbotBookMeeting": { "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "failedActionId": "b3d0be60-e7a6-47e2-82b9-b30b31806663", "successActionId": "bbec7c36-9c72-4789-8e07-8951c22eb945", "integrationCalendlyId": "c2c165b7-d5ce-40e5-a492-f586f514a062", "calendlyEventTypeUri": "https://..." }, "taskbotCollectLocation": { "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "typingDelay": 1.0, "message": "shareLocation", "buttonText": "button", "successActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "failedActionId": "D6C7158C-644A-EB11-8100-00155D081D0B" }, "taskbotCollectName": { "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "nextActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "message": "text", "typingDelay": 1.0 }, "taskbotCollectPhoneNumber": { "typingDelay": 1.0, "message": "text", "nextActionId": "D4C7158C-644A-EB11-8100-00155D081D0B", "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B" }, "taskbotCollectVariableData": { "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "nextActionId": "D4C7158C-644A-EB11-8100-00155D081D0B", "variableName": "name", "options": "option1", "message": "text", "typingDelay": 1.0, "type": "text" }, "taskbotGotoTaskbot": { "taskbotActionId": "4E8E8CE8-AD49-EB11-8100-00155D081D0B", "taskbotId": "4E8E8CE8-AD49-EB11-8100-00155D081D0B" }, "taskbotQuickReply": { "taskbotActionId": "D0948954-AE49-EB11-8100-00155D081D0B", "typingDelay": 1.0, "message": "link to baidu", "otherResponseToActionId": "4CB9B085-AC49-EB11-8100-00155D081D0B", "taskbotQuickReplyOptions": [ { "id": "EF948954-AE49-EB11-8100-00155D081D0B", "taskbotActionId": "D0948954-AE49-EB11-8100-00155D081D0B", "text": "Baidu", "order": 0, "nextActionId": "F5948954-AE49-EB11-8100-00155D081D0B" } ] }, "taskbotSendImage": { "taskbotActionId": "7AE8FDBF-504A-EB11-8100-00155D081D0B", "nextActionId": "8AE8FDBF-504A-EB11-8100-00155D081D0B", "typingDelay": 1.0, "message": "test", "image": "https://api11.comm100.io/v4/Bot/taskbotSendImages/7AE8FDBF-504A-EB11-8100-00155D081D0B/image", "imageUrl": "" }, "taskbotSendMessage": { "taskbotActionId": "F8A7A50B-B049-EB11-8100-00155D081D0B", "typingDelay": 1.0, "message": "hi", "nextActionId": "76ef3d7c-372f-4c34-8642-e51496accdfc", "taskbotSendMessageButtons": [ { "id": "a0831b44-a2d0-4bed-96c4-43f7eb69b095", "taskbotActionId": "E4099BB1-774A-EB11-8100-00155D081D0B", "buttonText": "test", "url": "https://...", "order": 1, "type": "link", "openIn": "currentWindow", "openStyle": "compact" } ] }, "taskbotSendVideo": { "taskbotActionId": "4CB9B085-AC49-EB11-8100-00155D081D0B", "nextActionId": "D0948954-AE49-EB11-8100-00155D081D0B", "typingDelay": 1.0, "message": "test", "videoUrl": "https://..." }, "taskbotSSOLoginButton": { "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "typingDelay": 1.0, "message": "To get personized service, you need to login first.", "loginButtonText": "login", "loginInActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "failedActionId": "D6C7158C-644A-EB11-8100-00155D081D0B" }, "taskbotTransferChat": { "taskbotActionId": "B0101911-4E4A-EB11-8100-00155D081D0B", "type": "transferToDepartment", "transferTo": "EF101911-4E4A-EB11-8100-00155D081D0B", "whenAgentOfflineToActionId": "5A101911-4E4A-EB11-8100-00155D081D0B" }, "taskbotWebhook": { "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "url": "https://...", "ifSendChatTranscript": false, "additionalPostBody": "", "otherResponseToActionId": "4CB006E2-BA49-EB11-8100-00155D081D0B", "taskbotWebhookHeaders": [ { "id": "4DB006E2-BA49-EB11-8100-00155D081D0B", "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "key": "key", "value": "value", "order": 1 } ], "taskbotWebhookResponseToVariables": [ { "id": "D4C7158C-644A-EB11-8100-00155D081D0B", "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "variableName": "name", "responseKey": "text", "order": 1 } ], "taskbotWebhookResponseCodeToActions": [ { "id": "4DB006E2-BA49-EB11-8100-00155D081D0B", "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "responseCode": "", "nextActionId": "5AB006E2-BA49-EB11-8100-00155D081D0B", "order": 1 } ] } } ``` ### Update the Taskbot Action `PUT bot/taskbotActions/{id}` - #### Parameters: | Name | Type | in | Required | Description | | --- | --- | --- | --- | --- | | `taskbotVersionId` | guid | body | yes | Id of the taskbot version. | | `xPosition` | integer | body | no | The action's xPosition(in pixel) in the diagram. | | `yPosition` | integer | body | no | The action's yPosition(in pixel) in the diagram. | | `type` | enum | body | yes | Type of the taskbotAction.Allowed values are `taskbotStart`, `taskbotSendMessage`, `taskbotSendImage`, `taskbotSendVideo`, `taskbotSSOLoginButton`, `taskbotCollectLocation`, `taskbotCollectName`, `taskbotCollectEmail`, `taskbotCollectPhoneNumber`, `taskbotCollectCompanyName`, `taskbotCollectComment`, `taskbotCollectVariableData`, `taskbotWebhook`, `taskbotSendEmail`, `taskbotBookMeeting`, `taskbotGotoTaskbot`, `taskbotTransferChat`, `taskbotQuickReply`. | | `taskbotStart` | [taskbotStart](/docs/server-api-bot-taskbot-version#taskbot-start-json-format) | body | no | Reference to Taskbot Start. | | `taskbotSendMessage` | [taskbotSendMessage](/docs/server-api-bot-taskbot-version#taskbot-send-message-json-format) | body | no | Reference to Taskbot Send Message. | | `taskbotSendImage` | [taskbotSendImage](/docs/server-api-bot-taskbot-version#taskbot-send-image-json-format) | body | no | Reference to Taskbot Send Image. | | `taskbotSendVideo` | [taskbotSendVideo](/docs/server-api-bot-taskbot-version#taskbot-send-video-json-format) | body | no | Reference to Taskbot Send Video. | | `taskbotSSOLoginButton` | [taskbotSSOLoginButton](/docs/server-api-bot-taskbot-version#taskbot-sso-login-button-json-format) | body | no | Reference to Taskbot SSO Login Button. | | `taskbotCollectLocation` | [taskbotCollectLocation](/docs/server-api-bot-taskbot-version#taskbot-collect-location-json-format) | body | no | Reference to Taskbot Collect Location. | | `taskbotCollectName` | [taskbotCollectName](/docs/server-api-bot-taskbot-version#taskbot-collect-name-json-format) | body | no | Reference to Taskbot Collect Name. | | `taskbotCollectEmail` | [taskbotCollectEmail](/docs/server-api-bot-taskbot-version#taskbot-collect-email-json-format) | body | no | Reference to Taskbot Collect Email. | | `taskbotCollectPhoneNumber` | [taskbotCollectPhoneNumber](/docs/server-api-bot-taskbot-version#taskbot-collect-phone-number-json-format) | body | no | Reference to Taskbot Collect Phone Number. | | `taskbotCollectCompanyName` | [taskbotCollectCompanyName](/docs/server-api-bot-taskbot-version#taskbot-collect-company-name-json-format) | body | no | Reference to Taskbot Collect Company Name. | | `taskbotCollectComment` | [taskbotCollectComment](/docs/server-api-bot-taskbot-version#taskbot-collect-comment-json-format) | body | no | Reference to Taskbot Collect Comment. | | `taskbotCollectVariableData` | [taskbotCollectVariableData](/docs/server-api-bot-taskbot-version#taskbot-collect-variable-data-json-format) | body | no | Reference to Taskbot Collect Variable Data. | | `taskbotWebhook` | [taskbotWebhook](/docs/server-api-bot-taskbot-version#taskbot-webhook-json-format) | body | no | Reference to Taskbot Webhook. | | `taskbotSendEmail` | [taskbotSendEmail](/docs/server-api-bot-taskbot-version#taskbot-send-email-json-format) | body | no | Reference to Taskbot Send Email. | | `taskbotBookMeeting` | [taskbotBookMeeting](/docs/server-api-bot-taskbot-version#taskbot-book-meeting-json-format) | body | no | Reference to Taskbot Book Meeting. | | `taskbotGotoTaskbot` | [taskbotGotoTaskbot](/docs/server-api-bot-taskbot-version#taskbot-go-to-taskbot-json-format) | body | no | Reference to Taskbot Go To Taskbot. | | `taskbotTransferChat` | [taskbotTransferChat](/docs/taskbottransferchat) | body | no | Reference to Taskbot Transfer Chat. | | `taskbotQuickReply` | [taskbotQuickReply](/docs/server-api-bot-taskbot-version#taskbot-quick-reply-json-format) | body | no | Reference to Taskbot Quick Reply. | - #### Response: [Taskbot Action](/docs/server-api-bot-taskbot-version#taskbot-action-json-format) - #### Example Sample Request: ``` curl https://api11.comm100.io/v4/bot/taskbotActions/A762827E-0D4B-EB11-8100-00155D081D0B \ -X 'PUT' \ -H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ -D '{"taskbotVersionId":"7A6A35A3-814A-EB11-8100-00155D081D0B","xPosition":50,"yPosition":50,"type":"taskbotStart","taskbotStart":{"nextActionId":"d2be5b63-24dc-4c14-9926-788e9af54760"},"taskbotSendMessage":{"typingDelay":1.0,"message":"hi","nextActionId":"76ef3d7c-372f-4c34-8642-e51496accdfc","taskbotSendMessageButtons":[{"buttonText":"test","url":"https://...","order":1,"type":"link","openIn":"currentWindow","openStyle":"compact"}]},"taskbotSendImage":{"nextActionId":"8AE8FDBF-504A-EB11-8100-00155D081D0B","typingDelay":1.0,"message":"test","image":"","imageUrl":""},"taskbotSendVideo":{"nextActionId":"D0948954-AE49-EB11-8100-00155D081D0B","typingDelay":1.0,"message":"test","videoUrl":"https://..."},"taskbotSSOLoginButton":{"typingDelay":1.0,"message":"To get personized service, you need to login first.","loginButtonText":"login","loginInActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","failedActionId":"D6C7158C-644A-EB11-8100-00155D081D0B"},"taskbotCollectLocation":{"typingDelay":1.0,"message":"shareLocation","buttonText":"button","successActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","failedActionId":"D6C7158C-644A-EB11-8100-00155D081D0B"},"taskbotCollectName":{"nextActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","message":"text","typingDelay":1.0},"taskbotCollectEmail":{"typingDelay":1.0,"message":"text","nextActionId":"D4C7158C-644A-EB11-8100-00155D081D0B"},"taskbotCollectPhoneNumber":{"typingDelay":1.0,"message":"text","nextActionId":"D4C7158C-644A-EB11-8100-00155D081D0B"},"taskbotCollectCompanyName":{"typingDelay":1.0,"message":"text","nextActionId":"D4C7158C-644A-EB11-8100-00155D081D0B"},"taskbotCollectComment":{"typingDelay":1.0,"message":"text","nextActionId":"D4C7158C-644A-EB11-8100-00155D081D0B"},"taskbotCollectVariableData":{"nextActionId":"D4C7158C-644A-EB11-8100-00155D081D0B","variableName":"name","options":"option1","message":"text","typingDelay":1.0,"type":"text"},"taskbotWebhook":{"url":"https://...","ifSendChatTranscript":false,"additionalPostBody":"","otherResponseToActionId":"4CB006E2-BA49-EB11-8100-00155D081D0B","taskbotWebhookHeaders":[{"key":"key","value":"value","order":1}],"taskbotWebhookResponseToVariables":[{"variableName":"name","responseKey":"text","order":1}],"taskbotWebhookResponseCodeToActions":[{"responseCode":"","nextActionId":"5AB006E2-BA49-EB11-8100-00155D081D0B","order":1}]},"taskbotSendEmail":{"subject":"subject","content":"content","to":"test@comm100.com","cc":"test1@comm100.com","nextActionId":"9F813BFF-E65A-EB11-8101-00155D081D0B"},"taskbotBookMeeting":{"failedActionId":"b3d0be60-e7a6-47e2-82b9-b30b31806663","successActionId":"bbec7c36-9c72-4789-8e07-8951c22eb945","integrationCalendlyId":"c2c165b7-d5ce-40e5-a492-f586f514a062","calendlyEventTypeUri":"https://..."},"taskbotGotoTaskbot":{"taskbotId":"4E8E8CE8-AD49-EB11-8100-00155D081D0B"},"taskbotTransferChat":{"type":"transferToDepartment","transferTo":"EF101911-4E4A-EB11-8100-00155D081D0B","whenAgentOfflineToActionId":"5A101911-4E4A-EB11-8100-00155D081D0B"},"taskbotQuickReply":{"typingDelay":1.0,"message":"link to baidu","otherResponseToActionId":"4CB9B085-AC49-EB11-8100-00155D081D0B","taskbotQuickReplyOptions":[{"text":"Baidu","order":0,"nextActionId":"F5948954-AE49-EB11-8100-00155D081D0B"}]}}' ``` Response: HTTP/1.1 200 OK ``` { "taskbotVersionId": "7A6A35A3-814A-EB11-8100-00155D081D0B", "xPosition": 50, "yPosition": 50, "type": "taskbotStart", "id": "A762827E-0D4B-EB11-8100-00155D081D0B", "taskbotStart": { "taskbotActionId": "F8A7A50B-B049-EB11-8100-00155D081D0B", "nextActionId": "d2be5b63-24dc-4c14-9926-788e9af54760" }, "taskbotCollectComment": { "typingDelay": 1.0, "message": "text", "nextActionId": "D4C7158C-644A-EB11-8100-00155D081D0B", "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B" }, "taskbotCollectCompanyName": { "typingDelay": 1.0, "message": "text", "nextActionId": "D4C7158C-644A-EB11-8100-00155D081D0B", "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B" }, "taskbotCollectEmail": { "typingDelay": 1.0, "message": "text", "nextActionId": "D4C7158C-644A-EB11-8100-00155D081D0B", "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B" }, "taskbotSendEmail": { "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "subject": "subject", "content": "content", "to": "test@comm100.com", "cc": "test1@comm100.com", "nextActionId": "9F813BFF-E65A-EB11-8101-00155D081D0B" }, "taskbotBookMeeting": { "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "failedActionId": "b3d0be60-e7a6-47e2-82b9-b30b31806663", "successActionId": "bbec7c36-9c72-4789-8e07-8951c22eb945", "integrationCalendlyId": "c2c165b7-d5ce-40e5-a492-f586f514a062", "calendlyEventTypeUri": "https://..." }, "taskbotCollectLocation": { "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "typingDelay": 1.0, "message": "shareLocation", "buttonText": "button", "successActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "failedActionId": "D6C7158C-644A-EB11-8100-00155D081D0B" }, "taskbotCollectName": { "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "nextActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "message": "text", "typingDelay": 1.0 }, "taskbotCollectPhoneNumber": { "typingDelay": 1.0, "message": "text", "nextActionId": "D4C7158C-644A-EB11-8100-00155D081D0B", "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B" }, "taskbotCollectVariableData": { "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "nextActionId": "D4C7158C-644A-EB11-8100-00155D081D0B", "variableName": "name", "options": "option1", "message": "text", "typingDelay": 1.0, "type": "text" }, "taskbotGotoTaskbot": { "taskbotActionId": "4E8E8CE8-AD49-EB11-8100-00155D081D0B", "taskbotId": "4E8E8CE8-AD49-EB11-8100-00155D081D0B" }, "taskbotQuickReply": { "taskbotActionId": "D0948954-AE49-EB11-8100-00155D081D0B", "typingDelay": 1.0, "message": "link to baidu", "otherResponseToActionId": "4CB9B085-AC49-EB11-8100-00155D081D0B", "taskbotQuickReplyOptions": [ { "id": "EF948954-AE49-EB11-8100-00155D081D0B", "taskbotActionId": "D0948954-AE49-EB11-8100-00155D081D0B", "text": "Baidu", "order": 0, "nextActionId": "F5948954-AE49-EB11-8100-00155D081D0B" } ] }, "taskbotSendImage": { "taskbotActionId": "7AE8FDBF-504A-EB11-8100-00155D081D0B", "nextActionId": "8AE8FDBF-504A-EB11-8100-00155D081D0B", "typingDelay": 1.0, "message": "test", "image": "https://api11.comm100.io/v4/Bot/taskbotSendImages/7AE8FDBF-504A-EB11-8100-00155D081D0B/image", "imageUrl": "" }, "taskbotSendMessage": { "taskbotActionId": "F8A7A50B-B049-EB11-8100-00155D081D0B", "typingDelay": 1.0, "message": "hi", "nextActionId": "76ef3d7c-372f-4c34-8642-e51496accdfc", "taskbotSendMessageButtons": [ { "id": "a0831b44-a2d0-4bed-96c4-43f7eb69b095", "taskbotActionId": "E4099BB1-774A-EB11-8100-00155D081D0B", "buttonText": "test", "url": "https://...", "order": 1, "type": "link", "openIn": "currentWindow", "openStyle": "compact" } ] }, "taskbotSendVideo": { "taskbotActionId": "4CB9B085-AC49-EB11-8100-00155D081D0B", "nextActionId": "D0948954-AE49-EB11-8100-00155D081D0B", "typingDelay": 1.0, "message": "test", "videoUrl": "https://..." }, "taskbotSSOLoginButton": { "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "typingDelay": 1.0, "message": "To get personized service, you need to login first.", "loginButtonText": "login", "loginInActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "failedActionId": "D6C7158C-644A-EB11-8100-00155D081D0B" }, "taskbotTransferChat": { "taskbotActionId": "B0101911-4E4A-EB11-8100-00155D081D0B", "type": "transferToDepartment", "transferTo": "EF101911-4E4A-EB11-8100-00155D081D0B", "whenAgentOfflineToActionId": "5A101911-4E4A-EB11-8100-00155D081D0B" }, "taskbotWebhook": { "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "url": "https://...", "ifSendChatTranscript": false, "additionalPostBody": "", "otherResponseToActionId": "4CB006E2-BA49-EB11-8100-00155D081D0B", "taskbotWebhookHeaders": [ { "id": "4DB006E2-BA49-EB11-8100-00155D081D0B", "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "key": "key", "value": "value", "order": 1 } ], "taskbotWebhookResponseToVariables": [ { "id": "D4C7158C-644A-EB11-8100-00155D081D0B", "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "variableName": "name", "responseKey": "text", "order": 1 } ], "taskbotWebhookResponseCodeToActions": [ { "id": "4DB006E2-BA49-EB11-8100-00155D081D0B", "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "responseCode": "", "nextActionId": "5AB006E2-BA49-EB11-8100-00155D081D0B", "order": 1 } ] } } ``` ### Remove the Taskbot Action `DELETE bot/taskbotActions/{id}` - #### Parameters: No Parameters - #### Response: No Content - #### Example Sample Request: ``` curl https://api11.comm100.io/v4/bot/taskbotActions/A762827E-0D4B-EB11-8100-00155D081D0B \ -X 'DELETE' \ -H 'Authorization: Bearer {access_token}' \ ``` Response: HTTP/1.1 204 No Content ### Taskbot Start JSON Format Taskbot Start is represented as simple flat JSON objects with the following keys: | Name | Type | Description | | --- | --- | --- | | `taskbotActionId` | guid | Id of the current taskbot action. | | `nextActionId` | guid | Id of the next taskbot action. | ### Get a single Taskbot Start `GET bot/taskbotActions/{id}/taskbotStart` - #### Parameters: No Parameters - #### Response: [Taskbot Start](/docs/server-api-bot-taskbot-version#taskbot-start-json-format) - #### Example Sample Request: ``` curl https://api11.comm100.io/v4/bot/taskbotActions/F8A7A50B-B049-EB11-8100-00155D081D0B/taskbotStart \ -X 'GET' \ -H 'Authorization: Bearer {access_token}' \ ``` Response: HTTP/1.1 200 OK ``` { "taskbotActionId": "F8A7A50B-B049-EB11-8100-00155D081D0B", "nextActionId": "d2be5b63-24dc-4c14-9926-788e9af54760" } ``` ### Update the Taskbot Start `PUT bot/taskbotActions/{id}/taskbotStart` - #### Parameters: | Name | Type | in | Required | Description | | --- | --- | --- | --- | --- | | `nextActionId` | guid | body | no | Id of the next taskbot action. | - #### Response: [Taskbot Start](/docs/server-api-bot-taskbot-version#taskbot-start-json-format) - #### Example Sample Request: ``` curl https://api11.comm100.io/v4/bot/taskbotActions/F8A7A50B-B049-EB11-8100-00155D081D0B/taskbotStart \ -X 'PUT' \ -H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ -D '{"nextActionId":"d2be5b63-24dc-4c14-9926-788e9af54760"}' ``` Response: HTTP/1.1 200 OK ``` { "taskbotActionId": "F8A7A50B-B049-EB11-8100-00155D081D0B", "nextActionId": "d2be5b63-24dc-4c14-9926-788e9af54760" } ``` ### Taskbot Collect Comment JSON Format Taskbot Collect Comment is represented as simple flat JSON objects with the following keys: | 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 | HTML Text. | | `nextActionId` | guid | Id of the next taskbot action. | | `taskbotActionId` | guid | Id of the current taskbot action. | ### Get a single Taskbot Collect Comment `GET bot/taskbotActions/{id}/taskbotCollectComment` - #### Parameters: No Parameters - #### Response: [Taskbot Collect Comment](/docs/server-api-bot-taskbot-version#taskbot-collect-comment-json-format) - #### Example Sample Request: ``` curl https://api11.comm100.io/v4/bot/taskbotActions/D6C7158C-644A-EB11-8100-00155D081D0B/taskbotCollectComment \ -X 'GET' \ -H 'Authorization: Bearer {access_token}' \ ``` Response: HTTP/1.1 200 OK ``` { "typingDelay": 1.0, "message": "text", "nextActionId": "D4C7158C-644A-EB11-8100-00155D081D0B", "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B" } ``` ### Update the Taskbot Collect Comment `PUT bot/taskbotActions/{id}/taskbotCollectComment` - #### Parameters: | Name | Type | in | Required | Description | | --- | --- | --- | --- | --- | | `typingDelay` | float | body | yes | TypingDelay is only available when channel is Live Chat. The typing delay in seconds before this message is shown in chat window. | | `message` | string | body | no | HTML Text. | | `nextActionId` | guid | body | no | Id of the next taskbot action. | - #### Response: [Taskbot Collect Comment](/docs/server-api-bot-taskbot-version#taskbot-collect-comment-json-format) - #### Example Sample Request: ``` curl https://api11.comm100.io/v4/bot/taskbotActions/D6C7158C-644A-EB11-8100-00155D081D0B/taskbotCollectComment \ -X 'PUT' \ -H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ -D '{"typingDelay":1.0,"message":"text","nextActionId":"D4C7158C-644A-EB11-8100-00155D081D0B"}' ``` Response: HTTP/1.1 200 OK ``` { "typingDelay": 1.0, "message": "text", "nextActionId": "D4C7158C-644A-EB11-8100-00155D081D0B", "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B" } ``` ### Taskbot Collect Company Name JSON Format Taskbot Collect Company Name is represented as simple flat JSON objects with the following keys: | 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 | HTML Text. | | `nextActionId` | guid | Id of the next taskbot action. | | `taskbotActionId` | guid | Id of the current taskbot action. | ### Get a single Taskbot Collect Company Name `GET bot/taskbotActions/{id}/taskbotCollectCompanyName` - #### Parameters: No Parameters - #### Response: [Taskbot Collect Company Name](/docs/server-api-bot-taskbot-version#taskbot-collect-company-name-json-format) - #### Example Sample Request: ``` curl https://api11.comm100.io/v4/bot/taskbotActions/D6C7158C-644A-EB11-8100-00155D081D0B/taskbotCollectCompanyName \ -X 'GET' \ -H 'Authorization: Bearer {access_token}' \ ``` Response: HTTP/1.1 200 OK ``` { "typingDelay": 1.0, "message": "text", "nextActionId": "D4C7158C-644A-EB11-8100-00155D081D0B", "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B" } ``` ### Update the Taskbot Collect Company Name `PUT bot/taskbotActions/{id}/taskbotCollectCompanyName` - #### Parameters: | Name | Type | in | Required | Description | | --- | --- | --- | --- | --- | | `typingDelay` | float | body | yes | TypingDelay is only available when channel is Live Chat. The typing delay in seconds before this message is shown in chat window. | | `message` | string | body | no | HTML Text. | | `nextActionId` | guid | body | no | Id of the next taskbot action. | - #### Response: [Taskbot Collect Company Name](/docs/server-api-bot-taskbot-version#taskbot-collect-company-name-json-format) - #### Example Sample Request: ``` curl https://api11.comm100.io/v4/bot/taskbotActions/D6C7158C-644A-EB11-8100-00155D081D0B/taskbotCollectCompanyName \ -X 'PUT' \ -H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ -D '{"typingDelay":1.0,"message":"text","nextActionId":"D4C7158C-644A-EB11-8100-00155D081D0B"}' ``` Response: HTTP/1.1 200 OK ``` { "typingDelay": 1.0, "message": "text", "nextActionId": "D4C7158C-644A-EB11-8100-00155D081D0B", "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B" } ``` ### Taskbot Collect Email JSON Format Taskbot Collect Email is represented as simple flat JSON objects with the following keys: | 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 | HTML Text. | | `nextActionId` | guid | Id of the next taskbot action. | | `taskbotActionId` | guid | Id of the current taskbot action. | ### Get a single Taskbot Collect Email `GET bot/taskbotActions/{id}/taskbotCollectEmail` - #### Parameters: No Parameters - #### Response: [Taskbot Collect Email](/docs/server-api-bot-taskbot-version#taskbot-collect-email-json-format) - #### Example Sample Request: ``` curl https://api11.comm100.io/v4/bot/taskbotActions/D6C7158C-644A-EB11-8100-00155D081D0B/taskbotCollectEmail \ -X 'GET' \ -H 'Authorization: Bearer {access_token}' \ ``` Response: HTTP/1.1 200 OK ``` { "typingDelay": 1.0, "message": "text", "nextActionId": "D4C7158C-644A-EB11-8100-00155D081D0B", "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B" } ``` ### Update the Taskbot Collect Email `PUT bot/taskbotActions/{id}/taskbotCollectEmail` - #### Parameters: | Name | Type | in | Required | Description | | --- | --- | --- | --- | --- | | `typingDelay` | float | body | yes | TypingDelay is only available when channel is Live Chat. The typing delay in seconds before this message is shown in chat window. | | `message` | string | body | no | HTML Text. | | `nextActionId` | guid | body | no | Id of the next taskbot action. | - #### Response: [Taskbot Collect Email](/docs/server-api-bot-taskbot-version#taskbot-collect-email-json-format) - #### Example Sample Request: ``` curl https://api11.comm100.io/v4/bot/taskbotActions/D6C7158C-644A-EB11-8100-00155D081D0B/taskbotCollectEmail \ -X 'PUT' \ -H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ -D '{"typingDelay":1.0,"message":"text","nextActionId":"D4C7158C-644A-EB11-8100-00155D081D0B"}' ``` Response: HTTP/1.1 200 OK ``` { "typingDelay": 1.0, "message": "text", "nextActionId": "D4C7158C-644A-EB11-8100-00155D081D0B", "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B" } ``` ### Taskbot Send Email JSON Format Taskbot Send Email is represented as simple flat JSON objects with the following keys: | Name | Type | Description | | --- | --- | --- | | `taskbotActionId` | guid | Id of the current taskbot action. | | `subject` | string | Email subject. | | `content` | string | Email content. | | `to` | string | The email to address. Use commas if there are multiple emails. | | `cc` | string | The email CCs. Use commas if there are multiple emails. | | `nextActionId` | guid | Id of the next taskbot action. | ### Get a single Taskbot Send Email `GET bot/taskbotActions/{id}/taskbotSendEmail` - #### Parameters: No Parameters - #### Response: [Taskbot Send Email](/docs/server-api-bot-taskbot-version#taskbot-send-email-json-format) - #### Example Sample Request: ``` curl https://api11.comm100.io/v4/bot/taskbotActions/D6C7158C-644A-EB11-8100-00155D081D0B/taskbotSendEmail \ -X 'GET' \ -H 'Authorization: Bearer {access_token}' \ ``` Response: HTTP/1.1 200 OK ``` { "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "subject": "subject", "content": "content", "to": "test@comm100.com", "cc": "test1@comm100.com", "nextActionId": "9F813BFF-E65A-EB11-8101-00155D081D0B" } ``` ### Update the Taskbot Send Email `PUT bot/taskbotActions/{id}/taskbotSendEmail` - #### Parameters: | Name | Type | in | Required | Description | | --- | --- | --- | --- | --- | | `subject` | string | body | no | Email subject. | | `content` | string | body | no | Email content. | | `to` | string | body | no | The email to address. Use commas if there are multiple emails. | | `cc` | string | body | no | The email CCs. Use commas if there are multiple emails. | | `nextActionId` | guid | body | no | Id of the next taskbot action. | - #### Response: [Taskbot Send Email](/docs/server-api-bot-taskbot-version#taskbot-send-email-json-format) - #### Example Sample Request: ``` curl https://api11.comm100.io/v4/bot/taskbotActions/D6C7158C-644A-EB11-8100-00155D081D0B/taskbotSendEmail \ -X 'PUT' \ -H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ -D '{"subject":"subject","content":"content","to":"test@comm100.com","cc":"test1@comm100.com","nextActionId":"9F813BFF-E65A-EB11-8101-00155D081D0B"}' ``` Response: HTTP/1.1 200 OK ``` { "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "subject": "subject", "content": "content", "to": "test@comm100.com", "cc": "test1@comm100.com", "nextActionId": "9F813BFF-E65A-EB11-8101-00155D081D0B" } ``` ### Taskbot Book Meeting JSON Format Taskbot Book Meeting is represented as simple flat JSON objects with the following keys: | Name | Type | Description | | --- | --- | --- | | `taskbotActionId` | guid | Id of the current taskbot action. | | `failedActionId` | guid | Id of the action to go to when book meeting failed. | | `successActionId` | guid | Id of the action to go to when book meeting success. | | `integrationCalendlyId` | guid | Id of the integration calendly. | | `calendlyEventTypeUri` | string | URL of the calendly event type. | ### Get a single Taskbot Book Meeting `GET bot/taskbotActions/{id}/taskbotBookMeeting` - #### Parameters: No Parameters - #### Response: [Taskbot Book Meeting](/docs/server-api-bot-taskbot-version#taskbot-book-meeting-json-format) - #### Example Sample Request: ``` curl https://api11.comm100.io/v4/bot/taskbotActions/D6C7158C-644A-EB11-8100-00155D081D0B/taskbotBookMeeting \ -X 'GET' \ -H 'Authorization: Bearer {access_token}' \ ``` Response: HTTP/1.1 200 OK ``` { "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "failedActionId": "b3d0be60-e7a6-47e2-82b9-b30b31806663", "successActionId": "bbec7c36-9c72-4789-8e07-8951c22eb945", "integrationCalendlyId": "c2c165b7-d5ce-40e5-a492-f586f514a062", "calendlyEventTypeUri": "https://..." } ``` ### Update the Taskbot Book Meeting `PUT bot/taskbotActions/{id}/taskbotBookMeeting` - #### Parameters: | Name | Type | in | Required | Description | | --- | --- | --- | --- | --- | | `failedActionId` | guid | body | no | Id of the action to go to when book meeting failed. | | `successActionId` | guid | body | no | Id of the action to go to when book meeting success. | | `integrationCalendlyId` | guid | body | yes | Id of the integration calendly. | | `calendlyEventTypeUri` | string | body | yes | URL of the calendly event type. | - #### Response: [Taskbot Book Meeting](/docs/server-api-bot-taskbot-version#taskbot-book-meeting-json-format) - #### Example Sample Request: ``` curl https://api11.comm100.io/v4/bot/taskbotActions/D6C7158C-644A-EB11-8100-00155D081D0B/taskbotBookMeeting \ -X 'PUT' \ -H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ -D '{"failedActionId":"b3d0be60-e7a6-47e2-82b9-b30b31806663","successActionId":"bbec7c36-9c72-4789-8e07-8951c22eb945","integrationCalendlyId":"c2c165b7-d5ce-40e5-a492-f586f514a062","calendlyEventTypeUri":"https://..."}' ``` Response: HTTP/1.1 200 OK ``` { "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "failedActionId": "b3d0be60-e7a6-47e2-82b9-b30b31806663", "successActionId": "bbec7c36-9c72-4789-8e07-8951c22eb945", "integrationCalendlyId": "c2c165b7-d5ce-40e5-a492-f586f514a062", "calendlyEventTypeUri": "https://..." } ``` ### Taskbot Collect Location JSON Format Taskbot Collect Location is represented as simple flat JSON objects with the following keys: | Name | Type | Description | | --- | --- | --- | | `taskbotActionId` | guid | Id of the current taskbot 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. | | `message` | string | The message will be shown above Share Location button. | | `buttonText` | string | The button text for Share Location button. | | `successActionId` | 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. | ### Get a single Taskbot Collect Location `GET bot/taskbotActions/{id}/taskbotCollectLocation` - #### Parameters: No Parameters - #### Response: [Taskbot Collect Location](/docs/server-api-bot-taskbot-version#taskbot-collect-location-json-format) - #### Example Sample Request: ``` curl https://api11.comm100.io/v4/bot/taskbotActions/D6C7158C-644A-EB11-8100-00155D081D0B/taskbotCollectLocation \ -X 'GET' \ -H 'Authorization: Bearer {access_token}' \ ``` Response: HTTP/1.1 200 OK ``` { "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "typingDelay": 1.0, "message": "shareLocation", "buttonText": "button", "successActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "failedActionId": "D6C7158C-644A-EB11-8100-00155D081D0B" } ``` ### Update the Taskbot Collect Location `PUT bot/taskbotActions/{id}/taskbotCollectLocation` - #### Parameters: | Name | Type | in | Required | Description | | --- | --- | --- | --- | --- | | `typingDelay` | float | body | yes | TypingDelay is only available when channel is Live Chat. The typing delay in seconds before this message is shown in chat window. | | `message` | string | body | no | The message will be shown above Share Location button. | | `buttonText` | string | body | no | The button text for Share Location button. | | `successActionId` | guid | body | no | Id of the action to go to when successfully get location info. | | `failedActionId` | guid | body | no | Id of the action to go to when can not get location info. | - #### Response: [Taskbot Collect Location](/docs/server-api-bot-taskbot-version#taskbot-collect-location-json-format) - #### Example Sample Request: ``` curl https://api11.comm100.io/v4/bot/taskbotActions/D6C7158C-644A-EB11-8100-00155D081D0B/taskbotCollectLocation \ -X 'PUT' \ -H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ -D '{"typingDelay":1.0,"message":"shareLocation","buttonText":"button","successActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","failedActionId":"D6C7158C-644A-EB11-8100-00155D081D0B"}' ``` Response: HTTP/1.1 200 OK ``` { "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "typingDelay": 1.0, "message": "shareLocation", "buttonText": "button", "successActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "failedActionId": "D6C7158C-644A-EB11-8100-00155D081D0B" } ``` ### Taskbot Collect Name JSON Format Taskbot Collect Name is represented as simple flat JSON objects with the following keys: | Name | Type | Description | | --- | --- | --- | | `taskbotActionId` | guid | Id of the current taskbot action. | | `nextActionId` | guid | Id of the next taskbot action. | | `message` | string | HTML 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. | ### Get a single Taskbot Collect Name `GET bot/taskbotActions/{id}/taskbotCollectName` - #### Parameters: No Parameters - #### Response: [Taskbot Collect Name](/docs/server-api-bot-taskbot-version#taskbot-collect-name-json-format) - #### Example Sample Request: ``` curl https://api11.comm100.io/v4/bot/taskbotActions/D6C7158C-644A-EB11-8100-00155D081D0B/taskbotCollectName \ -X 'GET' \ -H 'Authorization: Bearer {access_token}' \ ``` Response: HTTP/1.1 200 OK ``` { "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "nextActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "message": "text", "typingDelay": 1.0 } ``` ### Update the Taskbot Collect Name `PUT bot/taskbotActions/{id}/taskbotCollectName` - #### Parameters: | Name | Type | in | Required | Description | | --- | --- | --- | --- | --- | | `nextActionId` | guid | body | no | Id of the next taskbot action. | | `message` | string | body | no | HTML Text. | | `typingDelay` | float | body | yes | TypingDelay is only available when channel is Live Chat. The typing delay in seconds before this message is shown in chat window. | - #### Response: [Taskbot Collect Name](/docs/server-api-bot-taskbot-version#taskbot-collect-name-json-format) - #### Example Sample Request: ``` curl https://api11.comm100.io/v4/bot/taskbotActions/D6C7158C-644A-EB11-8100-00155D081D0B/taskbotCollectName \ -X 'PUT' \ -H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ -D '{"nextActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","message":"text","typingDelay":1.0}' ``` Response: HTTP/1.1 200 OK ``` { "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "nextActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "message": "text", "typingDelay": 1.0 } ``` ### Taskbot Collect Phone Number JSON Format Taskbot Collect Phone Number is represented as simple flat JSON objects with the following keys: | 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 | HTML Text. | | `nextActionId` | guid | Id of the next taskbot action. | | `taskbotActionId` | guid | Id of the current taskbot action. | ### Get a single Taskbot Collect Phone Number `GET bot/taskbotActions/{id}/taskbotCollectPhoneNumber` - #### Parameters: No Parameters - #### Response: [Taskbot Collect Phone Number](/docs/server-api-bot-taskbot-version#taskbot-collect-phone-number-json-format) - #### Example Sample Request: ``` curl https://api11.comm100.io/v4/bot/taskbotActions/D6C7158C-644A-EB11-8100-00155D081D0B/taskbotCollectPhoneNumber \ -X 'GET' \ -H 'Authorization: Bearer {access_token}' \ ``` Response: HTTP/1.1 200 OK ``` { "typingDelay": 1.0, "message": "text", "nextActionId": "D4C7158C-644A-EB11-8100-00155D081D0B", "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B" } ``` ### Update the Taskbot Collect Phone Number `PUT bot/taskbotActions/{id}/taskbotCollectPhoneNumber` - #### Parameters: | Name | Type | in | Required | Description | | --- | --- | --- | --- | --- | | `typingDelay` | float | body | yes | TypingDelay is only available when channel is Live Chat. The typing delay in seconds before this message is shown in chat window. | | `message` | string | body | no | HTML Text. | | `nextActionId` | guid | body | no | Id of the next taskbot action. | - #### Response: [Taskbot Collect Phone Number](/docs/server-api-bot-taskbot-version#taskbot-collect-phone-number-json-format) - #### Example Sample Request: ``` curl https://api11.comm100.io/v4/bot/taskbotActions/D6C7158C-644A-EB11-8100-00155D081D0B/taskbotCollectPhoneNumber \ -X 'PUT' \ -H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ -D '{"typingDelay":1.0,"message":"text","nextActionId":"D4C7158C-644A-EB11-8100-00155D081D0B"}' ``` Response: HTTP/1.1 200 OK ``` { "typingDelay": 1.0, "message": "text", "nextActionId": "D4C7158C-644A-EB11-8100-00155D081D0B", "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B" } ``` ### Taskbot Collect Variable Data JSON Format Taskbot Collect Variable Data is represented as simple flat JSON objects with the following keys: | Name | Type | Description | | --- | --- | --- | | `taskbotActionId` | guid | Id of the current taskbot action. | | `nextActionId` | guid | Id of the next taskbot action. | | `variableName` | string | Can only contain letters and numbers. | | `options` | string | Only available when type is singleSelect or multipleSelect. | | `message` | string | HTML 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. | | `type` | enum | Content of the custom page.Allowed values are `text`, `textArea`, `singleSelect`, `multipleSelect`, `email`, `password`, `date`, `time`. | ### Get a single Taskbot Collect Variable Data `GET bot/taskbotActions/{id}/taskbotCollectVariableData` - #### Parameters: No Parameters - #### Response: [Taskbot Collect Variable Data](/docs/server-api-bot-taskbot-version#taskbot-collect-variable-data-json-format) - #### Example Sample Request: ``` curl https://api11.comm100.io/v4/bot/taskbotActions/D6C7158C-644A-EB11-8100-00155D081D0B/taskbotCollectVariableData \ -X 'GET' \ -H 'Authorization: Bearer {access_token}' \ ``` Response: HTTP/1.1 200 OK ``` { "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "nextActionId": "D4C7158C-644A-EB11-8100-00155D081D0B", "variableName": "name", "options": "option1", "message": "text", "typingDelay": 1.0, "type": "text" } ``` ### Update the Taskbot Collect Variable Data `PUT bot/taskbotActions/{id}/taskbotCollectVariableData` - #### Parameters: | Name | Type | in | Required | Description | | --- | --- | --- | --- | --- | | `nextActionId` | guid | body | no | Id of the next taskbot action. | | `variableName` | string | body | no | Can only contain letters and numbers. | | `options` | string | body | no | Only available when type is singleSelect or multipleSelect. | | `message` | string | body | no | HTML Text. | | `typingDelay` | float | body | yes | TypingDelay is only available when channel is Live Chat. The typing delay in seconds before this message is shown in chat window. | | `type` | emun | body | no | Content of the custom page.Allowed values are `text`, `textArea`, `singleSelect`, `multipleSelect`, `email`, `password`, `date`, `time`. | - #### Response: [Taskbot Collect Variable Data](/docs/server-api-bot-taskbot-version#taskbot-collect-variable-data-json-format) - #### Example Sample Request: ``` curl https://api11.comm100.io/v4/bot/taskbotActions/D6C7158C-644A-EB11-8100-00155D081D0B/taskbotCollectVariableData \ -X 'PUT' \ -H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ -D '{"nextActionId":"D4C7158C-644A-EB11-8100-00155D081D0B","variableName":"name","options":"option1","message":"text","typingDelay":1.0,"type":"text"}' ``` Response: HTTP/1.1 200 OK ``` { "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "nextActionId": "D4C7158C-644A-EB11-8100-00155D081D0B", "variableName": "name", "options": "option1", "message": "text", "typingDelay": 1.0, "type": "text" } ``` ### Taskbot Go To Taskbot JSON Format Taskbot Go To Taskbot is represented as simple flat JSON objects with the following keys: | Name | Type | Description | | --- | --- | --- | | `taskbotActionId` | guid | Id of the taskbotaction. | | `taskbotId` | guid | Id of the taskbot. | ### Get a single Taskbot Go To Taskbot `GET bot/taskbotActions/{id}/taskbotGotoTaskbot` - #### Parameters: No Parameters - #### Response: [Taskbot Go To Taskbot](/docs/server-api-bot-taskbot-version#taskbot-go-to-taskbot-json-format) - #### Example Sample Request: ``` curl https://api11.comm100.io/v4/bot/taskbotActions/4E8E8CE8-AD49-EB11-8100-00155D081D0B/taskbotGotoTaskbot \ -X 'GET' \ -H 'Authorization: Bearer {access_token}' \ ``` Response: HTTP/1.1 200 OK ``` { "taskbotActionId": "4E8E8CE8-AD49-EB11-8100-00155D081D0B", "taskbotId": "4E8E8CE8-AD49-EB11-8100-00155D081D0B" } ``` ### Update the Taskbot Go To Taskbot `PUT bot/taskbotActions/{id}/taskbotGotoTaskbot` - #### Parameters: | Name | Type | in | Required | Description | | --- | --- | --- | --- | --- | | `taskbotId` | guid | body | yes | Id of the taskbot. | - #### Response: [Taskbot Go To Taskbot](/docs/server-api-bot-taskbot-version#taskbot-go-to-taskbot-json-format) - #### Example Sample Request: ``` curl https://api11.comm100.io/v4/bot/taskbotActions/4E8E8CE8-AD49-EB11-8100-00155D081D0B/taskbotGotoTaskbot \ -X 'PUT' \ -H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ -D '{"taskbotId":"4E8E8CE8-AD49-EB11-8100-00155D081D0B"}' ``` Response: HTTP/1.1 200 OK ``` { "taskbotActionId": "4E8E8CE8-AD49-EB11-8100-00155D081D0B", "taskbotId": "4E8E8CE8-AD49-EB11-8100-00155D081D0B" } ``` ### Taskbot Transfer Chat JSON Format Taskbot Transfer Chat is represented as simple flat JSON objects with the following keys: | Name | Type | Description | | --- | --- | --- | | `taskbotActionId` | guid | Id of the taskbot action. | | `type` | enum | Allowed values are `transferToAgent`, `transferRoutingRules`, `transferToDepartment`,`transferToChatbot`. | | `transferTo` | string | Transfer to agent, department or routing rules. | | `whenAgentOfflineToActionId` | guid | Id of when agent offline to action. | ### Taskbot Quick Reply JSON Format Taskbot Quick Reply is represented as simple flat JSON objects with the following keys: | Name | Type | Description | | --- | --- | --- | | `taskbotActionId` | guid | Id of the taskbot action. | | `typingDelay` | float | Add a delay (the bot shows a typing indicator) to bot responses to deliver multiple messages to the customer at a comfortable reading pace. | | `message` | string | Message of the quick reply. | | `otherResponseToActionId` | guid | Id of other responset to action. | | `taskbotQuickReplyOptions` | [taskbotQuickReplyOptions[]](/docs/server-api-bot-taskbot-version#taskbot-quick-reply-option-json-format) | Reference to Taskbot Quick Reply Option. | ### Get a single Taskbot Quick Reply `GET bot/taskbotActions/{id}/taskbotQuickReply` - #### Parameters: | Name | Type | in | Required | Description | | --- | --- | --- | --- | --- | | `include` | string | query | no | Allowed value is "taskbotQuickReplyOption". | - #### Response: [Taskbot Quick Reply](/docs/server-api-bot-taskbot-version#taskbot-quick-reply-json-format) - #### Example Sample Request: ``` curl https://api11.comm100.io/v4/bot/taskbotActions/D0948954-AE49-EB11-8100-00155D081D0B/taskbotQuickReply \ -X 'GET' \ -H 'Authorization: Bearer {access_token}' \ ``` Response: HTTP/1.1 200 OK ``` { "taskbotActionId": "D0948954-AE49-EB11-8100-00155D081D0B", "typingDelay": 1.0, "message": "link to baidu", "otherResponseToActionId": "4CB9B085-AC49-EB11-8100-00155D081D0B", "taskbotQuickReplyOptions": [ { "id": "EF948954-AE49-EB11-8100-00155D081D0B", "taskbotActionId": "D0948954-AE49-EB11-8100-00155D081D0B", "text": "Baidu", "order": 0, "nextActionId": "F5948954-AE49-EB11-8100-00155D081D0B" } ] } ``` ### Update the Taskbot Quick Reply `PUT bot/taskbotActions/{id}/taskbotQuickReply` - #### Parameters: | Name | Type | in | Required | Description | | --- | --- | --- | --- | --- | | `typingDelay` | float | body | yes | Add a delay (the bot shows a typing indicator) to bot responses to deliver multiple messages to the customer at a comfortable reading pace. | | `message` | string | body | no | Message of the quick reply. | | `otherResponseToActionId` | guid | body | no | Id of other responset to action. | | `taskbotQuickReplyOptions` | [taskbotQuickReplyOptions[]](/docs/server-api-bot-taskbot-version#taskbot-quick-reply-option-json-format) | body | no | Reference to Taskbot Quick Reply Option. | - #### Response: [Taskbot Quick Reply](/docs/server-api-bot-taskbot-version#taskbot-quick-reply-json-format) - #### Example Sample Request: ``` curl https://api11.comm100.io/v4/bot/taskbotActions/D0948954-AE49-EB11-8100-00155D081D0B/taskbotQuickReply \ -X 'PUT' \ -H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ -D '{"typingDelay":1.0,"message":"link to baidu","otherResponseToActionId":"4CB9B085-AC49-EB11-8100-00155D081D0B","taskbotQuickReplyOptions":[{"text":"Baidu","order":0,"nextActionId":"F5948954-AE49-EB11-8100-00155D081D0B"}]}' ``` Response: HTTP/1.1 200 OK ``` { "taskbotActionId": "D0948954-AE49-EB11-8100-00155D081D0B", "typingDelay": 1.0, "message": "link to baidu", "otherResponseToActionId": "4CB9B085-AC49-EB11-8100-00155D081D0B", "taskbotQuickReplyOptions": [ { "id": "EF948954-AE49-EB11-8100-00155D081D0B", "taskbotActionId": "D0948954-AE49-EB11-8100-00155D081D0B", "text": "Baidu", "order": 0, "nextActionId": "F5948954-AE49-EB11-8100-00155D081D0B" } ] } ``` ### Taskbot Quick Reply Option JSON Format Taskbot Quick Reply Option is represented as simple flat JSON objects with the following keys: | Name | Type | Description | | --- | --- | --- | | `id` | guid | Id of Quick Reply item. | | `taskbotActionId` | guid | Id of the taskbot action. | | `text` | string | Only available when Type is triggerAnIntent. | | `order` | integer | Must greater than or equal 0, ascending sort. | | `nextActionId` | guid | Id of the next action. | ### Get the list of Taskbot Quick Reply Options `GET bot/taskbotQuickReplyOptions` - #### Parameters: No Parameters - #### Response: An array of [Taskbot Quick Reply Option](/docs/server-api-bot-taskbot-version#taskbot-quick-reply-option-json-format) - #### Example Sample Request: ``` curl https://api11.comm100.io/v4/bot/taskbotQuickReplyOptions \ -X 'GET' \ -H 'Authorization: Bearer {access_token}' \ ``` Response: HTTP/1.1 200 OK ``` [ { "id": "EF948954-AE49-EB11-8100-00155D081D0B", "taskbotActionId": "D0948954-AE49-EB11-8100-00155D081D0B", "text": "Baidu", "order": 0, "nextActionId": "F5948954-AE49-EB11-8100-00155D081D0B" } ] ``` ### Get a single Taskbot Quick Reply Option `GET bot/taskbotQuickReplyOptions/{id}` - #### Parameters: No Parameters - #### Response: [Taskbot Quick Reply Option](/docs/server-api-bot-taskbot-version#taskbot-quick-reply-option-json-format) - #### Example Sample Request: ``` curl https://api11.comm100.io/v4/bot/taskbotQuickReplyOptions/EF948954-AE49-EB11-8100-00155D081D0B \ -X 'GET' \ -H 'Authorization: Bearer {access_token}' \ ``` Response: HTTP/1.1 200 OK ``` { "id": "EF948954-AE49-EB11-8100-00155D081D0B", "taskbotActionId": "D0948954-AE49-EB11-8100-00155D081D0B", "text": "Baidu", "order": 0, "nextActionId": "F5948954-AE49-EB11-8100-00155D081D0B" } ``` ### Create a new Taskbot Quick Reply Option `POST bot/taskbotQuickReplyOptions` - #### Parameters: | Name | Type | in | Required | Description | | --- | --- | --- | --- | --- | | `taskbotActionId` | guid | body | yes | Id of the taskbot action. | | `text` | string | body | no | Only available when Type is triggerAnIntent. | | `order` | integer | body | yes | Must greater than or equal 0, ascending sort. | | `nextActionId` | guid | body | no | Id of the next action. | - #### Response: [Taskbot Quick Reply Option](/docs/server-api-bot-taskbot-version#taskbot-quick-reply-option-json-format) - #### Example Sample Request: ``` curl https://api11.comm100.io/v4/bot/taskbotQuickReplyOptions \ -X 'POST' \ -H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ -D '{"taskbotActionId":"D0948954-AE49-EB11-8100-00155D081D0B","text":"Baidu","order":0,"nextActionId":"F5948954-AE49-EB11-8100-00155D081D0B"}' ``` Response: HTTP/1.1 201 Created ``` { "id": "EF948954-AE49-EB11-8100-00155D081D0B", "taskbotActionId": "D0948954-AE49-EB11-8100-00155D081D0B", "text": "Baidu", "order": 0, "nextActionId": "F5948954-AE49-EB11-8100-00155D081D0B" } ``` ### Update the Taskbot Quick Reply Option `PUT bot/taskbotQuickReplyOptions/{id}` - #### Parameters: | Name | Type | in | Required | Description | | --- | --- | --- | --- | --- | | `taskbotActionId` | guid | body | yes | Id of the taskbot action. | | `text` | string | body | no | Only available when Type is triggerAnIntent. | | `order` | integer | body | yes | Must greater than or equal 0, ascending sort. | | `nextActionId` | guid | body | no | Id of the next action. | - #### Response: [Taskbot Quick Reply Option](/docs/server-api-bot-taskbot-version#taskbot-quick-reply-option-json-format) - #### Example Sample Request: ``` curl https://api11.comm100.io/v4/bot/taskbotQuickReplyOptions/EF948954-AE49-EB11-8100-00155D081D0B \ -X 'PUT' \ -H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ -D '{"taskbotActionId":"D0948954-AE49-EB11-8100-00155D081D0B","text":"Baidu","order":0,"nextActionId":"F5948954-AE49-EB11-8100-00155D081D0B"}' ``` Response: HTTP/1.1 200 OK ``` { "id": "EF948954-AE49-EB11-8100-00155D081D0B", "taskbotActionId": "D0948954-AE49-EB11-8100-00155D081D0B", "text": "Baidu", "order": 0, "nextActionId": "F5948954-AE49-EB11-8100-00155D081D0B" } ``` ### Remove the Taskbot Quick Reply Option `DELETE bot/taskbotQuickReplyOptions/{id}` - #### Parameters: No Parameters - #### Response: No Content - #### Example Sample Request: ``` curl https://api11.comm100.io/v4/bot/taskbotQuickReplyOptions/EF948954-AE49-EB11-8100-00155D081D0B \ -X 'DELETE' \ -H 'Authorization: Bearer {access_token}' \ ``` Response: HTTP/1.1 204 No Content ### Taskbot Send Image JSON Format Taskbot Send Image is represented as simple flat JSON objects with the following keys: | Name | Type | Description | | --- | --- | --- | | `taskbotActionId` | guid | Id of the current taskbot action. | | `nextActionId` | guid | Id of the next taskbot 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. | | `message` | string | HTML text, can be blank. The message will be in the same bubble above image. | | `imageUrl` | string | | | `image` | string | | ### Get a single Taskbot Send Image `GET bot/taskbotActions/{id}/taskbotSendImage` - #### Parameters: No Parameters - #### Response: [Taskbot Send Image](/docs/server-api-bot-taskbot-version#taskbot-send-image-json-format) - #### Example Sample Request: ``` curl https://api11.comm100.io/v4/bot/taskbotActions/7AE8FDBF-504A-EB11-8100-00155D081D0B/taskbotSendImage \ -X 'GET' \ -H 'Authorization: Bearer {access_token}' \ ``` Response: HTTP/1.1 200 OK ``` { "taskbotActionId": "7AE8FDBF-504A-EB11-8100-00155D081D0B", "nextActionId": "8AE8FDBF-504A-EB11-8100-00155D081D0B", "typingDelay": 1.0, "message": "test", "image": "https://api11.comm100.io/v4/Bot/taskbotSendImages/7AE8FDBF-504A-EB11-8100-00155D081D0B/image", "imageUrl": "" } ``` ### Update the Taskbot Send Image `PUT bot/taskbotActions/{id}/taskbotSendImage` - #### Parameters: | Name | Type | in | Required | Description | | --- | --- | --- | --- | --- | | `nextActionId` | guid | body | no | Id of the next taskbot action. | | `typingDelay` | float | body | yes | TypingDelay is only available when channel is Live Chat. The typing delay in seconds before this message is shown in chat window. | | `message` | string | body | no | HTML text, can be blank. The message will be in the same bubble above image. | | `imageUrl` | string | body | no | | | `image` | string | body | no | | - #### Response: [Taskbot Send Image](/docs/server-api-bot-taskbot-version#taskbot-send-image-json-format) - #### Example Sample Request: ``` curl https://api11.comm100.io/v4/bot/taskbotActions/7AE8FDBF-504A-EB11-8100-00155D081D0B/taskbotSendImage \ -X 'PUT' \ -H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ -D '{"nextActionId":"8AE8FDBF-504A-EB11-8100-00155D081D0B","typingDelay":1.0,"message":"test","image":"","imageUrl":""}' ``` Response: HTTP/1.1 200 OK ``` { "taskbotActionId": "7AE8FDBF-504A-EB11-8100-00155D081D0B", "nextActionId": "8AE8FDBF-504A-EB11-8100-00155D081D0B", "typingDelay": 1.0, "message": "test", "image": "https://api11.comm100.io/v4/Bot/taskbotSendImages/7AE8FDBF-504A-EB11-8100-00155D081D0B/image", "imageUrl": "" } ``` ### Taskbot Send Message JSON Format Taskbot Send Message is represented as simple flat JSON objects with the following keys: | Name | Type | Description | | --- | --- | --- | | `taskbotActionId` | guid | Id of the current taskbot 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. | | `message` | string | A string text of the message. | | `nextActionId` | guid | Id of the next taskbot action. | | `taskbotSendMessageButtons` | [taskbotSendMessageButtons[]](/docs/server-api-bot-taskbot-version#taskbot-send-message-button-json-format) | Reference to Taskbot Send Message Button. | ### Get a single Taskbot Send Message `GET bot/taskbotActions/{id}/taskbotSendMessage` - #### Parameters: | Name | Type | in | Required | Description | | --- | --- | --- | --- | --- | | `include` | string | query | no | Allowed value is "taskbotSendMessageButton". | - #### Response: [Taskbot Send Message](/docs/server-api-bot-taskbot-version#taskbot-send-message-json-format) - #### Example Sample Request: ``` curl https://api11.comm100.io/v4/bot/taskbotActions/F8A7A50B-B049-EB11-8100-00155D081D0B/taskbotSendMessage \ -X 'GET' \ -H 'Authorization: Bearer {access_token}' \ ``` Response: HTTP/1.1 200 OK ``` { "taskbotActionId": "F8A7A50B-B049-EB11-8100-00155D081D0B", "typingDelay": 1.0, "message": "hi", "nextActionId": "76ef3d7c-372f-4c34-8642-e51496accdfc", "taskbotSendMessageButtons": [ { "id": "a0831b44-a2d0-4bed-96c4-43f7eb69b095", "taskbotActionId": "E4099BB1-774A-EB11-8100-00155D081D0B", "buttonText": "test", "url": "https://...", "order": 1, "type": "link", "openIn": "currentWindow", "openStyle": "compact" } ] } ``` ### Update the Taskbot Send Message `PUT bot/taskbotActions/{id}/taskbotSendMessage` - #### Parameters: | Name | Type | in | Required | Description | | --- | --- | --- | --- | --- | | `typingDelay` | float | body | yes | TypingDelay is only available when channel is Live Chat. The typing delay in seconds before this message is shown in chat window. | | `message` | string | body | no | A string text of the message. | | `nextActionId` | guid | body | no | Id of the next taskbot action. | | `taskbotSendMessageButtons` | [taskbotSendMessageButtons[]](/docs/server-api-bot-taskbot-version#taskbot-send-message-button-json-format) | body | no | Reference to Taskbot Send Message Button. | - #### Response: [Taskbot Send Message](/docs/server-api-bot-taskbot-version#taskbot-send-message-json-format) - #### Example Sample Request: ``` curl https://api11.comm100.io/v4/bot/taskbotActions/F8A7A50B-B049-EB11-8100-00155D081D0B/taskbotSendMessage \ -X 'PUT' \ -H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ -D '{"typingDelay":1.0,"message":"hi","nextActionId":"76ef3d7c-372f-4c34-8642-e51496accdfc","taskbotSendMessageButtons":[{"buttonText":"test","url":"https://...","order":1,"type":"link","openIn":"currentWindow","openStyle":"compact"}]}' ``` Response: HTTP/1.1 200 OK ``` { "taskbotActionId": "F8A7A50B-B049-EB11-8100-00155D081D0B", "typingDelay": 1.0, "message": "hi", "nextActionId": "76ef3d7c-372f-4c34-8642-e51496accdfc", "taskbotSendMessageButtons": [ { "id": "a0831b44-a2d0-4bed-96c4-43f7eb69b095", "taskbotActionId": "E4099BB1-774A-EB11-8100-00155D081D0B", "buttonText": "test", "url": "https://...", "order": 1, "type": "link", "openIn": "currentWindow", "openStyle": "compact" } ] } ``` ### Taskbot Send Message Button JSON Format Taskbot Send Message Button is represented as simple flat JSON objects with the following keys: | Name | Type | Description | | --- | --- | --- | | `id` | guid | Id of the taskbot send message button. | | `taskbotActionId` | guid | Id of the taskbot action. | | `buttonText` | string | Text displaied on the button. | | `url` | string | URL of the button, only available when type is Link or Webview. | | `order` | integer | Must be greater than or equal to 0, ascending order. | | `type` | enum | Allowed values are `link`, `webview`. | | `openIn` | enum | Allowed values are `sideWindow`, `newWindow`, `currentWindow`. | | `openStyle` | enum | Allowed values are `compact`, `tall`, `full`. | ### Get the list of Taskbot Send Message Buttons `GET bot/taskbotSendMessageButtons` - #### Parameters: No Parameters - #### Response: An array of [Taskbot Send Message Button](/docs/server-api-bot-taskbot-version#taskbot-send-message-button-json-format) - #### Example Sample Request: ``` curl https://api11.comm100.io/v4/bot/taskbotSendMessageButtons \ -X 'GET' \ -H 'Authorization: Bearer {access_token}' \ ``` Response: HTTP/1.1 200 OK ``` [ { "id": "a0831b44-a2d0-4bed-96c4-43f7eb69b095", "taskbotActionId": "E4099BB1-774A-EB11-8100-00155D081D0B", "buttonText": "test", "url": "https://...", "order": 1, "type": "link", "openIn": "currentWindow", "openStyle": "compact" } ] ``` ### Get a single Taskbot Send Message Button `GET bot/taskbotSendMessageButtons/{id}` - #### Parameters: No Parameters - #### Response: [Taskbot Send Message Button](/docs/server-api-bot-taskbot-version#taskbot-send-message-button-json-format) - #### Example Sample Request: ``` curl https://api11.comm100.io/v4/bot/taskbotSendMessageButtons/a0831b44-a2d0-4bed-96c4-43f7eb69b095 \ -X 'GET' \ -H 'Authorization: Bearer {access_token}' \ ``` Response: HTTP/1.1 200 OK ``` { "id": "a0831b44-a2d0-4bed-96c4-43f7eb69b095", "taskbotActionId": "E4099BB1-774A-EB11-8100-00155D081D0B", "buttonText": "test", "url": "https://...", "order": 1, "type": "link", "openIn": "currentWindow", "openStyle": "compact" } ``` ### Create a new Taskbot Send Message Button `POST bot/taskbotSendMessageButtons` - #### Parameters: | Name | Type | in | Required | Description | | --- | --- | --- | --- | --- | | `taskbotActionId` | guid | body | yes | Id of the taskbot action. | | `buttonText` | string | body | no | Text displaied on the button. | | `url` | string | body | no | URL of the button, only available when type is Link or Webview. | | `order` | integer | body | no | Must be greater than or equal to 0, ascending order. | | `type` | enum | body | no | Allowed values are `link`, `webview`. | | `openIn` | enum | body | no | Allowed values are `sideWindow`, `newWindow`, `currentWindow`. | | `openStyle` | enum | body | no | Allowed values are `compact`, `tall`, `full`. | - #### Response: [Taskbot Send Message Button](/docs/server-api-bot-taskbot-version#taskbot-send-message-button-json-format) - #### Example Sample Request: ``` curl https://api11.comm100.io/v4/bot/taskbotSendMessageButtons \ -X 'POST' \ -H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ -D '{"taskbotActionId":"E4099BB1-774A-EB11-8100-00155D081D0B","buttonText":"test","url":"https://...","order":1,"type":"link","openIn":"currentWindow","openStyle":"compact"}' ``` Response: HTTP/1.1 201 Created ``` { "id": "a0831b44-a2d0-4bed-96c4-43f7eb69b095", "taskbotActionId": "E4099BB1-774A-EB11-8100-00155D081D0B", "buttonText": "test", "url": "https://...", "order": 1, "type": "link", "openIn": "currentWindow", "openStyle": "compact" } ``` ### Update the Taskbot Send Message Button `PUT bot/taskbotSendMessageButtons/{id}` - #### Parameters: | Name | Type | in | Required | Description | | --- | --- | --- | --- | --- | | `taskbotActionId` | guid | body | yes | Id of the taskbot action. | | `buttonText` | string | body | no | Text displaied on the button. | | `url` | string | body | no | URL of the button, only available when type is Link or Webview. | | `order` | integer | body | no | Must be greater than or equal to 0, ascending order. | | `type` | enum | body | no | Allowed values are `link`, `webview`. | | `openIn` | enum | body | no | Allowed values are `sideWindow`, `newWindow`, "currentWindow". | | `openStyle` | enum | body | no | Allowed values are `compact`, `tall`, `full`. | - #### Response: [Taskbot Send Message Button](/docs/server-api-bot-taskbot-version#taskbot-send-message-button-json-format) - #### Example Sample Request: ``` curl https://api11.comm100.io/v4/bot/taskbotSendMessageButtons/a0831b44-a2d0-4bed-96c4-43f7eb69b095 \ -X 'PUT' \ -H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ -D '{"taskbotActionId":"E4099BB1-774A-EB11-8100-00155D081D0B","buttonText":"test","url":"https://...","order":1,"type":"link","openIn":"currentWindow","openStyle":"compact"}' ``` Response: HTTP/1.1 200 OK ``` { "id": "a0831b44-a2d0-4bed-96c4-43f7eb69b095", "taskbotActionId": "E4099BB1-774A-EB11-8100-00155D081D0B", "buttonText": "test", "url": "https://...", "order": 1, "type": "link", "openIn": "currentWindow", "openStyle": "compact" } ``` ### Remove the Taskbot Send Message Button `DELETE bot/taskbotSendMessageButtons/{id}` - #### Parameters: No Parameters - #### Response: No Content - #### Example Sample Request: ``` curl https://api11.comm100.io/v4/bot/taskbotSendMessageButtons/a0831b44-a2d0-4bed-96c4-43f7eb69b095 \ -X 'DELETE' \ -H 'Authorization: Bearer {access_token}' \ ``` Response: HTTP/1.1 204 No Content ### Taskbot Send Video JSON Format Taskbot Send Video is represented as simple flat JSON objects with the following keys: | Name | Type | Description | | --- | --- | --- | | `taskbotActionId` | guid | Id of the current taskbot action. | | `nextActionId` | guid | Id of the next taskbot 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. | | `message` | string | Can be blank. The message will be in the same bubble above video. | | `videoUrl` | string | URL of the video. | ### Get a single Taskbot Send Video `GET bot/taskbotActions/{id}/taskbotSendVideo` - #### Parameters: No Parameters - #### Response: [Taskbot Send Video](/docs/server-api-bot-taskbot-version#taskbot-send-video-json-format) - #### Example Sample Request: ``` curl https://api11.comm100.io/v4/bot/taskbotActions/4CB9B085-AC49-EB11-8100-00155D081D0B/taskbotSendVideo \ -X 'GET' \ ``` Response: HTTP/1.1 200 OK ``` { "taskbotActionId": "4CB9B085-AC49-EB11-8100-00155D081D0B", "nextActionId": "D0948954-AE49-EB11-8100-00155D081D0B", "typingDelay": 1.0, "message": "test", "videoUrl": "https://..." } ``` ### Update the Taskbot Send Video `PUT bot/taskbotActions/{id}/taskbotSendVideo` - #### Parameters: | Name | Type | in | Required | Description | | --- | --- | --- | --- | --- | | `nextActionId` | guid | body | no | Id of the next taskbot action. | | `typingDelay` | float | body | yes | TypingDelay is only available when channel is Live Chat. The typing delay in seconds before this message is shown in chat window. | | `message` | string | body | no | Can be blank. The message will be in the same bubble above video. | | `videoUrl` | string | body | no | URL of the video. | - #### Response: [Taskbot Send Video](/docs/server-api-bot-taskbot-version#taskbot-send-video-json-format) - #### Example Sample Request: ``` curl https://api11.comm100.io/v4/bot/taskbotActions/4CB9B085-AC49-EB11-8100-00155D081D0B/taskbotSendVideo \ -X 'PUT' \ -H 'Content-Type: application/json' \ -D '{"nextActionId":"D0948954-AE49-EB11-8100-00155D081D0B","typingDelay":1.0,"message":"test","videoUrl":"https://..."}' ``` Response: HTTP/1.1 200 OK ``` { "taskbotActionId": "4CB9B085-AC49-EB11-8100-00155D081D0B", "nextActionId": "D0948954-AE49-EB11-8100-00155D081D0B", "typingDelay": 1.0, "message": "test", "videoUrl": "https://..." } ``` ### Taskbot SSO Login Button JSON Format Taskbot SSO Login Button is represented as simple flat JSON objects with the following keys: | Name | Type | Description | | --- | --- | --- | | `taskbotActionId` | guid | Id of the taskbot 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. | | `message` | string | The message will be shown above Login button. | | `loginButtonText` | string | The button text for Login button. | | `loginInActionId` | guid | Id of the login in action. | | `failedActionId` | guid | Id of the failed action. | ### Get a single Taskbot SSO Login Button `GET bot/taskbotActions/{id}/taskbotSSOLoginButton` - #### Parameters: No Parameters - #### Response: [Taskbot SSO Login Button](/docs/server-api-bot-taskbot-version#taskbot-sso-login-button-json-format) - #### Example Sample Request: ``` curl https://api11.comm100.io/v4/bot/taskbotActions/D6C7158C-644A-EB11-8100-00155D081D0B/taskbotSSOLoginButton \ -X 'GET' \ -H 'Authorization: Bearer {access_token}' \ ``` Response: HTTP/1.1 200 OK ``` { "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "typingDelay": 1.0, "message": "To get personized service, you need to login first.", "loginButtonText": "login", "loginInActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "failedActionId": "D6C7158C-644A-EB11-8100-00155D081D0B" } ``` ### Update the Taskbot SSO Login Button `PUT bot/taskbotActions/{id}/taskbotSSOLoginButton` - #### Parameters: | Name | Type | in | Required | Description | | --- | --- | --- | --- | --- | | `typingDelay` | float | body | yes | TypingDelay is only available when channel is Live Chat. The typing delay in seconds before this message is shown in chat window. | | `message` | string | body | no | The message will be shown above Login button. | | `loginButtonText` | string | body | no | The button text for Login button. | | `loginInActionId` | guid | body | no | Id of the login in action. | | `failedActionId` | guid | body | no | Id of the failed action. | - #### Response: [Taskbot SSO Login Button](/docs/server-api-bot-taskbot-version#taskbot-sso-login-button-json-format) - #### Example Sample Request: ``` curl https://api11.comm100.io/v4/bot/taskbotActions/D6C7158C-644A-EB11-8100-00155D081D0B/taskbotSSOLoginButton \ -X 'PUT' \ -H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ -D '{"typingDelay":1.0,"message":"To get personized service, you need to login first.","loginButtonText":"login","loginInActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","failedActionId":"D6C7158C-644A-EB11-8100-00155D081D0B"}' ``` Response: HTTP/1.1 200 OK ``` { "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "typingDelay": 1.0, "message": "To get personized service, you need to login first.", "loginButtonText": "login", "loginInActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "failedActionId": "D6C7158C-644A-EB11-8100-00155D081D0B" } ``` ### Taskbot Webhook JSON Format Taskbot Webhook is represented as simple flat JSON objects with the following keys: | Name | Type | Description | | --- | --- | --- | | `taskbotActionId` | guid | Id of the taskbot action. | | `url` | string | URL of the webhook request. | | `ifSendChatTranscript` | bool | If send the chat transcript to 3rd party system. | | `additionalPostBody` | string | The additional post body of the request. | | `otherResponseToActionId` | guid | Id of the other response to action. | | `taskbotWebhookHeaders` | [taskbotWebhookHeaders[]](/docs/server-api-bot-taskbot-version#taskbot-webhook-header-json-format) | Reference to Taskbot Webhook Header. | | `taskbotWebhookResponseToVariables` | [taskbotWebhookResponseToVariables[]](/docs/server-api-bot-taskbot-version#taskbot-webhook-response-to-variable-json-format) | Reference to Taskbot Webhook Response To Variable. | | `taskbotWebhookResponseCodeToActions` | [taskbotWebhookResponseCodeToActions[]](/docs/server-api-bot-taskbot-version#taskbot-webhook-response-code-to-action-json-format) | Reference to Taskbot Webhook Response Code To Action. | ### Get a single Taskbot Webhook `GET bot/taskbotActions/{id}/taskbotWebhook` - #### Parameters: | Name | Type | in | Required | Description | | --- | --- | --- | --- | --- | | `include` | string | query | no | Allowed values are "taskbotWebhookHeader", "taskbotWebhookResponseToVariable", "taskbotWebhookResponseCodeToAction". | - #### Response: [Taskbot Webhook](/docs/server-api-bot-taskbot-version#taskbot-webhook-json-format) - #### Example Sample Request: ``` curl https://api11.comm100.io/v4/bot/taskbotActions/D6C7158C-644A-EB11-8100-00155D081D0B/taskbotWebhook \ -X 'GET' \ -H 'Authorization: Bearer {access_token}' \ ``` Response: HTTP/1.1 200 OK ``` { "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "url": "https://...", "ifSendChatTranscript": false, "additionalPostBody": "", "otherResponseToActionId": "4CB006E2-BA49-EB11-8100-00155D081D0B", "taskbotWebhookHeaders": [ { "id": "4DB006E2-BA49-EB11-8100-00155D081D0B", "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "key": "key", "value": "value", "order": 1 } ], "taskbotWebhookResponseToVariables": [ { "id": "D4C7158C-644A-EB11-8100-00155D081D0B", "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "variableName": "name", "responseKey": "text", "order": 1 } ], "taskbotWebhookResponseCodeToActions": [ { "id": "4DB006E2-BA49-EB11-8100-00155D081D0B", "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "responseCode": "", "nextActionId": "5AB006E2-BA49-EB11-8100-00155D081D0B", "order": 1 } ] } ``` ### Update the Taskbot Webhook `PUT bot/taskbotActions/{id}/taskbotWebhook` - #### Parameters: | Name | Type | in | Required | Description | | --- | --- | --- | --- | --- | | `url` | string | body | no | URL of the webhook request. | | `ifSendChatTranscript` | bool | body | no | If send the chat transcript to 3rd party system. | | `additionalPostBody` | string | body | no | The additional post body of the request. | | `otherResponseToActionId` | guid | body | no | Id of the other response to action. | | `taskbotWebhookHeaders` | [taskbotWebhookHeaders[]](/docs/server-api-bot-taskbot-version#taskbot-webhook-header-json-format) | body | no | Reference to Taskbot Webhook Header. | | `taskbotWebhookResponseToVariables` | [taskbotWebhookResponseToVariables[]](/docs/server-api-bot-taskbot-version#taskbot-webhook-response-to-variable-json-format) | body | no | Reference to Taskbot Webhook Response To Variable. | | `taskbotWebhookResponseCodeToActions` | [taskbotWebhookResponseCodeToActions[]](/docs/server-api-bot-taskbot-version#taskbot-webhook-response-code-to-action-json-format) | body | no | Reference to Taskbot Webhook Response Code To Action. | - #### Response: [Taskbot Webhook](/docs/server-api-bot-taskbot-version#taskbot-webhook-json-format) - #### Example Sample Request: ``` curl https://api11.comm100.io/v4/bot/taskbotActions/D6C7158C-644A-EB11-8100-00155D081D0B/taskbotWebhook \ -X 'PUT' \ -H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ -D '{"url":"https://...","ifSendChatTranscript":false,"additionalPostBody":"","otherResponseToActionId":"4CB006E2-BA49-EB11-8100-00155D081D0B","taskbotWebhookHeaders":[{"key":"key","value":"value","order":1}],"taskbotWebhookResponseToVariables":[{"variableName":"name","responseKey":"text","order":1}],"taskbotWebhookResponseCodeToActions":[{"responseCode":"","nextActionId":"5AB006E2-BA49-EB11-8100-00155D081D0B","order":1}]}' ``` Response: HTTP/1.1 200 OK ``` { "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "url": "https://...", "ifSendChatTranscript": false, "additionalPostBody": "", "otherResponseToActionId": "4CB006E2-BA49-EB11-8100-00155D081D0B", "taskbotWebhookHeaders": [ { "id": "4DB006E2-BA49-EB11-8100-00155D081D0B", "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "key": "key", "value": "value", "order": 1 } ], "taskbotWebhookResponseToVariables": [ { "id": "D4C7158C-644A-EB11-8100-00155D081D0B", "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "variableName": "name", "responseKey": "text", "order": 1 } ], "taskbotWebhookResponseCodeToActions": [ { "id": "4DB006E2-BA49-EB11-8100-00155D081D0B", "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "responseCode": "", "nextActionId": "5AB006E2-BA49-EB11-8100-00155D081D0B", "order": 1 } ] } ``` ### Taskbot Webhook Header JSON Format Taskbot Webhook Header is represented as simple flat JSON objects with the following keys: | Name | Type | Description | | --- | --- | --- | | `id` | guid | Id of the taskbot webhook header. | | `taskbotActionId` | guid | Id of the taskbot action. | | `key` | string | Key of the header. | | `value` | string | Value of the header. | | `order` | integer | Must be greater than or equal to 0, ascending order. | ### Get the list of Taskbot Webhook Headers `GET bot/taskbotWebhookHeaders` - #### Parameters: No Parameters - #### Response: An array of [Taskbot Webhook Header](/docs/server-api-bot-taskbot-version#taskbot-webhook-header-json-format) - #### Example Sample Request: ``` curl https://api11.comm100.io/v4/bot/taskbotWebhookHeaders \ -X 'GET' \ -H 'Authorization: Bearer {access_token}' \ ``` Response: HTTP/1.1 200 OK ``` [ { "id": "4DB006E2-BA49-EB11-8100-00155D081D0B", "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "key": "key", "value": "value", "order": 1 } ] ``` ### Get a single Taskbot Webhook Header `GET bot/taskbotWebhookHeaders/{id}` - #### Parameters: No Parameters - #### Response: [Taskbot Webhook Header](/docs/server-api-bot-taskbot-version#taskbot-webhook-header-json-format) - #### Example Sample Request: ``` curl https://api11.comm100.io/v4/bot/taskbotWebhookHeaders/4DB006E2-BA49-EB11-8100-00155D081D0B \ -X 'GET' \ -H 'Authorization: Bearer {access_token}' \ ``` Response: HTTP/1.1 200 OK ``` { "id": "4DB006E2-BA49-EB11-8100-00155D081D0B", "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "key": "key", "value": "value", "order": 1 } ``` ### Create a new Taskbot Webhook Header `POST bot/taskbotWebhookHeaders` - #### Parameters: | Name | Type | in | Required | Description | | --- | --- | --- | --- | --- | | `taskbotActionId` | guid | body | yes | Id of the taskbot action. | | `key` | string | body | no | Key of the header. | | `value` | string | body | no | Value of the header. | | `order` | integer | body | no | Must be greater than or equal to 0, ascending order. | - #### Response: [Taskbot Webhook Header](/docs/server-api-bot-taskbot-version#taskbot-webhook-header-json-format) - #### Example Sample Request: ``` curl https://api11.comm100.io/v4/bot/taskbotWebhookHeaders \ -X 'POST' \ -H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ -D '{"taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","key":"key","value":"value","order":1}' ``` Response: HTTP/1.1 201 Created ``` { "id": "4DB006E2-BA49-EB11-8100-00155D081D0B", "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "key": "key", "value": "value", "order": 1 } ``` ### Update the Taskbot Webhook Header `PUT bot/taskbotWebhookHeaders/{id}` - #### Parameters: | Name | Type | in | Required | Description | | --- | --- | --- | --- | --- | | `taskbotActionId` | guid | body | yes | Id of the taskbot action. | | `key` | string | body | no | Key of the header. | | `value` | string | body | no | Value of the header. | | `order` | integer | body | no | Must be greater than or equal to 0, ascending order. | - #### Response: [Taskbot Webhook Header](/docs/server-api-bot-taskbot-version#taskbot-webhook-header-json-format) - #### Example Sample Request: ``` curl https://api11.comm100.io/v4/bot/taskbotWebhookHeaders/4DB006E2-BA49-EB11-8100-00155D081D0B \ -X 'PUT' \ -H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ -D '{"taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","key":"key","value":"value","order":1}' ``` Response: HTTP/1.1 200 OK ``` { "id": "4DB006E2-BA49-EB11-8100-00155D081D0B", "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "key": "key", "value": "value", "order": 1 } ``` ### Remove the Taskbot Webhook Header `DELETE bot/taskbotWebhookHeaders/{id}` - #### Parameters: No Parameters - #### Response: No Content - #### Example Sample Request: ``` curl https://api11.comm100.io/v4/bot/taskbotWebhookHeaders/4DB006E2-BA49-EB11-8100-00155D081D0B \ -X 'DELETE' \ -H 'Authorization: Bearer {access_token}' \ ``` Response: HTTP/1.1 204 No Content ### Taskbot Webhook Response To Variable JSON Format Taskbot Webhook Response To Variable is represented as simple flat JSON objects with the following keys: | Name | Type | Description | | --- | --- | --- | | `id` | guid | Id of the item. | | `taskbotActionId` | guid | Id of current taskbotAction. | | `variableName` | string | Name of the variable. | | `responseKey` | string | Key of the response. | | `order` | integer | Must be greater than or equal to 0. | ### Get the list of Taskbot Webhook Response To Variables `GET bot/taskbotWebhookResponseToVariables` - #### Parameters: No Parameters - #### Response: An array of [Taskbot Webhook Response To Variable](/docs/server-api-bot-taskbot-version#taskbot-webhook-response-to-variable-json-format) - #### Example Sample Request: ``` curl https://api11.comm100.io/v4/bot/taskbotWebhookResponseToVariables \ -X 'GET' \ -H 'Authorization: Bearer {access_token}' \ ``` Response: HTTP/1.1 200 OK ``` [ { "id": "D4C7158C-644A-EB11-8100-00155D081D0B", "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "variableName": "name", "responseKey": "text", "order": 1 } ] ``` ### Get a single Taskbot Webhook Response To Variable `GET bot/taskbotWebhookResponseToVariables/{id}` - #### Parameters: No Parameters - #### Response: [Taskbot Webhook Response To Variable](/docs/server-api-bot-taskbot-version#taskbot-webhook-response-to-variable-json-format) - #### Example Sample Request: ``` curl https://api11.comm100.io/v4/bot/taskbotWebhookResponseToVariables/D4C7158C-644A-EB11-8100-00155D081D0B \ -X 'GET' \ -H 'Authorization: Bearer {access_token}' \ ``` Response: HTTP/1.1 200 OK ``` { "id": "D4C7158C-644A-EB11-8100-00155D081D0B", "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "variableName": "name", "responseKey": "text", "order": 1 } ``` ### Create a new Taskbot Webhook Response To Variable `POST bot/taskbotWebhookResponseToVariables` - #### Parameters: | Name | Type | in | Required | Description | | --- | --- | --- | --- | --- | | `taskbotActionId` | guid | body | yes | Id of current taskbotAction. | | `variableName` | string | body | no | Name of the variable. | | `responseKey` | string | body | no | Key of the response. | | `order` | integer | body | no | Must be greater than or equal to 0. | - #### Response: [Taskbot Webhook Response To Variable](/docs/server-api-bot-taskbot-version#taskbot-webhook-response-to-variable-json-format) - #### Example Sample Request: ``` curl https://api11.comm100.io/v4/bot/taskbotWebhookResponseToVariables \ -X 'POST' \ -H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ -D '{"taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","variableName":"name","responseKey":"text","order":1}' ``` Response: HTTP/1.1 201 Created ``` { "id": "D4C7158C-644A-EB11-8100-00155D081D0B", "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "variableName": "name", "responseKey": "text", "order": 1 } ``` ### Update the Taskbot Webhook Response To Variable `PUT bot/taskbotWebhookResponseToVariables/{id}` - #### Parameters: | Name | Type | in | Required | Description | | --- | --- | --- | --- | --- | | `taskbotActionId` | guid | body | yes | Id of current taskbotAction. | | `variableName` | string | body | no | Name of the variable. | | `responseKey` | string | body | no | Key of the response. | | `order` | integer | body | no | Must be greater than or equal to 0. | - #### Response: [Taskbot Webhook Response To Variable](/docs/server-api-bot-taskbot-version#taskbot-webhook-response-to-variable-json-format) - #### Example Sample Request: ``` curl https://api11.comm100.io/v4/bot/taskbotWebhookResponseToVariables/D4C7158C-644A-EB11-8100-00155D081D0B \ -X 'PUT' \ -H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ -D '{"taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","variableName":"name","responseKey":"text","order":1}' ``` Response: HTTP/1.1 200 OK ``` { "id": "D4C7158C-644A-EB11-8100-00155D081D0B", "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "variableName": "name", "responseKey": "text", "order": 1 } ``` ### Remove the Taskbot Webhook Response To Variable `DELETE bot/taskbotWebhookResponseToVariables/{id}` - #### Parameters: No Parameters - #### Response: No Content - #### Example Sample Request: ``` curl https://api11.comm100.io/v4/bot/taskbotWebhookResponseToVariables/D4C7158C-644A-EB11-8100-00155D081D0B \ -X 'DELETE' \ -H 'Authorization: Bearer {access_token}' \ ``` Response: HTTP/1.1 204 No Content ### Taskbot Webhook Response Code To Action JSON Format Taskbot Webhook Response Code To Action is represented as simple flat JSON objects with the following keys: | Name | Type | Description | | --- | --- | --- | | `id` | guid | Id of the item. | | `taskbotActionId` | guid | Id of the current taskbot action. | | `responseCode` | string | Code of the response. | | `nextActionId` | guid | Id of the next taskbot action. | | `order` | integer | Must be greater than or equal to 0. | ### Get the list of Taskbot Webhook Response Code To Actions `GET bot/taskbotWebhookResponseCodeToActions` - #### Parameters: No Parameters - #### Response: An array of [Taskbot Webhook Response Code To Action](/docs/server-api-bot-taskbot-version#taskbot-webhook-response-code-to-action-json-format) - #### Example Sample Request: ``` curl https://api11.comm100.io/v4/bot/taskbotWebhookResponseCodeToActions \ -X 'GET' \ -H 'Authorization: Bearer {access_token}' \ ``` Response: HTTP/1.1 200 OK ``` [ { "id": "4DB006E2-BA49-EB11-8100-00155D081D0B", "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "responseCode": "", "nextActionId": "5AB006E2-BA49-EB11-8100-00155D081D0B", "order": 1 } ] ``` ### Get a single Taskbot Webhook Response Code To Action `GET bot/taskbotWebhookResponseCodeToActions/{id}` - #### Parameters: No Parameters - #### Response: [Taskbot Webhook Response Code To Action](/docs/server-api-bot-taskbot-version#taskbot-webhook-response-code-to-action-json-format) - #### Example Sample Request: ``` curl https://api11.comm100.io/v4/bot/taskbotWebhookResponseCodeToActions/4DB006E2-BA49-EB11-8100-00155D081D0B \ -X 'GET' \ -H 'Authorization: Bearer {access_token}' \ ``` Response: HTTP/1.1 200 OK ``` { "id": "4DB006E2-BA49-EB11-8100-00155D081D0B", "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "responseCode": "", "nextActionId": "5AB006E2-BA49-EB11-8100-00155D081D0B", "order": 1 } ``` ### Create a new Taskbot Webhook Response Code To Action `POST bot/taskbotWebhookResponseCodeToActions` - #### Parameters: | Name | Type | in | Required | Description | | --- | --- | --- | --- | --- | | `taskbotActionId` | guid | body | yes | Id of the current taskbot action. | | `responseCode` | string | body | no | Code of the response. | | `nextActionId` | guid | body | no | Id of the next taskbot action. | | `order` | integer | body | no | Must be greater than or equal to 0. | - #### Response: [Taskbot Webhook Response Code To Action](/docs/server-api-bot-taskbot-version#taskbot-webhook-response-code-to-action-json-format) - #### Example Sample Request: ``` curl https://api11.comm100.io/v4/bot/taskbotWebhookResponseCodeToActions \ -X 'POST' \ -H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ -D '{"taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","responseCode":"","nextActionId":"5AB006E2-BA49-EB11-8100-00155D081D0B","order":1}' ``` Response: HTTP/1.1 201 Created ``` { "id": "4DB006E2-BA49-EB11-8100-00155D081D0B", "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "responseCode": "", "nextActionId": "5AB006E2-BA49-EB11-8100-00155D081D0B", "order": 1 } ``` ### Update the Taskbot Webhook Response Code To Action `PUT bot/taskbotWebhookResponseCodeToActions/{id}` - #### Parameters: | Name | Type | in | Required | Description | | --- | --- | --- | --- | --- | | `taskbotActionId` | guid | body | yes | Id of the current taskbot action. | | `responseCode` | string | body | no | Code of the response. | | `nextActionId` | guid | body | no | Id of the next taskbot action. | | `order` | integer | body | no | Must be greater than or equal to 0. | - #### Response: [Taskbot Webhook Response Code To Action](/docs/server-api-bot-taskbot-version#taskbot-webhook-response-code-to-action-json-format) - #### Example Sample Request: ``` curl https://api11.comm100.io/v4/bot/taskbotWebhookResponseCodeToActions/4DB006E2-BA49-EB11-8100-00155D081D0B \ -X 'PUT' \ -H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ -D '{"taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","responseCode":"","nextActionId":"5AB006E2-BA49-EB11-8100-00155D081D0B","order":1}' ``` Response: HTTP/1.1 200 OK ``` { "id": "4DB006E2-BA49-EB11-8100-00155D081D0B", "taskbotActionId": "D6C7158C-644A-EB11-8100-00155D081D0B", "responseCode": "", "nextActionId": "5AB006E2-BA49-EB11-8100-00155D081D0B", "order": 1 } ``` ### Remove the Taskbot Webhook Response Code To Action `DELETE bot/taskbotWebhookResponseCodeToActions/{id}` - #### Parameters: No Parameters - #### Response: No Content - #### Example Sample Request: ``` curl https://api11.comm100.io/v4/bot/taskbotWebhookResponseCodeToActions/4DB006E2-BA49-EB11-8100-00155D081D0B \ -X 'DELETE' \ -H 'Authorization: Bearer {access_token}' \ ``` Response: HTTP/1.1 204 No Content © 2021 | [Comm100](https://www.comm100.com)