Connectors Reference

Witivio

Witivio 365 connector.

 

Status: Preview

Tier: Premium

Version: 1.0

 

Actions:

Name

Summary

GetLicences ()

Get your licence

GetChatbotIDs (string licenceId)

Get your chatbots

GetChatbotLanguages (string botId)

Get your chatbot languages

GetQuestionIDs (string botId, string language, string profileId, string answerType, integer page, integer take)

Get the chatbot questions

GetProfileIDs (string botId)

Get the profile

GetWebhookResponseSchema (string botId, string questionId, string language)

Get the schema of the webhook response

GetWebhookResponseSchemaEscalation (string botId, string escalationId, string language)

Get the schema of the webhook response

GetEscalationIDs (string botId, string language, string profileId)

Get the chatbot escalations

SendFeedback (string botId, SendFeedbackParameterBody body)

The chatbot launch feedback

SendMessage (string botId, SendMessageParameterBody body)

The chatbot replies

SendAdaptive (string botId, SendAdaptiveParameterBody body)

The chatbot replies with adaptive card

SendMessageInput (string botId, SendMessageInputParameterBody body)

The chatbot asks a question

SendMessageInputList (string botId, SendMessageInputListParameterBody body)

The chatbot asks a question with a list of choices

SendMessageInputArray (string botId, SendMessageInputArrayParameterBody body)

The chatbot asks a question with an list of dynamics choices

GetResponseFromFlowQuestion (string botId, string activityId)

The user answer to flow question

 

Triggers:

Name

Summary

WebhookTrigger (string licenceId, string botId, string language, string profileId, string questionId, WebhookTriggerParameterBody body)

When the chatbot understand

WebhookEscalationTrigger (string licenceId, string botId, string language, string profileId, string escalationId, WebhookEscalationTriggerParameterBody body)

When the chatbot launch an escalation

 

Objects:

Name

Summary

GetChatbotIDsResponseItem

 

GetChatbotLanguagesResponseItem

 

GetEscalationIDsResponseItem

 

GetLicencesResponseItem

 

GetProfileIDsResponseItem

 

GetQuestionIDsResponseItem

 

GetResponseFromFlowQuestionResponse

 

GetWebhookResponseSchemaEscalationResponse

 

GetWebhookResponseSchemaResponse

 

QnAQuestionDto

 

SendAdaptiveParameterBody

 

SendAdaptiveResponse

 

SendFeedbackParameterBody

 

SendMessageInputArrayParameterBody

 

SendMessageInputArrayResponse

 

SendMessageInputListParameterBody

 

SendMessageInputListResponse

 

SendMessageInputParameterBody

 

SendMessageInputResponse

 

SendMessageParameterBody

 

SendMessageResponse

 

WebhookEscalationTriggerParameterBody

 

WebhookTriggerParameterBody

 

 

Actions:

GetLicences

Summary: Get your licence

Description: Get your licence

 

Syntax:

Witivio.GetLicences ()

 

Returns:

          Type:array of (GetLicencesResponseItem)

 

GetChatbotIDs

Summary: Get your chatbots

Description: Get your chatbots

 

Syntax:

Witivio.GetChatbotIDs (string licenceId)

 

Parameters:

Name

Type

Summary

Required

Related Action

licenceId

string

 

 

True

 

Returns:

          Type:array of (GetChatbotIDsResponseItem)

 

GetChatbotLanguages

Summary: Get your chatbot languages

Description: Get your chatbot languages

 

Syntax:

Witivio.GetChatbotLanguages (string botId)

 

Parameters:

Name

Type

Summary

Required

Related Action

botId

string

 

 

True

 

Returns:

          Type:array of (GetChatbotLanguagesResponseItem)

 

GetQuestionIDs

Summary: Get the chatbot questions

Description: Get the chatbot questions

 

Syntax:

Witivio.GetQuestionIDs (string botId, string language, string profileId, string answerType, integer page, integer take)

 

Parameters:

Name

Type

Summary

Required

Related Action

botId

string

 

Select the chatbot you want to trriger from.

True

language

string

 

 

True

profileId

string

 

 

True

answerType

string

 

 

True

page

integer

 

 

True

take

integer

 

 

True

 

Returns:

          Type:array of (GetQuestionIDsResponseItem)

 

GetProfileIDs

Summary: Get the profile

Description: Get the profile

 

Syntax:

Witivio.GetProfileIDs (string botId)

 

Parameters:

Name

Type

Summary

Required

Related Action

botId

string

 

 

True

 

Returns:

          Type:array of (GetProfileIDsResponseItem)

 

GetWebhookResponseSchema

Summary: Get the schema of the webhook response

Description: Get the schema of the webhook response

 

Syntax:

Witivio.GetWebhookResponseSchema (string botId, string questionId, string language)

 

Parameters:

Name

Type

Summary

Required

Related Action

botId

string

 

 

True

questionId

string

 

 

True

language

string

 

 

True

 

Returns:

          Type:GetWebhookResponseSchemaResponse

 

GetWebhookResponseSchemaEscalation

Summary: Get the schema of the webhook response

Description: Get the schema of the webhook response

 

Syntax:

Witivio.GetWebhookResponseSchemaEscalation (string botId, string escalationId, string language)

 

Parameters:

Name

Type

Summary

Required

Related Action

botId

string

 

 

True

escalationId

string

 

 

True

language

string

 

 

True

 

Returns:

          Type:GetWebhookResponseSchemaEscalationResponse

 

GetEscalationIDs

Summary: Get the chatbot escalations

Description: Get the chatbot escalations

 

Syntax:

Witivio.GetEscalationIDs (string botId, string language, string profileId)

 

Parameters:

Name

Type

Summary

Required

Related Action

botId

string

 

Select the chatbot you want to trriger from.

True

language

string

 

 

True

profileId

string

 

 

True

 

Returns:

          Type:array of (GetEscalationIDsResponseItem)

 

SendFeedback

Summary: The chatbot launch feedback

Description: The chatbot launch feedback

 

Syntax:

Witivio.SendFeedback (string botId, SendFeedbackParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

botId

string

(Chatbot ID)

The chatbot ID.

True

body

SendFeedbackParameterBody

 

 

True

 

Returns:

 

SendMessage

Summary: The chatbot replies

Description: Send Message

 

Syntax:

Witivio.SendMessage (string botId, SendMessageParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

botId

string

(Chatbot ID)

The chatbot ID.

True

body

SendMessageParameterBody

 

 

True

 

Returns:

          Type:SendMessageResponse

 

SendAdaptive

Summary: The chatbot replies with adaptive card

Description: The chatbot replies with adaptive card

 

Syntax:

Witivio.SendAdaptive (string botId, SendAdaptiveParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

botId

string

(Chatbot ID)

The chatbot ID.

True

body

SendAdaptiveParameterBody

 

 

True

 

Returns:

          Type:SendAdaptiveResponse

 

SendMessageInput

Summary: The chatbot asks a question

Description: The chatbot asks a question

 

Syntax:

Witivio.SendMessageInput (string botId, SendMessageInputParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

botId

string

(Chatbot ID)

The chatbot ID.

True

body

SendMessageInputParameterBody

 

 

True

 

Returns:

          Type:SendMessageInputResponse

 

SendMessageInputList

Summary: The chatbot asks a question with a list of choices

Description: The chatbot asks a question with a list of choices

 

Syntax:

Witivio.SendMessageInputList (string botId, SendMessageInputListParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

botId

string

(Chatbot ID)

The chatbot ID.

True

body

SendMessageInputListParameterBody

 

 

True

 

Returns:

          Type:SendMessageInputListResponse

 

SendMessageInputArray

Summary: The chatbot asks a question with an list of dynamics choices

Description: The chatbot asks a question with an list of dynamics choices

 

Syntax:

Witivio.SendMessageInputArray (string botId, SendMessageInputArrayParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

botId

string

(Chatbot ID)

The chatbot ID.

True

body

SendMessageInputArrayParameterBody

 

 

True

 

Returns:

          Type:SendMessageInputArrayResponse

 

GetResponseFromFlowQuestion

Summary: The user answer to flow question

Description:

 

Syntax:

Witivio.GetResponseFromFlowQuestion (string botId, string activityId)

 

Parameters:

Name

Type

Summary

Required

Related Action

botId

string

(Chatbot ID)

The chatbot ID.

True

activityId

string

(Activity ID)

The activity ID.

True

 

Returns:

          Type:GetResponseFromFlowQuestionResponse

 

Triggers:

Trigger WebhookTrigger

Summary: When the chatbot understand

Description: When the chatbot understand

 

Syntax:

Witivio.WebhookTrigger (string licenceId, string botId, string language, string profileId, string questionId, WebhookTriggerParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

licenceId

string

(Select the licence)

Select the licence.

True

GetLicences

botId

string

(Select the chatbot)

Select the chatbot you want to trigger from.

True

GetChatbotIDs

language

string

(Select the language)

Select the language.

True

GetChatbotLanguages

profileId

string

(Select the profile)

Select the profile.

True

GetProfileIDs

questionId

string

(Select the question)

Select the question you want to trigger from.

True

GetQuestionIDs

body

WebhookTriggerParameterBody

 

 

True

 

Returns:

 

Trigger WebhookEscalationTrigger

Summary: When the chatbot launch an escalation

Description: When the chatbot launch an escalation

 

Syntax:

Witivio.WebhookEscalationTrigger (string licenceId, string botId, string language, string profileId, string escalationId, WebhookEscalationTriggerParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

licenceId

string

(Select the licence)

Select the licence.

True

GetLicences

botId

string

(Select the chatbot)

Select the chatbot you want to trigger from.

True

GetChatbotIDs

language

string

(Select the language)

Select the language.

True

GetChatbotLanguages

profileId

string

(Select the profile)

Select the profile.

True

GetProfileIDs

escalationId

string

(Select the escalation)

Select the escalation you want to trigger from.

True

GetEscalationIDs

body

WebhookEscalationTriggerParameterBody

 

 

True

 

Returns:

 


 

GetChatbotIDsResponseItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

 

 

name

string

 

 


 

GetChatbotLanguagesResponseItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

name

string

 

 


 

GetEscalationIDsResponseItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

 

 


 

GetLicencesResponseItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

 

 

clientName

string

 

 


 

GetProfileIDsResponseItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

 

 

name

string

 

 


 

GetQuestionIDsResponseItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

Result

array of (QnAQuestionDto)

 

 

TotalCount

integer(int32)

 

 

AllItemsCount

integer(int32)

 

 


 

GetResponseFromFlowQuestionResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

message

string

 

 


 

GetWebhookResponseSchemaEscalationResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

GetWebhookResponseSchemaResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

QnAQuestionDto

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

 

 

botId

string

 

 

language

string

 

 

categoryId

string

 

 

profileId

string

 

 

question

string

 

 

createdBy

string

 

 

modifiedBy

string

 

 

createdAt

string(date-time)

 

 

modifiedAt

string(date-time)

 

 

countAlternatives

integer(int32)

 

 

scheduleFrom

string(date-time)

 

 

scheduleTo

string(date-time)

 

 


 

SendAdaptiveParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

conversationContext

ConversationContext

Conversation context

Pass here the conversation context

message

string

Adaptive card json

Adaptive card json

 

ConversationContext

Summary: Conversation context

Description: Pass here the conversation context

 

          Properties:

Name

Type

Summary

 


 

SendAdaptiveResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

message

string

 

 


 

SendFeedbackParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

conversationContext

ConversationContext

Conversation context

Pass here the conversation context

answer

Answer

Answer object

Pass here the initial object answer

 

ConversationContext

Summary: Conversation context

Description: Pass here the conversation context

 

          Properties:

Name

Type

Summary

 

Answer

Summary: Answer object

Description: Pass here the initial object answer

 

          Properties:

Name

Type

Summary

 


 

SendMessageInputArrayParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

conversationContext

ConversationContext

Conversation context

Pass here the conversation context

question

string

Question

the chatbot asks

listChoice

array of (ListChoiceItem)

List of choices

List of choices

jsonPath

string

Value to select in List

Value to select in List

 

ConversationContext

Summary: Conversation context

Description: Pass here the conversation context

 

          Properties:

Name

Type

Summary

 

ListChoiceItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

 


 

SendMessageInputArrayResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

message

string

 

 

body

Body

 

 

 

Body

Summary:

Description:

 

          Properties:

Name

Type

Summary

 


 

SendMessageInputListParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

conversationContext

ConversationContext

Conversation context

Pass here the conversation context

question

string

Question

the chatbot asks

choice1

string

First choice

First choice

choice2

string

Second choice

Second choice

choice3

string

Third choice

Third choice

choice4

string

Fourth choice

Fourth choice

choice5

string

Fifth choice

Fifth choice

choice6

string

Sixth choice

Sixth choice

choice7

string

Seventh choice

Seventh choice

choice8

string

Eigth choice

Eigth choice

choice9

string

Nineth choice

Nineth choice

choice10

string

Tenth choice

Tenth choice

 

ConversationContext

Summary: Conversation context

Description: Pass here the conversation context

 

          Properties:

Name

Type

Summary

 


 

SendMessageInputListResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

message

string

 

 


 

SendMessageInputParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

conversationContext

ConversationContext

Conversation context

Pass here the conversation context

question

string

Question

the chatbot asks

 

ConversationContext

Summary: Conversation context

Description: Pass here the conversation context

 

          Properties:

Name

Type

Summary

 


 

SendMessageInputResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

message

string

 

 


 

SendMessageParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

conversationContext

ConversationContext

Conversation context

Pass here the conversation context

message

string

Message

the chatbot replies

 

ConversationContext

Summary: Conversation context

Description: Pass here the conversation context

 

          Properties:

Name

Type

Summary

 


 

SendMessageResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

message

string

 

 


 

WebhookEscalationTriggerParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

callbackUrl

string

 

callbackUrl


 

WebhookTriggerParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

callbackUrl

string

 

callbackUrl