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[] | Reference to Taskbot Action. |
GET bot/taskbotVersions
Name | Type | In | Required | Description |
---|---|---|---|---|
taskbotId |
guid | query | no | Id of the taskbot. |
include |
string | query | no | Allowed value is "taskbotAction". |
An array of Taskbot Version
Sample Request:
Response:
HTTP/1.1 200 OK
GET bot/taskbotVersions/{id}
Name | Type | In | Required | Description |
---|---|---|---|---|
include |
string | query | no | Allowed value is "taskbotAction". |
Sample Request:
Response:
HTTP/1.1 200 OK
POST bot/taskbotVersions
Name | Type | In | Required | Description |
---|---|---|---|---|
taskbotId |
guid | body | yes | Id of the taskbot. |
createdTime |
datetime | body | no | Taskbot created time. |
taskbotActions |
taskbotActions[] | body | no | Reference to Taskbot Action. |
Sample Request:
Response:
HTTP/1.1 201 Created
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 |
string | 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 | Reference to Taskbot Start. |
taskbotCollectComment |
taskbotCollectComment | Reference to Taskbot Collect Comment. |
taskbotCollectCompanyName |
taskbotCollectCompanyName | Reference to Taskbot Collect Company Name. |
taskbotCollectEmail |
taskbotCollectEmail | Reference to Taskbot Collect Email. |
taskbotSendEmail |
taskbotSendEmail | Reference to Taskbot Send Email. |
taskbotBookMeeting |
taskbotBookMeeting | Reference to Taskbot Book Meeting. |
taskbotCollectLocation |
taskbotCollectLocation | Reference to Taskbot Collect Location. |
taskbotCollectName |
taskbotCollectName | Reference to Taskbot Collect Name. |
taskbotCollectPhoneNumber |
taskbotCollectPhoneNumber | Reference to Taskbot Collect Phone Number. |
taskbotCollectVariableData |
taskbotCollectVariableData | Reference to Taskbot Collect Variable Data. |
taskbotGotoTaskbot |
taskbotGotoTaskbot | Reference to Taskbot Go To Taskbot. |
taskbotQuickReply |
taskbotQuickReply | Reference to Taskbot Quick Reply. |
taskbotSendImage |
taskbotSendImage | Reference to Taskbot Send Image. |
taskbotSendMessage |
taskbotSendMessage | Reference to Taskbot Send Message. |
taskbotSendVideo |
taskbotSendVideo | Reference to Taskbot Send Video. |
taskbotSSOLoginButton |
taskbotSSOLoginButton | Reference to Taskbot SSO Login Button. |
taskbotTransferChat |
taskbotTransferChat | Reference to Taskbot Transfer Chat. |
taskbotWebhook |
taskbotWebhook | Reference to Taskbot Webhook. |
GET bot/taskbotActions
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". |
An array of Taskbot Action
Sample Request:
Response:
HTTP/1.1 200 OK
GET bot/taskbotActions/{id}
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". |
Sample Request:
Response:
HTTP/1.1 200 OK
POST bot/taskbotActions
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 |
string | 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 | body | no | Reference to Taskbot Start. |
taskbotSendMessage |
taskbotSendMessage | body | no | Reference to Taskbot Send Message. |
taskbotSendImage |
taskbotSendImage | body | no | Reference to Taskbot Send Image. |
taskbotSendVideo |
taskbotSendVideo | body | no | Reference to Taskbot Send Video. |
taskbotSSOLoginButton |
taskbotSSOLoginButton | body | no | Reference to Taskbot SSO Login Button. |
taskbotCollectLocation |
taskbotCollectLocation | body | no | Reference to Taskbot Collect Location. |
taskbotCollectName |
taskbotCollectName | body | no | Reference to Taskbot Collect Name. |
taskbotCollectEmail |
taskbotCollectEmail | body | no | Reference to Taskbot Collect Email. |
taskbotCollectPhoneNumber |
taskbotCollectPhoneNumber | body | no | Reference to Taskbot Collect Phone Number. |
taskbotCollectCompanyName |
taskbotCollectCompanyName | body | no | Reference to Taskbot Collect Company Name. |
taskbotCollectComment |
taskbotCollectComment | body | no | Reference to Taskbot Collect Comment. |
taskbotCollectVariableData |
taskbotCollectVariableData | body | no | Reference to Taskbot Collect Variable Data. |
taskbotWebhook |
taskbotWebhook | body | no | Reference to Taskbot Webhook. |
taskbotSendEmail |
taskbotSendEmail | body | no | Reference to Taskbot Send Email. |
taskbotBookMeeting |
taskbotBookMeeting | body | no | Reference to Taskbot Book Meeting. |
taskbotGotoTaskbot |
taskbotGotoTaskbot | body | no | Reference to Taskbot Go To Taskbot. |
taskbotTransferChat |
taskbotTransferChat | body | no | Reference to Taskbot Transfer Chat. |
taskbotQuickReply |
taskbotQuickReply | body | no | Reference to Taskbot Quick Reply. |
Sample Request:
Response:
HTTP/1.1 201 Created
PUT bot/taskbotActions/{id}
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 |
string | 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 | body | no | Reference to Taskbot Start. |
taskbotSendMessage |
taskbotSendMessage | body | no | Reference to Taskbot Send Message. |
taskbotSendImage |
taskbotSendImage | body | no | Reference to Taskbot Send Image. |
taskbotSendVideo |
taskbotSendVideo | body | no | Reference to Taskbot Send Video. |
taskbotSSOLoginButton |
taskbotSSOLoginButton | body | no | Reference to Taskbot SSO Login Button. |
taskbotCollectLocation |
taskbotCollectLocation | body | no | Reference to Taskbot Collect Location. |
taskbotCollectName |
taskbotCollectName | body | no | Reference to Taskbot Collect Name. |
taskbotCollectEmail |
taskbotCollectEmail | body | no | Reference to Taskbot Collect Email. |
taskbotCollectPhoneNumber |
taskbotCollectPhoneNumber | body | no | Reference to Taskbot Collect Phone Number. |
taskbotCollectCompanyName |
taskbotCollectCompanyName | body | no | Reference to Taskbot Collect Company Name. |
taskbotCollectComment |
taskbotCollectComment | body | no | Reference to Taskbot Collect Comment. |
taskbotCollectVariableData |
taskbotCollectVariableData | body | no | Reference to Taskbot Collect Variable Data. |
taskbotWebhook |
taskbotWebhook | body | no | Reference to Taskbot Webhook. |
taskbotSendEmail |
taskbotSendEmail | body | no | Reference to Taskbot Send Email. |
taskbotBookMeeting |
taskbotBookMeeting | body | no | Reference to Taskbot Book Meeting. |
taskbotGotoTaskbot |
taskbotGotoTaskbot | body | no | Reference to Taskbot Go To Taskbot. |
taskbotTransferChat |
taskbotTransferChat | body | no | Reference to Taskbot Transfer Chat. |
taskbotQuickReply |
taskbotQuickReply | body | no | Reference to Taskbot Quick Reply. |
Sample Request:
Response:
HTTP/1.1 200 OK
DELETE bot/taskbotActions/{id}
No Content
Sample Request:
Response:
HTTP/1.1 204 No Content
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 bot/taskbotActions/{id}/taskbotStart
Sample Request:
Response:
HTTP/1.1 200 OK
PUT bot/taskbotActions/{id}/taskbotStart
Name | Type | In | Required | Description |
---|---|---|---|---|
nextActionId |
guid | body | no | Id of the next taskbot action. |
Sample Request:
Response:
HTTP/1.1 200 OK
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 bot/taskbotActions/{id}/taskbotCollectComment
Sample Request:
Response:
HTTP/1.1 200 OK
PUT bot/taskbotActions/{id}/taskbotCollectComment
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. |
Sample Request:
Response:
HTTP/1.1 200 OK
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 bot/taskbotActions/{id}/taskbotCollectCompanyName
Sample Request:
Response:
HTTP/1.1 200 OK
PUT bot/taskbotActions/{id}/taskbotCollectCompanyName
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. |
Sample Request:
Response:
HTTP/1.1 200 OK
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 bot/taskbotActions/{id}/taskbotCollectEmail
Sample Request:
Response:
HTTP/1.1 200 OK
PUT bot/taskbotActions/{id}/taskbotCollectEmail
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. |
Sample Request:
Response:
HTTP/1.1 200 OK
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 bot/taskbotActions/{id}/taskbotSendEmail
Sample Request:
Response:
HTTP/1.1 200 OK
PUT bot/taskbotActions/{id}/taskbotSendEmail
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. |
Sample Request:
Response:
HTTP/1.1 200 OK
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 bot/taskbotActions/{id}/taskbotBookMeeting
Sample Request:
Response:
HTTP/1.1 200 OK
PUT bot/taskbotActions/{id}/taskbotBookMeeting
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. |
Sample Request:
Response:
HTTP/1.1 200 OK
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 bot/taskbotActions/{id}/taskbotCollectLocation
Sample Request:
Response:
HTTP/1.1 200 OK
PUT bot/taskbotActions/{id}/taskbotCollectLocation
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. |
Sample Request:
Response:
HTTP/1.1 200 OK
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 bot/taskbotActions/{id}/taskbotCollectName
Sample Request:
Response:
HTTP/1.1 200 OK
PUT bot/taskbotActions/{id}/taskbotCollectName
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. |
Sample Request:
Response:
HTTP/1.1 200 OK
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 bot/taskbotActions/{id}/taskbotCollectPhoneNumber
Sample Request:
Response:
HTTP/1.1 200 OK
PUT bot/taskbotActions/{id}/taskbotCollectPhoneNumber
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. |
Sample Request:
Response:
HTTP/1.1 200 OK
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 |
string | Content of the custom page.Allowed values are "text", "textArea", "singleSelect", "multipleSelect", "email", "password", "date", "time". |
GET bot/taskbotActions/{id}/taskbotCollectVariableData
Sample Request:
Response:
HTTP/1.1 200 OK
PUT bot/taskbotActions/{id}/taskbotCollectVariableData
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 |
string | body | no | Content of the custom page.Allowed values are "text", "textArea", "singleSelect", "multipleSelect", "email", "password", "date", "time". |
Sample Request:
Response:
HTTP/1.1 200 OK
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 bot/taskbotActions/{id}/taskbotGotoTaskbot
Sample Request:
Response:
HTTP/1.1 200 OK
PUT bot/taskbotActions/{id}/taskbotGotoTaskbot
Name | Type | In | Required | Description |
---|---|---|---|---|
taskbotId |
guid | body | yes | Id of the taskbot. |
Sample Request:
Response:
HTTP/1.1 200 OK
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[] | Reference to Taskbot Quick Reply Option. |
GET bot/taskbotActions/{id}/taskbotQuickReply
Name | Type | In | Required | Description |
---|---|---|---|---|
include |
string | query | no | Allowed value is "taskbotQuickReplyOption". |
Sample Request:
Response:
HTTP/1.1 200 OK
PUT bot/taskbotActions/{id}/taskbotQuickReply
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[] | body | no | Reference to Taskbot Quick Reply Option. |
Sample Request:
Response:
HTTP/1.1 200 OK
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 bot/taskbotQuickReplyOptions
Sample Request:
Response:
HTTP/1.1 200 OK
GET bot/taskbotQuickReplyOptions/{id}
Sample Request:
Response:
HTTP/1.1 200 OK
POST bot/taskbotQuickReplyOptions
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. |
Sample Request:
Response:
HTTP/1.1 201 Created
PUT bot/taskbotQuickReplyOptions/{id}
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. |
Sample Request:
Response:
HTTP/1.1 200 OK
DELETE bot/taskbotQuickReplyOptions/{id}
No Content
Sample Request:
Response:
HTTP/1.1 204 No Content
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 bot/taskbotActions/{id}/taskbotSendImage
Sample Request:
Response:
HTTP/1.1 200 OK
PUT bot/taskbotActions/{id}/taskbotSendImage
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 |
Sample Request:
Response:
HTTP/1.1 200 OK
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[] | Reference to Taskbot Send Message Button. |
GET bot/taskbotActions/{id}/taskbotSendMessage
Name | Type | In | Required | Description |
---|---|---|---|---|
include |
string | query | no | Allowed value is "taskbotSendMessageButton". |
Sample Request:
Response:
HTTP/1.1 200 OK
PUT bot/taskbotActions/{id}/taskbotSendMessage
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[] | body | no | Reference to Taskbot Send Message Button. |
Sample Request:
Response:
HTTP/1.1 200 OK
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 |
string | Allowed values are "link", "webview". |
openIn |
string | Allowed values are "sideWindow", "newWindow", "currentWindow". |
openStyle |
string | Allowed values are "compact", "tall", "full". |
GET bot/taskbotSendMessageButtons
Sample Request:
Response:
HTTP/1.1 200 OK
GET bot/taskbotSendMessageButtons/{id}
Sample Request:
Response:
HTTP/1.1 200 OK
POST bot/taskbotSendMessageButtons
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 |
string | body | no | Allowed values are "link", "webview". |
openIn |
string | body | no | Allowed values are "sideWindow", "newWindow", "currentWindow". |
openStyle |
string | body | no | Allowed values are "compact", "tall", "full". |
Sample Request:
Response:
HTTP/1.1 201 Created
PUT bot/taskbotSendMessageButtons/{id}
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 |
string | body | no | Allowed values are "link", "webview". |
openIn |
string | body | no | Allowed values are "sideWindow", "newWindow", "currentWindow". |
openStyle |
string | body | no | Allowed values are "compact", "tall", "full". |
Sample Request:
Response:
HTTP/1.1 200 OK
DELETE bot/taskbotSendMessageButtons/{id}
No Content
Sample Request:
Response:
HTTP/1.1 204 No Content
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 bot/taskbotActions/{id}/taskbotSendVideo
Sample Request:
Response:
HTTP/1.1 200 OK
PUT bot/taskbotActions/{id}/taskbotSendVideo
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. |
Sample Request:
Response:
HTTP/1.1 200 OK
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 bot/taskbotActions/{id}/taskbotSSOLoginButton
Sample Request:
Response:
HTTP/1.1 200 OK
PUT bot/taskbotActions/{id}/taskbotSSOLoginButton
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. |
Sample Request:
Response:
HTTP/1.1 200 OK
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[] | Reference to Taskbot Webhook Header. |
taskbotWebhookResponseToVariables |
taskbotWebhookResponseToVariables[] | Reference to Taskbot Webhook Response To Variable. |
taskbotWebhookResponseCodeToActions |
taskbotWebhookResponseCodeToActions[] | Reference to Taskbot Webhook Response Code To Action. |
GET bot/taskbotActions/{id}/taskbotWebhook
Name | Type | In | Required | Description |
---|---|---|---|---|
include |
string | query | no | Allowed values are "taskbotWebhookHeader", "taskbotWebhookResponseToVariable", "taskbotWebhookResponseCodeToAction". |
Sample Request:
Response:
HTTP/1.1 200 OK
PUT bot/taskbotActions/{id}/taskbotWebhook
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[] | body | no | Reference to Taskbot Webhook Header. |
taskbotWebhookResponseToVariables |
taskbotWebhookResponseToVariables[] | body | no | Reference to Taskbot Webhook Response To Variable. |
taskbotWebhookResponseCodeToActions |
taskbotWebhookResponseCodeToActions[] | body | no | Reference to Taskbot Webhook Response Code To Action. |
Sample Request:
Response:
HTTP/1.1 200 OK
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 bot/taskbotWebhookHeaders
Sample Request:
Response:
HTTP/1.1 200 OK
GET bot/taskbotWebhookHeaders/{id}
Sample Request:
Response:
HTTP/1.1 200 OK
POST bot/taskbotWebhookHeaders
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. |
Sample Request:
Response:
HTTP/1.1 201 Created
PUT bot/taskbotWebhookHeaders/{id}
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. |
Sample Request:
Response:
HTTP/1.1 200 OK
DELETE bot/taskbotWebhookHeaders/{id}
No Content
Sample Request:
Response:
HTTP/1.1 204 No Content
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 bot/taskbotWebhookResponseToVariables
Sample Request:
Response:
HTTP/1.1 200 OK
GET bot/taskbotWebhookResponseToVariables/{id}
Sample Request:
Response:
HTTP/1.1 200 OK
POST bot/taskbotWebhookResponseToVariables
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. |
Sample Request:
Response:
HTTP/1.1 201 Created
PUT bot/taskbotWebhookResponseToVariables/{id}
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. |
Sample Request:
Response:
HTTP/1.1 200 OK
DELETE bot/taskbotWebhookResponseToVariables/{id}
No Content
Sample Request:
Response:
HTTP/1.1 204 No Content
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 bot/taskbotWebhookResponseCodeToActions
Sample Request:
Response:
HTTP/1.1 200 OK
GET bot/taskbotWebhookResponseCodeToActions/{id}
Sample Request:
Response:
HTTP/1.1 200 OK
POST bot/taskbotWebhookResponseCodeToActions
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. |
Sample Request:
Response:
HTTP/1.1 201 Created
PUT bot/taskbotWebhookResponseCodeToActions/{id}
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. |
Sample Request:
Response:
HTTP/1.1 200 OK
DELETE bot/taskbotWebhookResponseCodeToActions/{id}
No Content
Sample Request:
Response:
HTTP/1.1 204 No Content