Connectors Reference
COSMO Bot increases your business success through more efficiency in everyday life. If you answer a standard question today, you are wasting time. In contact with your customers, this is often a good opportunity to get to know each other and establish a relationship. But internally, from employee to employee, or when there is simply too much to do, it is a luxury that not everyone can allow themselves. This Connector allows you to extend the bots functionality and integrate other systems.
|
Status: Preview |
Tier: Premium |
Version: 1.0 |
|
Name |
Summary |
|
When a new ticket is created |
|
|
OnResolvedTicket (OnResolvedTicketParameterRequest body Request body) |
When a ticket is resolved |
|
OnUpdatedTicketTopic (OnUpdatedTicketTopicParameterRequest body Request body) |
When a ticket's topic is updated |
|
When a new question-answer set is created |
|
|
OnUpdateAnswer (OnUpdateAnswerParameterRequest body Request body) |
When a question-answer set is created or modified |
|
OnAskedQuestion (OnAskedQuestionParameterRequest body Request body) |
When a user asks a question |
|
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Summary: Get global settings
Description: Gets the global settings from the connected instance.
Syntax:
COSMOBot.GetGlobalSettings ()
Returns:
Type:GetGlobalSettingsResponse
Summary: Get global settings schema
Description:
Syntax:
COSMOBot.GetGlobalSettingsSchema ()
Returns:
Type:GetGlobalSettingsSchemaResponse
Summary: Ask COSMO Bot a question
Description: The bot will search through the knowledgebase and return the answer with the best match. Also returns the score.
Syntax:
COSMOBot.AskQuestion ([Optional]AskQuestionParameterRequest body Request body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Request body |
AskQuestionParameterRequest body
|
|
False |
Returns:
Type:AskQuestionResponse
Summary: Convert COSMO Bot Script
Description: Run the given text through the COSMO Bot Script parser.
Syntax:
COSMOBot.ParseText ([Optional]ParseTextParameterRequest body Request body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Request body |
ParseTextParameterRequest body
|
|
False |
Returns:
Type:ParseTextResponse
Summary: Translate (markdown friendly)
Description: Translate the given text while respecting the COSMO Bot dialect Markdown syntax.
Syntax:
COSMOBot.Translate ([Optional]TranslateParameterRequest body Request body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Request body |
TranslateParameterRequest body
|
|
False |
Returns:
Type:TranslateResponse
Summary: Get all topics
Description: Gets all topics from the connected bot instance.
Syntax:
COSMOBot.GetAllTopics ()
Returns:
Type:GetAllTopicsResponse
Summary: Get topic
Description: Gets a specific topic from the connected instance.
Syntax:
COSMOBot.GetTopic ([Optional]GetTopicParameterRequest body Request body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Request body |
|
|
False |
Returns:
Type:GetTopicResponse
Summary: Get all question-answer sets
Description: Gets all answers from the connected instance.
Syntax:
COSMOBot.GetAllAnswers ([Optional]GetAllAnswersParameterRequest body Request body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Request body |
GetAllAnswersParameterRequest body
|
|
False |
Returns:
Summary: Get experts for a topic
Description: Gets all expoerts from the connected instance.
Syntax:
COSMOBot.GetExperts ([Optional]GetExpertsParameterRequest body Request body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Request body |
GetExpertsParameterRequest body
|
|
False |
Returns:
Type:GetExpertsResponse
Summary: Add an expert to a topic
Description: The bot will add the expert to the provided topic.
Syntax:
COSMOBot.AddExpert ([Optional]AddExpertParameterRequest body Request body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Request body |
AddExpertParameterRequest body
|
|
False |
Returns:
Summary: Remove an expert from a topic
Description: The bot will remove an expert from the provided topic. If no topic is given, the expert will be removed from all topics.
Syntax:
COSMOBot.RemoveExpert ([Optional]RemoveExpertParameterRequest body Request body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Request body |
RemoveExpertParameterRequest body
|
|
False |
Returns:
Summary: Add a new topic
Description: Adds a new topic to the connected instance.
Syntax:
COSMOBot.AddTopic ([Optional]AddTopicParameterRequest body Request body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Request body |
|
|
False |
Returns:
Summary: Rename an existing topic
Description: Rename a existing topic from the connected instance.
Syntax:
COSMOBot.RenameTopic ([Optional]RenameTopicParameterRequest body Request body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Request body |
RenameTopicParameterRequest body
|
|
False |
Returns:
Summary: Add a new question-answer set
Description: Adds a new question-answer set to the connected instance.
Syntax:
COSMOBot.AddAnswer ([Optional]AddAnswerParameterRequest body Request body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Request body |
AddAnswerParameterRequest body
|
|
False |
Returns:
Summary: Edit an existing question-answer set
Description: Edit an existing question-answer set from the connected instance.
Syntax:
COSMOBot.EditAnswer ([Optional]EditAnswerParameterRequest body Request body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Request body |
EditAnswerParameterRequest body
|
|
False |
Returns:
Summary: Delete a question-answer set
Description: Delete an existing question-answer set from the connected instance.
Syntax:
COSMOBot.DeleteAnswer ([Optional]DeleteAnswerParameterRequest body Request body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Request body |
DeleteAnswerParameterRequest body
|
|
False |
Returns:
Summary: Create a shadow copy of a question-answer set
Description: Adds a new shadow copy for the question-answer set specified by the short description. Careful! These shadow copies are deleted when the answer is updated. It is therefore recommended to automatically call this action using the "when a question-answer set is updated" trigger.
Syntax:
COSMOBot.AddSubAnswer ([Optional]AddSubAnswerParameterRequest body Request body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Request body |
AddSubAnswerParameterRequest body
|
|
False |
Returns:
Summary: Get open tickets
Description: Gets all open tickets from the connected instance.
Syntax:
COSMOBot.GetOpenTickets ([Optional]GetOpenTicketsParameterRequest body Request body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Request body |
GetOpenTicketsParameterRequest body
|
|
False |
Returns:
Summary: Open a ticket (question)
Description: Open a new ticket on the connected instance.
Syntax:
COSMOBot.OpenTicketQuestion ([Optional]OpenTicketQuestionParameterRequest body Request body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Request body |
OpenTicketQuestionParameterRequest body
|
|
False |
Returns:
Type:OpenTicketQuestionResponse
Summary: Open a ticket (feedback)
Description: Open a new ticket of type feedback on the connected instance.
Syntax:
COSMOBot.OpenTicketFeedback ([Optional]OpenTicketFeedbackParameterRequest body Request body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Request body |
OpenTicketFeedbackParameterRequest body
|
|
False |
Returns:
Type:OpenTicketFeedbackResponse
Summary: Close a ticket
Description: Closes an open ticket on the connected instance.
Syntax:
COSMOBot.CloseTicket ([Optional]CloseTicketParameterRequest body Request body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Request body |
CloseTicketParameterRequest body
|
|
False |
Returns:
Summary: Delete a webhook
Description:
Syntax:
COSMOBot.DeleteTrigger (integer id)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
id |
integer
|
|
True |
Returns:
Summary: When a new ticket is created
Description: When a new Ticket is created.
Syntax:
COSMOBot.OnNewTicket (OnNewTicketParameterRequest body Request body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Request body |
OnNewTicketParameterRequest body
|
|
True |
Returns:
Summary: When a ticket is resolved
Description: When a existing Ticket is resolved.
Syntax:
COSMOBot.OnResolvedTicket (OnResolvedTicketParameterRequest body Request body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Request body |
OnResolvedTicketParameterRequest body
|
|
True |
Returns:
Summary: When a ticket's topic is updated
Description: When a topic of an existing Ticket is updated.
Syntax:
COSMOBot.OnUpdatedTicketTopic (OnUpdatedTicketTopicParameterRequest body Request body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Request body |
OnUpdatedTicketTopicParameterRequest body
|
|
True |
Returns:
Summary: When a new question-answer set is created
Description: When a new question-answer set is created.
Syntax:
COSMOBot.OnNewAnswer (OnNewAnswerParameterRequest body Request body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Request body |
OnNewAnswerParameterRequest body
|
|
True |
Returns:
Summary: When a question-answer set is created or modified
Description: When a question-answer set is created or modified.
Syntax:
COSMOBot.OnUpdateAnswer (OnUpdateAnswerParameterRequest body Request body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Request body |
OnUpdateAnswerParameterRequest body
|
|
True |
Returns:
Summary: When a user asks a question
Description: When a user asks a question.
Syntax:
COSMOBot.OnAskedQuestion (OnAskedQuestionParameterRequest body Request body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Request body |
OnAskedQuestionParameterRequest body
|
|
True |
Returns:
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
topic |
string
|
|
|
shortDescription |
string
|
|
|
questions |
array of (string)
|
|
|
answerText |
string
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
topic |
string
|
|
|
expertEmail |
string
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
shortDescription |
string
|
|
|
subShortDescription |
string
|
|
|
subQuestions |
array of (string)
|
|
|
subAnswerText |
string
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
name |
string
|
|
|
description |
string
|
|
|
expertEmails |
array of (string)
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
topic |
string
|
|
|
shortDescription |
string
|
|
|
questions |
array of (string)
|
|
|
answerText |
string
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
question |
string
|
|
|
scoreThreshold |
integer
|
Minimum score of an answer for it to be returned. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
foundAnswer |
boolean
|
Whether COSMO Bot found an answer that matched the question. |
|
isSubAnswer |
boolean
|
Whether the returned answer is a sub answer. |
|
isTranslated |
boolean
|
Whether the question and returned answer was translated. |
|
answer |
|
|
|
score |
integer
|
How confident the bot is that the returned answer is correct. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
ticketId |
string
|
|
|
editorEmail |
string
|
|
|
editorComment |
string
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
shortDescription |
string
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
shortDescription |
string
|
|
|
newTopic |
string
|
|
|
newShortDescription |
string
|
|
|
newQuestions |
array of (string)
|
|
|
newAnswerText |
string
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
filterByTopic |
string
|
|
|
filterByShortDescription |
string
|
|
|
filterByQuestionText |
string
|
|
|
filterByAnswerText |
string
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
answers |
array of (Answer)
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
topics |
array of (string)
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
topic |
string
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
expertEmails |
array of (string)
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
schema |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
filterByHoursSinceOpened |
integer
|
Only get tickets that have been open for **longer** than x hours. |
|
filterByHoursSinceOpenedMax |
integer
|
Only get tickets that have been open for **less** than x hours. |
|
filterByTopic |
string
|
|
|
filterByExpertEmail |
string
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
tickets |
array of (Ticket)
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
topicName |
string
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
topic |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
name |
string
|
|
|
description |
string
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
url |
string
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
url |
string
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
url |
string
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
url |
string
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
url |
string
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
url |
string
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
userEmail |
string
|
|
|
queryText |
string
|
|
|
answerShortDescription |
string
|
|
|
feedbackText |
string
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
ticket |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
userEmail |
string
|
|
|
queryText |
string
|
|
|
topic |
string
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
ticket |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
inputText |
string
|
|
|
outputFormat |
string
|
Values: [markdown, html, plain] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
outputText |
string
|
The parsed text returned by the COSMO Bot Script Parser. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
expertEmail |
string
|
|
|
topic |
string
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
name |
string
|
The name of the existing topic to be renamed. |
|
newName |
string
|
The name that the topic will be renamed to. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
ticketId |
string
|
|
|
topic |
string
|
|
|
ticketUrl |
string
|
|
|
requesterEmail |
string
|
|
|
expertEmails |
array of (string)
|
|
|
queryText |
string
|
|
|
feedbackText |
string
|
This is empty if this ticket is not feedback. |
|
answerShortDescription |
string
|
This is empty if this ticket is not feedback. |
|
answerText |
string
|
This is empty if this ticket is not feedback. |
|
dateTimeCreated |
string(date-time)
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
targetLanguageCode |
string
|
The target language code (example: fr). |
|
inputText |
string
|
The text to translate. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
outputText |
string
|
|