Connectors Reference
Create powerful conversation experience for your customers right from your CRM system. Learn more https://docs.crmbot.ai/
|
Status: Preview |
Tier: Premium |
Version: 1.0 |
|
Name |
Summary |
|
build-custom-message ([Optional]build-custom-messageParameterBody body) |
Build Adaptive Card Response |
|
build-text-message ([Optional]build-text-messageParameterBody body) |
Build Text Response |
|
Build Card Response |
|
|
build-quickreplies-message (build-quickreplies-messageParameterBody body) |
Build Quick Reply Response |
|
build-media-message ([Optional]build-media-messageParameterBody body) |
Build Media Response |
|
Send Response |
|
|
send-proactive-message (send-proactive-messageParameterBody body) |
Send Proactive Message |
|
Get intents |
|
|
Get contexts |
|
|
Get events |
|
|
Get intent schema |
|
Name |
Summary |
|
intent-detected ([Optional]intent-detectedParameterBody body) |
When Intent is detected |
|
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Summary: Build Adaptive Card Response
Description: Creates Microsoft Adaptive Card response to send to the user.
Syntax:
CRMBot.build-custom-message ([Optional]build-custom-messageParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
build-custom-messageParameterBody
|
|
False |
Returns:
Type:build-custom-messageResponse
Summary: Build Text Response
Description: Creates a standard text response to send to the user.
Syntax:
CRMBot.build-text-message ([Optional]build-text-messageParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
build-text-messageParameterBody
|
|
False |
Returns:
Type:build-text-messageResponse
Summary: Build Card Response
Description: Creates Card response to send to the user.
Syntax:
CRMBot.build-card-message (build-card-messageParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
build-card-messageParameterBody
|
|
True |
Returns:
Type:build-card-messageResponse
Summary: Build Quick Reply Response
Description: Creates a small menu of suggested actions for the user.
Syntax:
CRMBot.build-quickreplies-message (build-quickreplies-messageParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
build-quickreplies-messageParameterBody
|
|
True |
Returns:
Type:build-quickreplies-messageResponse
Summary: Build Media Response
Description: Creates an image or video to send to the user.
Syntax:
CRMBot.build-media-message ([Optional]build-media-messageParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
build-media-messageParameterBody
|
|
False |
Returns:
Type:build-media-messageResponse
Summary: Send Response
Description: Sends your response to the user within the context of existing conversation (Requires Bot Trigger).
Syntax:
CRMBot.send-response (send-responseParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
|
|
True |
Returns:
Summary: Send Proactive Message
Description: Sends your response to the user outside of the standard conversation (requires User ID).
Syntax:
CRMBot.send-proactive-message (send-proactive-messageParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
send-proactive-messageParameterBody
|
|
True |
Returns:
Summary: Get intents
Description: Get intents
Syntax:
CRMBot.get-intents ()
Returns:
Type:array of (get-intentsResponseItem)
Summary: Get contexts
Description: Get contexts
Syntax:
CRMBot.get-contexts ()
Returns:
Type:array of (string)
Summary: Get events
Description: Get events
Syntax:
CRMBot.get-events ()
Returns:
Type:array of (string)
Summary: Get intent schema
Description: Get intent schema
Syntax:
CRMBot.get-schema (string intent)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
intent |
string
|
Select the intent |
True |
Returns:
Type:get-schemaResponse
Summary: When Intent is detected
Description: Triggers when CRM Bot matches user request to one of your Intents with fullfilment.
Syntax:
CRMBot.intent-detected ([Optional]intent-detectedParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
|
|
False |
Returns:
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
platform |
string
|
Use Platform parameter from trigger action |
|
title |
string
|
Enter card title |
|
subtitle |
string
|
Enter card description (optional) |
|
url |
string
|
Enter url of your .jpg or .png (optional) |
|
isCarousel |
boolean
|
Set to NO as default. |
|
buttontitle1 |
string
|
Title of your button |
|
buttonpostback1 |
string
|
Postback (text sent to Flow) of your button |
|
buttontitle2 |
string
|
Title of your button |
|
buttonpostback2 |
string
|
Postback (text sent to Flow) of your button |
|
buttontitle3 |
string
|
Title of your button |
|
buttonpostback3 |
string
|
Postback (text sent to Flow) of your button |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
message |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
platform |
string
|
Use Platform parameter from trigger action |
|
text |
string
|
Paste here your adaptive card JSON |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
message |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
platform |
string
|
Use Platform parameter from trigger action |
|
url |
string
|
Enter url of your image or video |
|
mediaType |
string
|
Select right type Values: [1, 2] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
message |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
platform |
string
|
Use Platform parameter from trigger action |
|
title |
string
|
Text to display above the options |
|
text |
string
|
Provide list of comma separated options |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
message |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
platform |
string
|
Use Platform parameter from trigger action |
|
text |
string
|
Provide your response |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
message |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
intent |
string
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
callbackUrl |
string
|
callbackUrl |
|
intent |
string Select intent you would like to trigger on |
Select intent you would like to trigger on |
|
platform |
string Use Unspecified if your flow is platform agnostic |
Use Unspecified if your flow is platform agnostic Values: [Unspecified, Messenger, Google Assistant, Skype, Slack] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
sessionId |
string
|
Needs to come from your trigger or supporting datasets |
|
useGlossary |
boolean
|
If you have a custom dictionary for your Bot select Yes |
|
targetLanguage |
string
|
Use Language parameter from trigger action |
|
webhookResponse |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
FulfillmentMessages |
array of (FulfillmentMessagesItem)
|
Use Message parameter from your Response Actions |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
sessionId |
string
|
Use BotSessionID parameter from trigger action |
|
useGlossary |
boolean
|
If you have a custom dictionary for your Bot select Yes |
|
targetLanguage |
string
|
Use Language parameter from trigger action |
|
webhookResponse |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
FulfillmentMessages |
array of (FulfillmentMessagesItem)
|
Use Message parameter from your Response Actions |
|
EventName |
string Select the event you would like to invoke |
Select the event you would like to invoke |
|
OutputContextName |
string Apply specific context to response |
Apply specific context to response |
|
OutputContextLifespan |
integer Duration of context |
Duration of context |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |