Userbot 1.0.0 documentation

Userbot 1.0.0

application/json

To start the communication with Userbot, an apiLogin [apikey] command is necessary, using the apikey received from Userbot. Then, a sitekey undefined [bot_argument] command, in order to use the other APIs for the specific bot. The who command is important to get information about the logged user, especially the id of the user, that is used in the robin commands, for chat information

#chatusers
#bot
#automated-messages
#stats
#nps
#login
#apiLogin
#sitekey
#qeafilter
#chat
#chat-notification
#intel
#meetings

Servers

ai.userbot.aiwssproduction
Once the socket is open and you are autenthicated you can subscribe to a public channel by sending a subscribe request message.

Operations

PUB bot.get-vars
Get Bot variables' list

Operation IDbot.get-vars.request
- #bot
Accepts the following message:
BotGetVarsRequest
object
command
string
status
number
Allowed values:
200
404
500
Additional properties are allowed.
array<object>
id
number
name
string
type
string
Allowed values:
"text"
bot_id
number
uuid
string
schemaFormat
application/vnd.aai.asyncapi;version=2.4.0
Examples
SUB bot.get-vars
Operation IDbot.get-vars.response
- #bot
Accepts the following message:
BotGetVarsResponse
allOf
uid: BotGetVarsResponsePayload
object
command
string
status
number
Allowed values:
200
404
500
Additional properties are allowed.
restricted any
array<object>
id
number
name
string
type
string
Allowed values:
"text"
bot_id
number
uuid
string
Examples
{ "command": "string", "status": 200, "variables": [ { "id": 0, "name": "string", "type": "text", "bot_id": 0, "uuid": "string" } ] }

This example has been generated automatically.
PUB chatusers.get
Send messages to the API

Operation IDchatusers.get.request
- #chatusers
Accepts the following message:
ChatUsersGetRequest
Ask a list of chat users
Client can ask to the server the list of users that interacted with a given bot, based on offset and limit parameters. This is because there is infinite scrolling on the dash USERS and the data needs to be limited

object
uid: ChatUsersGetRequestPayload
offset
integer
Default value:0
limit
integer
Default value:25
array<object>
mode
string
Allowed values:
"ASC"
"DESC"
field
string
search
string
A string used to search in all ChatUser properties

Default value:""
anonymous
boolean
If property is true must be returned also anonymous users

Default value:
array<object>
entity
string
operator
string
If type is equal to "tag" valid operators will be only "is" and "is_not".

Allowed values:
"is"
"is_not"
"has_any_value"
"contains"
"does_not_contain"
"greater_than"
"greater_than_or_equal"
"less_than"
"less_than_or_equal"
type
string
Allowed values:
"variable"
"tag"
value
string
tags
boolean
if tags is true it will load tags on every ChatUsers of the response

Default value:
Additional properties are allowed.
name
chatusers
summary
List the chat users of a single bot
object
uid: ChatUsersGetResponsePayload
array<object>
uid: ChatUser
id
integer
name
string
The name of the user

surname
string
The surname of the user

email
string
The email of the user

phone
string
The phone of the user

firstChat
string
format: date-time
The first time the user chatted

lastChat
string
format: date-time
The last time the user chatted

language
string
browser
string
Browser used if Web page was visited

source
string
Last source of contact (web, facebook, etc...)

array<string>
List of tags assigned to ChatUser.

Items:
string
total
integer
Total number of chat users in a Bot

anonymous
integer
Total number of anonymous users in a Bot

namedUsers
integer
Total number of not anonymous users in a Bot

filteredCounter
integer
Total number of chat users that has match a filtered search using filters, anonymouse and search params

Additional properties are allowed.
schemaFormat
application/vnd.aai.asyncapi;version=2.4.0
#chatusers
Examples
{ "offset": 0, "limit": 25, "orderBy": [ { "mode": "ASC", "field": "string" } ], "search": "", "anonymous": false, "filters": [ { "entity": "string", "operator": "is", "type": "variable", "value": "string" } ], "tags": false }

This example has been generated automatically.
SUB chatusers.get
Messages that you receive from the API

Operation IDchatusers.get.response
- #chatusers
Accepts the following message:
ChatUsersGetResponse
List the chat users of a single bot
object
uid: ChatUsersGetResponsePayload
array<object>
uid: ChatUser
id
integer
name
string
The name of the user

surname
string
The surname of the user

email
string
The email of the user

phone
string
The phone of the user

firstChat
string
format: date-time
The first time the user chatted

lastChat
string
format: date-time
The last time the user chatted

language
string
browser
string
Browser used if Web page was visited

source
string
Last source of contact (web, facebook, etc...)

array<string>
List of tags assigned to ChatUser.

Items:
string
total
integer
Total number of chat users in a Bot

anonymous
integer
Total number of anonymous users in a Bot

namedUsers
integer
Total number of not anonymous users in a Bot

filteredCounter
integer
Total number of chat users that has match a filtered search using filters, anonymouse and search params

Additional properties are allowed.
#chatusers
Examples
{ "users": [ { "id": 0, "name": "string", "surname": "string", "email": "string", "phone": "string", "firstChat": "2019-08-24T14:15:22Z", "lastChat": "2019-08-24T14:15:22Z", "language": "string", "browser": "string", "source": "string", "tags": [ "string" ] } ], "total": 0, "anonymous": 0, "namedUsers": 0, "filteredCounter": 0 }

This example has been generated automatically.
PUB chatusers.create
Save an array of new ChatUsers

Operation IDchatusers.create.request
- #chatusers
Accepts the following message:
ChatUsersCreateRequest
array<object>
firstname
required
string
The name of the User

lastname
required
string
The surname of the User

email
required
string
The email of the User

phone
required
string
The phone number of the User

consentConfirmation
required
boolean
The consent confirmation checkbox means Customer has the explicit consent of the User to be signing up

userid
integer
The userid is the id of the user that needs to be updated, if an user is created userid is not sent

object
command
string
status
number
Allowed values:
200
404
500
Additional properties are allowed.
array<object>
command
string
status
number
Allowed values:
200
404
500
schemaFormat
application/vnd.aai.asyncapi;version=2.4.0
Examples
[ { "firstname": "string", "lastname": "string", "email": "string", "phone": "string", "consentConfirmation": true, "userid": 0 } ]

This example has been generated automatically.
SUB chatusers.create
The array of ChatUsers saved

Operation IDchatusers.create.response
- #chatusers
Accepts the following message:
ChatUsersCreateResponse
allOf
uid: ChatUsersCreateResponsePayload
object
command
string
status
number
Allowed values:
200
404
500
Additional properties are allowed.
And with:
any
Examples
{ "command": "string", "status": 200 }

This example has been generated automatically.
PUB chatusers.delete
Send list of chat users id to delete

Operation IDchatusers.delete.request
- #chatusers
Accepts the following message:
ChatUsersDeleteRequest
object
uid: ChatUsersDeleteRequestPayload
all
boolean
If true it means all users must be deleted from the database

array<integer>
List of Chat User's id to delete from database

Items:
integer
array<any>
If this parameter is in the payload, and is set to all true, delete all the users except those specified in this array of usersId

Additional properties are allowed.
object
command
string
status
number
Allowed values:
200
404
500
Additional properties are allowed.
object
array<integer>
Items:
integer
Additional properties are allowed.
schemaFormat
application/vnd.aai.asyncapi;version=2.4.0
Examples
{ "all": true, "usersId": [ 0 ], "exceptUsersId": [] }

This example has been generated automatically.
SUB chatusers.delete
Messages that you receive from the API when you delete one or more chat users

Operation IDchatusers.delete.response
- #chatusers
Accepts the following message:
ChatUsersDeleteResponse
allOf
uid: ChatUsersDeleteResponsePayload
object
command
string
status
number
Allowed values:
200
404
500
Additional properties are allowed.
object
array<integer>
Items:
integer
Additional properties are allowed.
Examples
{ "command": "string", "status": 200, "usersId": [ 0 ] }

This example has been generated automatically.
PUB chatusers.insights
Ask for some analytics of ChatUsers

Operation IDchatusers.insights.request
- #chatusers
Accepts the following message:
ChatUsersInsightsRequest
allOf
uid: ChatUsersInsightsRequestPayload
object
startFrom
integer
Timestamp

endTo
integer
Timestamp

Additional properties are allowed.
object
all
boolean
If true it will request a total number of ChatUsers available in a defined time period

newChatUsers
boolean
If true it will request a number of new ChatUsers created in a defined time period

averageMessagesPerSession
boolean
If true it will request the average number of ChatUser messages per session in a defined time period

averageDurationSession
boolean
If true it will request the average duration of ChatUser session in a defined time period

Additional properties are allowed.
object
command
string
status
number
Allowed values:
200
404
500
Additional properties are allowed.
object
all
integer
Total number of ChatUsers until that period

newChatUsers
integer
Total number of new ChatUsers between the time period defined

averageMessagesPerSession
integer
Average Chatusers' messages per session in the defined time period

averageDurationSession
integer
Average Chatusers' duration session in the defined time period

Additional properties are allowed.
schemaFormat
application/vnd.aai.asyncapi;version=2.4.0
Examples
{ "startFrom": 0, "endTo": 0, "all": true, "newChatUsers": true, "averageMessagesPerSession": true, "averageDurationSession": true }

This example has been generated automatically.
SUB chatusers.insights
Return some analytics of ChatUsers

Operation IDchatusers.insights.response
- #chatusers
Accepts the following message:
ChatUsersInsightsResponse
allOf
uid: ChatUsersInsightsResponsePayload
object
command
string
status
number
Allowed values:
200
404
500
Additional properties are allowed.
object
all
integer
Total number of ChatUsers until that period

newChatUsers
integer
Total number of new ChatUsers between the time period defined

averageMessagesPerSession
integer
Average Chatusers' messages per session in the defined time period

averageDurationSession
integer
Average Chatusers' duration session in the defined time period

Additional properties are allowed.
Examples
{ "command": "string", "status": 200, "all": 0, "newChatUsers": 0, "averageMessagesPerSession": 0, "averageDurationSession": 0 }

This example has been generated automatically.
PUB chatusers.import
Send a CSV file to create new ChatUsers, already existing ChatUsers are gonna be updated.

Operation IDchat-users.import.request
- #chatusers
Accepts the following message:
ChatUsersImportRequest
object
uid: ChatUsersImportRequestPayload
file
string
format: binary
Binary data of the CSV file sent

Additional properties are allowed.
object
command
string
status
number
Allowed values:
200
404
500
Additional properties are allowed.
object
array<array<any>>
array<any>
Additional properties are allowed.
schemaFormat
application/vnd.aai.asyncapi;version=2.4.0
Examples
{ "file": "string" }

This example has been generated automatically.
SUB chatusers.import
Get operation status

Operation IDchat-users.import.response
- #chatusers
Accepts the following message:
ChatUsersImportResponse
allOf
uid: ChatUsersImportResponsePayload
object
command
string
status
number
Allowed values:
200
404
500
Additional properties are allowed.
object
array<array<any>>
array<any>
Additional properties are allowed.
Examples
{ "command": "string", "status": 200, "notInsertedUsers": [ [] ] }

This example has been generated automatically.
PUB chatusers.get-feedback
Get list of feedback leaved by ChatUsers during conversation

Operation IDchatusers.get-feedback.request
- #chatusers
- #feedback
Accepts the following message:
ChatUsersGetFeedbackListRequest
allOf
object
offset
integer
Default value:0
limit
integer
Max number of elements to extract

Default value:25
Additional properties are allowed.
object
startFrom
required
string
endTo
required
string
Additional properties are allowed.
object
command
string
status
number
Allowed values:
200
404
500
Additional properties are allowed.
object
array<object>
uid: Feedback
vote
integer
text
string
sessionId
string
It contains the Session Id where feedback was submitted. It's used to create a URL link to open the chat directly.

userId
integer
name
string
User's name

surname
string
User's surname

email
string
User's email

createdAt
string
Timestamp

updatedAt
string
Timestamp

Additional properties are allowed.
schemaFormat
application/vnd.aai.asyncapi;version=2.4.0
Examples
{ "offset": 0, "limit": 25, "startFrom": "string", "endTo": "string" }

This example has been generated automatically.
SUB chatusers.get-feedback
Operation IDchat-users.get-feedback.response
- #chatusers
- #feedback
Accepts the following message:
ChatUsersGetFeedbackListResponse
allOf
uid: ChatUsersGetFeedbackListResponsePayload
object
command
string
status
number
Allowed values:
200
404
500
Additional properties are allowed.
object
array<object>
uid: Feedback
vote
integer
text
string
sessionId
string
It contains the Session Id where feedback was submitted. It's used to create a URL link to open the chat directly.

userId
integer
name
string
User's name

surname
string
User's surname

email
string
User's email

createdAt
string
Timestamp

updatedAt
string
Timestamp

Additional properties are allowed.
Examples
{ "command": "string", "status": 200, "feedbacks": [ { "vote": 0, "text": "string", "sessionId": "string", "userId": 0, "name": "string", "surname": "string", "email": "string", "createdAt": "string", "updatedAt": "string" } ] }

This example has been generated automatically.
PUB chatusers.create-segment
Send a CSV file to create new ChatUsers, already existing ChatUsers are gonna be updated.

Operation IDchat-users.createSegment.request
- #chatusers
Accepts the following message:
ChatUsersCreateSegmentRequest
object
uid: ChatUsersCreateSegmentRequestPayload
name
string
The Segment name

array<object>
uid: SegmentFilter
List of filters applied that create the Segment structure

oneOf
Adheres to:
string
Or to:
integer
entity
string
type
string
Allowed values:
"variable"
"tag"
operator
string
Allowed values:
"is"
"is_not"
"has_any_value"
"contains"
"does_not_contain"
"begins_with"
"after"
"before"
"greater_than"
"less_than"
"greater_than_or_equal"
"less_than_or_equal"
Additional properties are allowed.
object
command
string
status
number
Allowed values:
200
404
500
Additional properties are allowed.
schemaFormat
application/vnd.aai.asyncapi;version=2.4.0
Examples
{ "name": "string", "filters": [ { "value": "string", "entity": "string", "type": "variable", "operator": "is" } ] }

This example has been generated automatically.
SUB chatusers.create-segment
Get operation status

Operation IDchat-users.createSegment.response
- #chatusers
Accepts the following message:
ChatUsersCreateSegmentResponse
allOf
uid: ChatUsersCreateSegmentResponsePayload
object
command
string
status
number
Allowed values:
200
404
500
Additional properties are allowed.
Examples
{ "command": "string", "status": 200 }

This example has been generated automatically.
PUB chatusers.remove-segment
Remove segment related to ChatUsers

Operation IDchat-users.removeSegment.request
- #chatusers
Accepts the following message:
<anonymous-message-17>
array<string>
Items:
string
Array of Segment ID to remove

object
command
string
status
number
Allowed values:
200
404
500
Additional properties are allowed.
array<any>
Array of Segment's ids

schemaFormat
application/vnd.aai.asyncapi;version=2.4.0
Examples
[ "string" ]

This example has been generated automatically.
SUB chatusers.remove-segment
Operation IDchat-users.removeSegment.response
- #chatusers
Accepts the following message:
<anonymous-message-18>
allOf
object
command
string
status
number
Allowed values:
200
404
500
Additional properties are allowed.
array<any>
Array of Segment's ids

Examples
[]

This example has been generated automatically.
PUB chatusers.edit-segment
Edit segment related to ChatUsers

Operation IDchat-users.editSegment.request
- #chatusers
Accepts the following message:
<anonymous-message-19>
object
id
required
string
Segment id

name
required
string
The new segment name

Additional properties are allowed.
object
command
string
status
number
Allowed values:
200
404
500
Additional properties are allowed.
schemaFormat
application/vnd.aai.asyncapi;version=2.4.0
Examples
{ "id": "string", "name": "string" }

This example has been generated automatically.
SUB chatusers.edit-segment
Operation IDchat-users.editSegment.response
- #chatusers
Accepts the following message:
<anonymous-message-20>
allOf
object
command
string
status
number
Allowed values:
200
404
500
Additional properties are allowed.
Examples
{ "command": "string", "status": 200 }

This example has been generated automatically.
PUB chatusers.get-bot-segments
Get Bot Segments' list related to ChatUsers

Operation IDchat-users.get-bot-segments.request
- #chatusers
- #segments
Accepts the following message:
ChatUsersGetBotSegmentsRequest
object
command
string
status
number
Allowed values:
200
404
500
Additional properties are allowed.
array<object>
uid: Segment
id
integer
name
string
array<object>
uid: SegmentFilter
oneOf
Adheres to:
string
Or to:
integer
entity
string
type
string
Allowed values:
"variable"
"tag"
operator
string
Allowed values:
"is"
"is_not"
"has_any_value"
"contains"
"does_not_contain"
"begins_with"
"after"
"before"
"greater_than"
"less_than"
"greater_than_or_equal"
"less_than_or_equal"
schemaFormat
application/vnd.aai.asyncapi;version=2.4.0
Examples
SUB chatusers.get-bot-segments
Operation IDchat-users.get-bot-segments.response
- #chatusers
Accepts the following message:
ChatUsersGetBotSegmentsResponse
allOf
uid: ChatUsersGetBotSegmentsResponsePayload
object
command
string
status
number
Allowed values:
200
404
500
Additional properties are allowed.
restricted any
array<object>
uid: Segment
id
integer
name
string
array<object>
uid: SegmentFilter
oneOf
Adheres to:
string
Or to:
integer
entity
string
type
string
Allowed values:
"variable"
"tag"
operator
string
Allowed values:
"is"
"is_not"
"has_any_value"
"contains"
"does_not_contain"
"begins_with"
"after"
"before"
"greater_than"
"less_than"
"greater_than_or_equal"
"less_than_or_equal"
Examples
{ "command": "string", "status": 200, "segments": [ { "id": 0, "name": "string", "filters": [ { "value": "string", "entity": "string", "type": "variable", "operator": "is" } ] } ] }

This example has been generated automatically.
PUB chatusers.get-bot-tags
Get Bot Tags' list related to ChatUsers

Operation IDchat-users.get-bot-tags.request
- #chatusers
- #tag
Accepts the following message:
ChatUsersGetBotTagsRequest
object
command
string
status
number
Allowed values:
200
404
500
Additional properties are allowed.
array<object>
uid: Tag
id
integer
name
string
schemaFormat
application/vnd.aai.asyncapi;version=2.4.0
Examples
SUB chatusers.get-bot-tags
Operation IDchat-users.get-tags.response
- #chatusers
Accepts the following message:
ChatUsersGetBotTagsResponse
allOf
uid: ChatUsersGetBotTagsResponsePayload
object
command
string
status
number
Allowed values:
200
404
500
Additional properties are allowed.
restricted any
array<object>
uid: Tag
id
integer
name
string
Examples
{ "command": "string", "status": 200, "tags": [ { "id": 0, "name": "string" } ] }

This example has been generated automatically.
PUB chatusers.add-tag
Add a Tag to a ChatUser

Operation IDchat-users.addTag.request
- #chatusers
Accepts the following message:
ChatUsersAddTagRequest
object
uid: ChatUsersAddTagRequestPayload
name
string
The Tag name to add

array<integer>
List of users id to add the tag

Items:
integer
Additional properties are allowed.
object
command
string
status
number
Allowed values:
200
404
500
Additional properties are allowed.
schemaFormat
application/vnd.aai.asyncapi;version=2.4.0
Examples
{ "name": "string", "usersId": [ 0 ] }

This example has been generated automatically.
SUB chatusers.add-tag
addTag response method

Operation IDchat-users.addTag.response
- #chatusers
Accepts the following message:
ChatUsersAddTagResponse
allOf
uid: ChatUsersAddTagResponsePayload
object
command
string
status
number
Allowed values:
200
404
500
Additional properties are allowed.
Examples
{ "command": "string", "status": 200 }

This example has been generated automatically.
PUB chatusers.remove-tag
Remove a Tag from a list of ChatUsers

Operation IDchat-users.removeTag.request
- #chatusers
Accepts the following message:
ChatUsersRemoveTagRequest
object
uid: ChatUsersRemoveElementRequestPayload
name
string
The Element name to add

array<integer>
List of users id affected

Items:
integer
deleteAll
boolean
if true, delete all the users with the given tag name

Additional properties are allowed.
object
command
string
status
number
Allowed values:
200
404
500
Additional properties are allowed.
schemaFormat
application/vnd.aai.asyncapi;version=2.4.0
Examples
{ "name": "string", "usersId": [ 0 ], "deleteAll": true }

This example has been generated automatically.
SUB chatusers.remove-tag
removeTag response method

Operation IDchat-users.removeTag.response
- #chatusers
Accepts the following message:
ChatUsersRemoveTagResponse
allOf
uid: ChatUsersRemoveTagResponsePayload
object
command
string
status
number
Allowed values:
200
404
500
Additional properties are allowed.
Examples
{ "command": "string", "status": 200 }

This example has been generated automatically.
PUB chatusers.get-vars
Send messages to the API

Operation IDchatusers.get-vars.request
- #chatusers
Accepts the following message:
ChatUsersGetVarsRequest
Ask variables assigned to a Chat User
Client can ask to the server the list of pair name-value variables assigned to a Chat User

object
uid: ChatUsersGetVarsRequestPayload
userId
integer
Additional properties are allowed.
summary
Return variables assigned to a Chat User
object
uid: ChatUsersGetVarsResponsePayload
array<object>
uid: Variable
oneOf
Adheres to:
string
Or to:
integer
name
string
type
string
Additional properties are allowed.
schemaFormat
application/vnd.aai.asyncapi;version=2.4.0
Examples
{ "userId": 0 }

This example has been generated automatically.
SUB chatusers.get-vars
Messages that you receive from the API

Operation IDchatusers.get-vars.response
- #chatusers
Accepts the following message:
ChatUsersGetVarsResponse
Return variables assigned to a Chat User
object
uid: ChatUsersGetVarsResponsePayload
array<object>
uid: Variable
oneOf
Adheres to:
string
Or to:
integer
name
string
type
string
Additional properties are allowed.
Examples
{ "variables": [ { "value": "string", "name": "string", "type": "string" } ] }

This example has been generated automatically.
PUB chatusers.set-variable
Add a Variable to a ChatUser

Operation IDchat-users.set-variable.request
- #chatusers
Accepts the following message:
ChatUsersSetVariableRequest
object
uid: ChatUsersSetVariableRequestPayload
When is passed a variable_id an update will occur. If the variable object is passed a new variable will be created.

object
name
required
string
The Variable name to add

value
required
string
The Variable value

type
required
string
The Variable type. Default is "text"

Allowed values:
"text"
"number"
"date"
Additional properties are allowed.
required
array<number>
Array of Users' id to update a variable

Items:
number
Additional properties are allowed.
object
command
string
status
number
Allowed values:
200
404
500
Additional properties are allowed.
schemaFormat
application/vnd.aai.asyncapi;version=2.4.0
Examples
{ "variable": { "name": "string", "value": "string", "type": "text" }, "usersId": [ 0 ] }

This example has been generated automatically.
SUB chatusers.set-variable
Operation IDchat-users.set-variable.response
- #chatusers
Accepts the following message:
ChatUsersSetVariableResponse
allOf
uid: ChatUsersSetVariableResponsePayload
object
command
string
status
number
Allowed values:
200
404
500
Additional properties are allowed.
Examples
{ "command": "string", "status": 200 }

This example has been generated automatically.
PUB chatusers.remove-variable
Remove a Variable from a ChatUsers

Operation IDchat-users.removeVariable.request
- #chatusers
Accepts the following message:
<anonymous-message-33>
object
name
string
The Variable name to remove

usersId
number
The array of Users from where the variable will be removed

Additional properties are allowed.
object
command
string
status
number
Allowed values:
200
404
500
Additional properties are allowed.
schemaFormat
application/vnd.aai.asyncapi;version=2.4.0
Examples
{ "name": "string", "usersId": 0 }

This example has been generated automatically.
SUB chatusers.remove-variable
removeVariable response method

Operation IDchat-users.removeVariable.response
- #chatusers
Accepts the following message:
<anonymous-message-34>
allOf
object
command
string
status
number
Allowed values:
200
404
500
Additional properties are allowed.
Examples
{ "command": "string", "status": 200 }

This example has been generated automatically.
PUB sitekey.undefined.[bot-argument]
Send messages to the API

Operation IDsitekey.undefined.request
- #sitekey
- #login
Accepts the following message:
SitekeyUndefinedRequest
Start the communication with Userbot
This command is used to start the communication with Userbot. Example is "sitekey undefined bbfad81389103ba06485d07bfedb4036"

object
uid: SitekeyUndefinedRequestPayload
no payload is sent with this command at all

Additional properties are allowed.
name
sitekey
name
login
summary
Validates sitekey
object
uid: SitekeyUndefinedResponsePayload
command
string
Default value:"sitekey"
text
string
Describes the validation status of the key

status
integer
Total status code of the request

Examples values:
200
404
500
object
object
alert50
boolean
alert80
boolean
limitReached
boolean
type
string
Examples values:
"fair-use"
Additional properties are allowed.
Additional properties are allowed.
object
unique
integer
limit
integer
Additional properties are allowed.
object
Information about the customer

nome
string
Customer name

base_mail
string
Customer email

chats_start_interval
integer
chats_end_interval
integer
chat_limits
integer
ownerUserId
integer
User ID of the account owner

agentsLimit
integer
Limit of the agents that the customer can have

activeAgents
integer
Number of the active agents

Additional properties are allowed.
object
array<object>
The botID is the id of the bot

id
integer
Plugin ID

name
string
Plugin name

Examples values:
"obfuscate"
bot_id
integer
Bot ID

backend
boolean
dashboard
boolean
widgetchat
boolean
object
key
string
projectId
string
Additional properties are allowed.
Additional properties are allowed.
dashboard_token
string
Additional properties are allowed.
schemaFormat
application/vnd.aai.asyncapi;version=2.4.0
#sitekey
#login
Examples
{}

This example has been generated automatically.
SUB sitekey.undefined.[bot-argument]
Messages that you receive from the API

Operation IDsitekey.undefined.response
- #sitekey
- #login
Accepts the following message:
SitekeyUndefinedResponse
Validates sitekey
object
uid: SitekeyUndefinedResponsePayload
command
string
Default value:"sitekey"
text
string
Describes the validation status of the key

status
integer
Total status code of the request

Examples values:
200
404
500
object
object
alert50
boolean
alert80
boolean
limitReached
boolean
type
string
Examples values:
"fair-use"
Additional properties are allowed.
Additional properties are allowed.
object
unique
integer
limit
integer
Additional properties are allowed.
object
Information about the customer

nome
string
Customer name

base_mail
string
Customer email

chats_start_interval
integer
chats_end_interval
integer
chat_limits
integer
ownerUserId
integer
User ID of the account owner

agentsLimit
integer
Limit of the agents that the customer can have

activeAgents
integer
Number of the active agents

Additional properties are allowed.
object
array<object>
The botID is the id of the bot

id
integer
Plugin ID

name
string
Plugin name

Examples values:
"obfuscate"
bot_id
integer
Bot ID

backend
boolean
dashboard
boolean
widgetchat
boolean
object
key
string
projectId
string
Additional properties are allowed.
Additional properties are allowed.
dashboard_token
string
Additional properties are allowed.
#sitekey
#login
Examples
{ "command": "sitekey", "text": "string", "status": 200, "chatLimitReport": { "alerts": { "alert50": true, "alert80": true, "limitReached": true, "type": "fair-use" } }, "sessions": { "unique": 0, "limit": 0 }, "customer": { "nome": "string", "base_mail": "string", "chats_start_interval": 0, "chats_end_interval": 0, "chat_limits": 0, "ownerUserId": 0, "agentsLimit": 0, "activeAgents": 0 }, "plugins": { "botID": [ { "id": 0, "name": "obfuscate", "bot_id": 0, "backend": true, "dashboard": true, "widgetchat": true, "parameters": { "key": "string", "projectId": "string" } } ] }, "dashboard_token": "string" }

This example has been generated automatically.
PUB apiLogin.[apikey]
A special login to Userbot that allows to use APIs

Operation IDapiLogin.apikey.request
- #apiLogin
- #login
Accepts the following message:
ApiLoginApikeyRequest
Send the login request to Userbot
This command is used to authenticate the user with Userbot. Example is "apiLogin 123456789wasd"

object
uid: ApiLoginApikeyRequestPayload
No payload is sent with this command

Additional properties are allowed.
name
apiLogin
name
login
summary
Authenticate
object
uid: ApiLoginApikeyResponsePayload
text
string
Default value:"apiKey setted"
object
command
string
Default value:"apiLogin"
text
string
status
integer
Allowed values:
200
404
500
Additional properties are allowed.
Additional properties are allowed.
schemaFormat
application/vnd.aai.asyncapi;version=2.4.0
#apiLogin
#login
Examples
{}

This example has been generated automatically.
SUB apiLogin.[apikey]
Messages that you receive from the API

Operation IDapiLogin.apikey.response
- #apiLogin
- #login
Accepts the following message:
ApiLoginApikeyResponse
Authenticate
object
uid: ApiLoginApikeyResponsePayload
text
string
Default value:"apiKey setted"
object
command
string
Default value:"apiLogin"
text
string
status
integer
Allowed values:
200
404
500
Additional properties are allowed.
Additional properties are allowed.
#apiLogin
#login
Examples
{ "text": "apiKey setted", "structure": { "command": "apiLogin", "text": "apiKey setted", "status": 200 } }

This example has been generated automatically.
PUB bot.stats
Get Bot stats

Operation IDbot.stats.request
- #bot
Accepts the following message:
BotStatsRequest
Get bot stats
This command is used to get bot stats

object
uid: BotStatsRequestPayload
type
string
Default value:"all"
Additional properties are allowed.
name
bot
summary
Sends all the stats for the bots of the user
object
uid: BotStatsResponsePayload
command
string
subcommand
string
text
string
status
integer
Allowed values:
200
401
500
object
array<any>
Items:
any
Additional properties are allowed.
Additional properties are allowed.
schemaFormat
application/vnd.aai.asyncapi;version=2.4.0
#bot
Examples
{ "type": "all" }

This example has been generated automatically.
SUB bot.stats
Operation IDbot.stats.response
- #bot
Accepts the following message:
BotStatsResponse
Sends all the stats for the bots of the user
object
uid: BotStatsResponsePayload
command
string
subcommand
string
text
string
status
integer
Allowed values:
200
401
500
object
array<any>
Items:
any
Additional properties are allowed.
Additional properties are allowed.
#bot
Examples
{ "command": "string", "subcommand": "string", "text": "string", "status": 200, "data": { "stats": [ null ] } }

This example has been generated automatically.
PUB who
Send messages to the API

Operation IDwho.request
- #chat
Accepts the following message:
WhoRequest
Ask data about the logged user
This command is used to get information about the logged user, in particular the user.id is needed to use chat commands (robin)

Payload
string
uid: WhoRequestPayload
Default value:"who"
name
chat
summary
Returns information about the logged user
object
uid: WhoResponsePayload
command
string
Default value:"who"
text
string
An information about the user

Examples values:
"You are:user.username(display_username)"
object
username
string
customer_id
integer
userLevel
integer
object
id
integer
nickname
string
email
string
md5_email
string
phone
string
password
string
nome
string
cognome
string
birth
string
pic
string
points
integer
user_level
integer
customer_id
integer
newsletter
integer
hash
integer
last_session
integer
json_stats
string
notes
string
confirm
integer
created_user
string
Examples values:
"2021-01-12T17:03:08.000Z"
owner_name
string
autocreate
integer
group_id
integer
chat_user
boolean
Additional properties are allowed.
display_username
string
Examples values:
"Mario_Rossi"
key
string
The server_key of the bot

Additional properties are allowed.
object
array<object>
The botID is the id of the bot

id
integer
Plugin ID

name
string
Plugin name

Examples values:
"obfuscate"
bot_id
integer
Bot ID

backend
boolean
dashboard
boolean
widgetchat
boolean
object
key
string
projectId
string
Additional properties are allowed.
Additional properties are allowed.
dashboard_token
string
Additional properties are allowed.
schemaFormat
application/vnd.aai.asyncapi;version=2.4.0
#chat
Examples
who

This example has been generated automatically.

SUB who

Messages that you receive from the API

Operation IDwho.response

#chat

Accepts the following message:

WhoResponse

Returns information about the logged user

object

uid: WhoResponsePayload

#chat

Examples

{
  "command": "who",
  "text": "You are:user.username(display_username)",
  "user": {
    "username": "string",
    "customer_id": 0,
    "userLevel": 0,
    "userData": {
      "id": 0,
      "nickname": "string",
      "email": "string",
      "md5_email": "string",
      "phone": "string",
      "password": "string",
      "nome": "string",
      "cognome": "string",
      "birth": "string",
      "pic": "string",
      "points": 0,
      "user_level": 0,
      "customer_id": 0,
      "newsletter": 0,
      "hash": 0,
      "last_session": 0,
      "json_stats": "string",
      "notes": "string",
      "confirm": 0,
      "created_user": "2021-01-12T17:03:08.000Z",
      "owner_name": "string",
      "autocreate": 0,
      "group_id": 0,
      "chat_user": true
    },
    "display_username": "Mario_Rossi",
    "key": "string"
  },
  "plugins": {
    "botID": [
      {
        "id": 0,
        "name": "obfuscate",
        "bot_id": 0,
        "backend": true,
        "dashboard": true,
        "widgetchat": true,
        "parameters": {
          "key": "string",
          "projectId": "string"
        }
      }
    ]
  },
  "dashboard_token": "string"
}

This example has been generated automatically.

PUB robin.sv.[user.id].get.sessions.[limit].[offset]
Send messages to the API

Operation IDrobin.sv.[user.id].get.sessions.[limit].[offset].request
- #chat
Accepts the following message:
RobinSvGetSessionsRequest
Ask data about chats
This command returns the information about the chats on a bot

Payload
string
uid: RobinSvGetSessionsRequestPayload
The [user.id] is the value that can be get by the command who. Limit and offset (integers) are used to limit the amount of chat sessions to be returned.

Default value:"robin sv [user.id] get sessions [limit] [offset]"
name
chat
summary
Returns information about chats
object
uid: RobinSvGetSessionsResponsePayload
command
string
Default value:"robin"
subcommand
string
Default value:"get"
region
string
Default value:"sessions"
subject
string
Default value:"op"
status
integer
Examples values:
"200"
"404"
"500"
array<object>
robin_email
string
counter
integer
id
integer
quando
string
test_chat
boolean
bot_id
integer
user
string
userid
integer
chat
integer
muted
boolean
vision
integer
wspath
string
client_number
integer
last_status
integer
breaked
string
ticket_status
string
ticket_assigned
string
robin_op
integer
json_trace
string
last_message
string
source
string
last_payload
string
vars
string
last_chat_text
string
last_chat_username
string
user_id
integer
nickname
string
email
string
phone
string
nome
string
cognome
string
birth
string
pic
string
customer_id
integer
last_session
string
json_stats
string
notes
string
object
online
integer
away
integer
deposit
integer
total
integer
notifications
integer
array<any>
array<any>
array<any>
Additional properties are allowed.
object
array<object>
The botID is the id of the bot

id
integer
Plugin ID

name
string
Plugin name

Examples values:
"obfuscate"
bot_id
integer
Bot ID

backend
boolean
dashboard
boolean
widgetchat
boolean
object
key
string
projectId
string
Additional properties are allowed.
Additional properties are allowed.
dashboard_token
string
Additional properties are allowed.
schemaFormat
application/vnd.aai.asyncapi;version=2.4.0
#chat
Examples
robin sv [user.id] get sessions [limit] [offset]

This example has been generated automatically.

SUB robin.sv.[user.id].get.sessions.[limit].[offset]

Messages that you receive from the API

Operation IDrobin.sv.[user.id].get.sessions.[limit].[offset].response

#chat

Accepts the following message:

RobinSvGetSessionsResponse

Returns information about chats

object

uid: RobinSvGetSessionsResponsePayload

#chat

Examples

{
  "command": "robin",
  "subcommand": "get",
  "region": "sessions",
  "subject": "op",
  "status": "200",
  "sessions": [
    {
      "robin_email": "string",
      "counter": 0,
      "id": 0,
      "quando": "string",
      "test_chat": true,
      "bot_id": 0,
      "user": "string",
      "userid": 0,
      "chat": 0,
      "muted": true,
      "vision": 0,
      "wspath": "string",
      "client_number": 0,
      "last_status": 0,
      "breaked": "string",
      "ticket_status": "string",
      "ticket_assigned": "string",
      "robin_op": 0,
      "json_trace": "string",
      "last_message": "string",
      "source": "string",
      "last_payload": "string",
      "vars": "string",
      "last_chat_text": "string",
      "last_chat_username": "string",
      "user_id": 0,
      "nickname": "string",
      "email": "string",
      "phone": "string",
      "nome": "string",
      "cognome": "string",
      "birth": "string",
      "pic": "string",
      "customer_id": 0,
      "last_session": "string",
      "json_stats": "string",
      "notes": "string"
    }
  ],
  "robinStats": {
    "online": 0,
    "away": 0,
    "deposit": 0,
    "total": 0,
    "notifications": 0,
    "onlineOps": [],
    "awayOps": [],
    "deposit_sessions": []
  },
  "plugins": {
    "botID": [
      {
        "id": 0,
        "name": "obfuscate",
        "bot_id": 0,
        "backend": true,
        "dashboard": true,
        "widgetchat": true,
        "parameters": {
          "key": "string",
          "projectId": "string"
        }
      }
    ]
  },
  "dashboard_token": "string"
}

This example has been generated automatically.

PUB robin.sv.[userid].get.[session.id]
Send messages to the API

Operation IDrobin.sv.[userid].get.[session.id].request
- #chat
Accepts the following message:
RobinSvGetSessionRequest
Ask data about a single chat by session id
This command returns the information about the single chat identified by session.id

Payload
string
uid: RobinSvGetSessionRequestPayload
The [user.id] is the value that can be get by the command who. The [session.id] is obtained by robin.sv.[user.id].get.sessions.[limit].[offset] command

Default value:"robin sv [user.id] get [session.id]"
name
chat
summary
Returns information about a single chat, identified by session.id
object
uid: RobinSvGetSessionResponsePayload
command
string
Default value:"robin"
subcommand
string
Default value:"get"
region
string
Default value:"session.id"
subject
string
Default value:"op"
status
integer
Examples values:
"200"
"404"
"500"
array<object>
id
integer
bot_id
integer
session
integer
message_uuid
string
userid
integer
username
string
chat
string
qea_id
integer
status
integer
quando_chat
string
Examples values:
"2022-05-19T09:24:25.000Z"
sentiment
string
hbo
string
Examples values:
"h"
"b"
"o"
kpi_processed
boolean
like_dislike
integer
thumbs
integer
ai_score
integer
robin_op
integer
ticket_assigned
string
robin_email
string
canBeTrained
boolean
object
online
integer
away
integer
deposit
integer
total
integer
notifications
integer
array<any>
array<any>
array<any>
Additional properties are allowed.
source
string
Examples values:
"webchat"
"facebook"
source_urlweb
string
Examples values:
"http://127.0.0.1:5500/index-1634.html"
object
array<object>
The botID is the id of the bot

id
integer
Plugin ID

name
string
Plugin name

Examples values:
"obfuscate"
bot_id
integer
Bot ID

backend
boolean
dashboard
boolean
widgetchat
boolean
object
key
string
projectId
string
Additional properties are allowed.
Additional properties are allowed.
dashboard_token
string
Additional properties are allowed.
schemaFormat
application/vnd.aai.asyncapi;version=2.4.0
#chat
Examples
robin sv [user.id] get [session.id]

This example has been generated automatically.
SUB robin.sv.[userid].get.[session.id]
Messages that you receive from the API

Operation IDrobin.sv.[userid].get.[session.id].response
- #chat
Accepts the following message:
RobinSvGetSessionResponse
Returns information about a single chat, identified by session.id
object
uid: RobinSvGetSessionResponsePayload
command
string
Default value:"robin"
subcommand
string
Default value:"get"
region
string
Default value:"session.id"
subject
string
Default value:"op"
status
integer
Examples values:
"200"
"404"
"500"
array<object>
id
integer
bot_id
integer
session
integer
message_uuid
string
userid
integer
username
string
chat
string
qea_id
integer
status
integer
quando_chat
string
Examples values:
"2022-05-19T09:24:25.000Z"
sentiment
string
hbo
string
Examples values:
"h"
"b"
"o"
kpi_processed
boolean
like_dislike
integer
thumbs
integer
ai_score
integer
robin_op
integer
ticket_assigned
string
robin_email
string
canBeTrained
boolean
object
online
integer
away
integer
deposit
integer
total
integer
notifications
integer
array<any>
array<any>
array<any>
Additional properties are allowed.
source
string
Examples values:
"webchat"
"facebook"
source_urlweb
string
Examples values:
"http://127.0.0.1:5500/index-1634.html"
object
array<object>
The botID is the id of the bot

id
integer
Plugin ID

name
string
Plugin name

Examples values:
"obfuscate"
bot_id
integer
Bot ID

backend
boolean
dashboard
boolean
widgetchat
boolean
object
key
string
projectId
string
Additional properties are allowed.
Additional properties are allowed.
dashboard_token
string
Additional properties are allowed.
#chat
Examples
{ "command": "robin", "subcommand": "get", "region": "session.id", "subject": "op", "status": "200", "sessions": [ { "id": 0, "bot_id": 0, "session": 0, "message_uuid": "string", "userid": 0, "username": "string", "chat": "string", "qea_id": 0, "status": 0, "quando_chat": "2022-05-19T09:24:25.000Z", "sentiment": "string", "hbo": "h", "kpi_processed": true, "like_dislike": 0, "thumbs": 0, "ai_score": 0, "robin_op": 0, "ticket_assigned": "string", "robin_email": "string", "canBeTrained": true } ], "robinStats": { "online": 0, "away": 0, "deposit": 0, "total": 0, "notifications": 0, "onlineOps": [], "awayOps": [], "deposit_sessions": [] }, "source": "webchat", "source_urlweb": "http://127.0.0.1:5500/index-1634.html", "plugins": { "botID": [ { "id": 0, "name": "obfuscate", "bot_id": 0, "backend": true, "dashboard": true, "widgetchat": true, "parameters": { "key": "string", "projectId": "string" } } ] }, "dashboard_token": "string" }

This example has been generated automatically.
PUB chat-assign-to-agent
Send messages to the API

Operation IDchat-assign-to-agent.request
- #chat
Accepts the following message:
ChatAssignToAgentRequest
Ask to assign a chat to an agent
This command returns the information about the single chat identified by session.id

object
uid: ChatAssignToAgentRequestPayload
Used to ask to assign a chat to an agent

session
integer
The id of the session to be assigned to the agent

agent
string
The agent email to which to assign the conversation

Examples values:
"agent-email@userbot.ai"
Additional properties are allowed.
name
chat
summary
Assigns the chat to an agent
object
uid: ChatAssignToAgentResponsePayload
command
string
Default value:"chat-assign-to-agent"
subcommand
string
Examples values:
"{"session":123456,"agent":"agent-email@userbot.ai"}"
text
string
Examples values:
"Assigned to "agent-email@userbot.ai""
status
integer
Examples values:
"200"
"404"
"500"
object
array<object>
The botID is the id of the bot

id
integer
Plugin ID

name
string
Plugin name

Examples values:
"obfuscate"
bot_id
integer
Bot ID

backend
boolean
dashboard
boolean
widgetchat
boolean
object
key
string
projectId
string
Additional properties are allowed.
Additional properties are allowed.
dashboard_token
string
Additional properties are allowed.
schemaFormat
application/vnd.aai.asyncapi;version=2.4.0
#chat
Examples
{ "session": 0, "agent": "agent-email@userbot.ai" }

This example has been generated automatically.
SUB chat-assign-to-agent
Messages that you receive from the API

Operation IDchat-assign-to-agent.response
- #chat
Accepts the following message:
ChatAssignToAgentResponse
Assigns the chat to an agent
object
uid: ChatAssignToAgentResponsePayload
command
string
Default value:"chat-assign-to-agent"
subcommand
string
Examples values:
"{"session":123456,"agent":"agent-email@userbot.ai"}"
text
string
Examples values:
"Assigned to "agent-email@userbot.ai""
status
integer
Examples values:
"200"
"404"
"500"
object
array<object>
The botID is the id of the bot

id
integer
Plugin ID

name
string
Plugin name

Examples values:
"obfuscate"
bot_id
integer
Bot ID

backend
boolean
dashboard
boolean
widgetchat
boolean
object
key
string
projectId
string
Additional properties are allowed.
Additional properties are allowed.
dashboard_token
string
Additional properties are allowed.
#chat
Examples
{ "command": "chat-assign-to-agent", "subcommand": "{\"session\":123456,\"agent\":\"agent-email@userbot.ai\"}", "text": "Assigned to \"agent-email@userbot.ai\"", "status": "200", "plugins": { "botID": [ { "id": 0, "name": "obfuscate", "bot_id": 0, "backend": true, "dashboard": true, "widgetchat": true, "parameters": { "key": "string", "projectId": "string" } } ] }, "dashboard_token": "string" }

This example has been generated automatically.
PUB chat-assign-to-bot
Send messages to the API

Operation IDchat-assign-to-bot.request
- #chat
Accepts the following message:
ChatAssignToBotRequest
Ask to assign a chat to the Bot
This command returns the information about the single chat identified by session.id

object
uid: ChatAssignToBotRequestPayload
Used to ask to assign a chat to the Bot

session
integer
The id of the session to be assigned to the Bot

Additional properties are allowed.
name
chat
summary
Assigns the chat to the Bot
object
uid: ChatAssignToBotResponsePayload
command
string
Default value:"chat-assign-to-bot"
subcommand
string
Examples values:
"{"session":123456}"
text
string
Examples values:
"Reassigned to bot"
status
integer
Examples values:
"200"
"404"
"500"
object
array<object>
The botID is the id of the bot

id
integer
Plugin ID

name
string
Plugin name

Examples values:
"obfuscate"
bot_id
integer
Bot ID

backend
boolean
dashboard
boolean
widgetchat
boolean
object
key
string
projectId
string
Additional properties are allowed.
Additional properties are allowed.
dashboard_token
string
Additional properties are allowed.
schemaFormat
application/vnd.aai.asyncapi;version=2.4.0
#chat
Examples
{ "session": 0 }

This example has been generated automatically.
SUB chat-assign-to-bot
Messages that you receive from the API

Operation IDchat-assign-to-bot.response
- #chat
Accepts the following message:
ChatAssignToBotResponse
Assigns the chat to the Bot
object
uid: ChatAssignToBotResponsePayload
command
string
Default value:"chat-assign-to-bot"
subcommand
string
Examples values:
"{"session":123456}"
text
string
Examples values:
"Reassigned to bot"
status
integer
Examples values:
"200"
"404"
"500"
object
array<object>
The botID is the id of the bot

id
integer
Plugin ID

name
string
Plugin name

Examples values:
"obfuscate"
bot_id
integer
Bot ID

backend
boolean
dashboard
boolean
widgetchat
boolean
object
key
string
projectId
string
Additional properties are allowed.
Additional properties are allowed.
dashboard_token
string
Additional properties are allowed.
#chat
Examples
{ "command": "chat-assign-to-bot", "subcommand": "{\"session\":123456}", "text": "Reassigned to bot", "status": "200", "plugins": { "botID": [ { "id": 0, "name": "obfuscate", "bot_id": 0, "backend": true, "dashboard": true, "widgetchat": true, "parameters": { "key": "string", "projectId": "string" } } ] }, "dashboard_token": "string" }

This example has been generated automatically.
PUB say.[wspath].[-100].[session.id].[chat_message]
Send messages to the API

Operation IDsay.[wspath].[-100].[session.id].[chat_message].request
- #chat
- #chat-notification
Accepts the following message:
SayRequest
Send a chat message by agent in the chat session with id [session.id]
The wspath is in the payload of robin.sv.[user.id].get.sessions

Payload
string
uid: SayRequestPayload
wspath can be get by robin.sv.[user.id].get.sessions. chat_message is the actual message that is sent in the chat

Default value:"say.[wspath].[-100].[session.id].[chat_message]"
name
chat
name
chat-notification
summary
Response is information about the current chat message
object
uid: SayResponsePayload
command
string
Default value:"chat-notification"
object
online
integer
away
integer
deposit
integer
total
integer
notifications
integer
array<any>
array<any>
array<any>
Additional properties are allowed.
notificationId
integer
object
id
integer
quando
string
test_chat
boolean
bot_id
integer
user
string
userid
integer
chat
integer
muted
boolean
This flag is used to mute the Bot, for example in particular cases when the conversation is given to an agent

vision
integer
wspath
string
This is used for the say command

client_number
integer
last_status
string
breaked
string
ticket_status
integer
ticket_assigned
string
robin_op
string
json_trace
string
last_message
string
source
string
last_payload
string
vars
string
isHumanMessage
boolean
humanMessage
string
counter
integer
Additional properties are allowed.
object
nfrom
integer
nto
integer
session_id
integer
bot_argument
string
customer_id
integer
user_id
integer
object
id
integer
bot_id
integer
session
integer
message_uuid
string
userid
integer
username
string
chat
string
qea_id
integer
status
integer
quando_chat
string
sentiment
string
hbo
string
kpi_processed
boolean
like_dislike
boolean
thumbs
boolean
ai_score
integer
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
schemaFormat
application/vnd.aai.asyncapi;version=2.4.0
#chat
#chat-notification
Examples
say.[wspath].[-100].[session.id].[chat_message]

This example has been generated automatically.

SUB say.[wspath].[-100].[session.id].[chat_message]

Messages that you receive from the API

Operation IDsay.[wspath].[-100].[session.id].[chat_message].response

#chat
#chat-notification

Accepts the following message:

SayResponse

Response is information about the current chat message

object

uid: SayResponsePayload

#chat
#chat-notification

Examples

{
  "command": "chat-notification",
  "robin_stats": {
    "online": 0,
    "away": 0,
    "deposit": 0,
    "total": 0,
    "notifications": 0,
    "onlineOps": [],
    "awayOps": [],
    "deposit_sessions": []
  },
  "notificationId": 0,
  "session": {
    "id": 0,
    "quando": "string",
    "test_chat": true,
    "bot_id": 0,
    "user": "string",
    "userid": 0,
    "chat": 0,
    "muted": true,
    "vision": 0,
    "wspath": "string",
    "client_number": 0,
    "last_status": "string",
    "breaked": "string",
    "ticket_status": 0,
    "ticket_assigned": "string",
    "robin_op": "string",
    "json_trace": "string",
    "last_message": "string",
    "source": "string",
    "last_payload": "string",
    "vars": "string",
    "isHumanMessage": true,
    "humanMessage": "string",
    "counter": 0
  },
  "data": {
    "nfrom": 0,
    "nto": 0,
    "session_id": 0,
    "bot_argument": "string",
    "customer_id": 0,
    "user_id": 0,
    "message": {
      "id": 0,
      "bot_id": 0,
      "session": 0,
      "message_uuid": "string",
      "userid": 0,
      "username": "string",
      "chat": "string",
      "qea_id": 0,
      "status": 0,
      "quando_chat": "string",
      "sentiment": "string",
      "hbo": "string",
      "kpi_processed": true,
      "like_dislike": true,
      "thumbs": true,
      "ai_score": 0
    }
  }
}

This example has been generated automatically.

PUB qeafilter.search.page-db-ai
Get list of interactions for the bot

Operation IDqeafilter.search.page-db-ai.request
- #qeafilter
Accepts the following message:
QeafilterSearchPageDbAiRequest
Get interactions
This command is used to get the list of interactions. qeafilter search {[payload]}

object
uid: QeafilterSearchPageDbAiRequestPayload
created_from_date
string
created_to_date
string
text
string
array<integer>
Items:
integer
2 is for confirmed and trained interactions, 1 is for the "to approve" interactions

Allowed values:
1
2
array<object>
name
string
Group name

counter
integer
The number of interactions in the group

selected
boolean
id
integer
ID of the group

limit_from
integer
limit_to
integer
Additional properties are allowed.
name
qeafilter
summary
Returns the information about the interactions
object
uid: QeafilterSearchPageDbAiResponsePayload
command
string
Default value:"qeafilter"
subcommand
string
Default value:"search"
token
string
Default value:"page-db-ai"
array<object>
ai
integer
Indicates if an interaction is trained

label
string
quando
integer
The time of creation of the interaction, timestamp

fallback
integer
flows_startingPoint
integer
array<object>
name
string
Group name

counter
integer
The number of interactions in the group

selected
boolean
id
integer
ID of the group

flows_id
integer
flows_step
boolean
flows_block_order
integer
flows_name
string
array<string>
Items:
string
It is the answer of the bot to the interaction. Buttons is sent in case the request contains buttons keyword

Examples values:
"bot answer {\"buttons\":[{\"key\":\"button-id-80\",\"title\":\"Click\",\"action\":\"text\",\"content\":\"Clicked\",\"dirty\":true}]}"
topics_text
string
topics_log
boolean
intent
string
ai_1_pending
integer
Counts the amount of pending so not yet trained interactions

ai_1_trained
integer
Counts the total trained interactions

count
integer
countFiltered
integer
object
array<object>
The botID is the id of the bot

id
integer
Plugin ID

name
string
Plugin name

Examples values:
"obfuscate"
bot_id
integer
Bot ID

backend
boolean
dashboard
boolean
widgetchat
boolean
object
key
string
projectId
string
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
schemaFormat
application/vnd.aai.asyncapi;version=2.4.0
#qeafilter
Examples
{ "created_from_date": "string", "created_to_date": "string", "text": "string", "ai": [ 1 ], "groups": [ { "name": "string", "counter": 0, "selected": true, "id": 0 } ], "limit_from": 0, "limit_to": 0 }

This example has been generated automatically.
SUB qeafilter.search.page-db-ai
Operation IDqeafilter.search.page-db-ai.response
- #qeafilter
Accepts the following message:
QeafilterSearchPageDbAiResponse
Returns the information about the interactions
object
uid: QeafilterSearchPageDbAiResponsePayload
command
string
Default value:"qeafilter"
subcommand
string
Default value:"search"
token
string
Default value:"page-db-ai"
array<object>
ai
integer
Indicates if an interaction is trained

label
string
quando
integer
The time of creation of the interaction, timestamp

fallback
integer
flows_startingPoint
integer
array<object>
name
string
Group name

counter
integer
The number of interactions in the group

selected
boolean
id
integer
ID of the group

flows_id
integer
flows_step
boolean
flows_block_order
integer
flows_name
string
array<string>
Items:
string
It is the answer of the bot to the interaction. Buttons is sent in case the request contains buttons keyword

Examples values:
"bot answer {\"buttons\":[{\"key\":\"button-id-80\",\"title\":\"Click\",\"action\":\"text\",\"content\":\"Clicked\",\"dirty\":true}]}"
topics_text
string
topics_log
boolean
intent
string
ai_1_pending
integer
Counts the amount of pending so not yet trained interactions

ai_1_trained
integer
Counts the total trained interactions

count
integer
countFiltered
integer
object
array<object>
The botID is the id of the bot

id
integer
Plugin ID

name
string
Plugin name

Examples values:
"obfuscate"
bot_id
integer
Bot ID

backend
boolean
dashboard
boolean
widgetchat
boolean
object
key
string
projectId
string
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
#qeafilter
Examples
{ "command": "qeafilter", "subcommand": "search", "token": "page-db-ai", "result": [ { "ai": 0, "label": "string", "quando": 0, "fallback": 0, "flows_startingPoint": 0, "groups": [ { "name": "string", "counter": 0, "selected": true, "id": 0 } ], "flows_id": 0, "flows_step": true, "flows_block_order": 0, "flows_name": "string", "answer_nl": [ "bot answer {\\\"buttons\\\":[{\\\"key\\\":\\\"button-id-80\\\",\\\"title\\\":\\\"Click\\\",\\\"action\\\":\\\"text\\\",\\\"content\\\":\\\"Clicked\\\",\\\"dirty\\\":true}]}" ], "topics_text": "string", "topics_log": true, "intent": "string" } ], "ai_1_pending": 0, "ai_1_trained": 0, "count": 0, "countFiltered": 0, "plugins": { "botID": [ { "id": 0, "name": "obfuscate", "bot_id": 0, "backend": true, "dashboard": true, "widgetchat": true, "parameters": { "key": "string", "projectId": "string" } } ] } }

This example has been generated automatically.
PUB qeafilter.save
Save an interaction with a chosen label (name)

Operation IDqeafilter.save.request
- #qeafilter
Accepts the following message:
QeafilterSaveRequest
Save an interaction
This command is used to save an interaction

object
uid: QeafilterSaveRequestPayload
label
string
name
string
The name of the interaction

array<object>
name
string
Group name

counter
integer
The number of interactions in the group

selected
boolean
id
integer
ID of the group

array<object>
The user questions for the interaction

name
string
id
integer
deep_learning
boolean
array<object>
The Bot answer to the user questions

name
string
flows_id
integer
fallback-team
string
array<object>
key
string
Key of the button

title
string
The text on the button

action
string
The type of action the button computes. If you jump to interaction/flow, the action is "goto"; for url is "url", for text message is "text"

Examples values:
" "buttons": [ { "key": "button-id-41", "title": "link", "action": "url", "content": "https://userbot.ai", "dirty": true }], "buttons": [ { "action": "goto", "title": "Click", "key": "button-id-34", "content": "Ciao", "dirty": false, "label": "Greeting" }], "buttons": [ { "action": "goto", "title": "Click", "flows_id": 2409, "key": "button-id-34", "content": "Flusso di benvenuto", "dirty": false, "flows_startMessageLabel": "2409-operator1-0-0" }], "buttons": [ { "key": "button-id-41", "title": "click", "action": "text", "content": "ciaoo", "dirty": true }]"
content
string
The content of the button action

dirty
boolean
label
string
The label of the interaction where the button jumps. This is to be sent when creating a button that jumps to an interaction

flows_startMessageLabel
string
The identification of the flow operator where the button jumps. This is to be sent when creating a button that jumps to a flow operator

Additional properties are allowed.
name
qeafilter
summary
Returns the information about the interaction saved
object
uid: QeafilterSaveResponsePayload
command
string
Default value:"qeafilter"
subcommand
string
Default value:"save"
token
string
Default value:""
text
string
Default value:"qeafilter command"
result
string
Examples values:
"OK"
insertedCount
integer
object
ai
integer
Default value:2
label
string
quando
integer
A timestamp of the creation of the record

fallback
integer
flows_startingPoint
string
object
name
string
Group name

counter
integer
The number of interactions in the group

selected
boolean
id
integer
ID of the group

Additional properties are allowed.
flows_id
integer
flows_step
integer
flows_block_order
integer
flows_name
string
array<string>
Items:
string
It is the answer of the bot to the interaction. Buttons is sent in case the request contains buttons keyword

Examples values:
"bot answer {\"buttons\":[{\"key\":\"button-id-80\",\"title\":\"Click\",\"action\":\"text\",\"content\":\"Clicked\",\"dirty\":true}]}"
array<object>
id
integer
question_nl
string
the question of the interaction

deep_learning
boolean
A flag set to true if the interaction is of type "è simile a", set to false for "è esattamente", not present for "contiene le parole"

topics_text
string
topics_log
boolean
Additional properties are allowed.
array<integer>
Items:
integer
Contains the id of the qea record inserted

object
array<object>
The botID is the id of the bot

id
integer
Plugin ID

name
string
Plugin name

Examples values:
"obfuscate"
bot_id
integer
Bot ID

backend
boolean
dashboard
boolean
widgetchat
boolean
object
key
string
projectId
string
Additional properties are allowed.
Additional properties are allowed.
dashboard_token
string
Additional properties are allowed.
schemaFormat
application/vnd.aai.asyncapi;version=2.4.0
#qeafilter
Examples
{ "label": "string", "name": "string", "groups": [ { "name": "string", "counter": 0, "selected": true, "id": 0 } ], "questions": [ { "name": "string", "id": 0, "deep_learning": true } ], "answers": [ { "name": "string" } ], "flows_id": 0, "fallback-team": "string", "buttons": [ { "key": "string", "title": "string", "action": " \"buttons\": [ { \"key\": \"button-id-41\", \"title\": \"link\", \"action\": \"url\", \"content\": \"https://userbot.ai\", \"dirty\": true }], \"buttons\": [ { \"action\": \"goto\", \"title\": \"Click\", \"key\": \"button-id-34\", \"content\": \"Ciao\", \"dirty\": false, \"label\": \"Greeting\" }], \"buttons\": [ { \"action\": \"goto\", \"title\": \"Click\", \"flows_id\": 2409, \"key\": \"button-id-34\", \"content\": \"Flusso di benvenuto\", \"dirty\": false, \"flows_startMessageLabel\": \"2409-operator1-0-0\" }], \"buttons\": [ { \"key\": \"button-id-41\", \"title\": \"click\", \"action\": \"text\", \"content\": \"ciaoo\", \"dirty\": true }]", "content": "string", "dirty": true, "label": "string", "flows_startMessageLabel": "string" } ] }

This example has been generated automatically.
SUB qeafilter.save
Operation IDqeafilter.save.response
- #qeafilter
Accepts the following message:
QeafilterSaveResponse
Returns the information about the interaction saved
object
uid: QeafilterSaveResponsePayload
command
string
Default value:"qeafilter"
subcommand
string
Default value:"save"
token
string
Default value:""
text
string
Default value:"qeafilter command"
result
string
Examples values:
"OK"
insertedCount
integer
object
ai
integer
Default value:2
label
string
quando
integer
A timestamp of the creation of the record

fallback
integer
flows_startingPoint
string
object
name
string
Group name

counter
integer
The number of interactions in the group

selected
boolean
id
integer
ID of the group

Additional properties are allowed.
flows_id
integer
flows_step
integer
flows_block_order
integer
flows_name
string
array<string>
Items:
string
It is the answer of the bot to the interaction. Buttons is sent in case the request contains buttons keyword

Examples values:
"bot answer {\"buttons\":[{\"key\":\"button-id-80\",\"title\":\"Click\",\"action\":\"text\",\"content\":\"Clicked\",\"dirty\":true}]}"
array<object>
id
integer
question_nl
string
the question of the interaction

deep_learning
boolean
A flag set to true if the interaction is of type "è simile a", set to false for "è esattamente", not present for "contiene le parole"

topics_text
string
topics_log
boolean
Additional properties are allowed.
array<integer>
Items:
integer
Contains the id of the qea record inserted

object
array<object>
The botID is the id of the bot

id
integer
Plugin ID

name
string
Plugin name

Examples values:
"obfuscate"
bot_id
integer
Bot ID

backend
boolean
dashboard
boolean
widgetchat
boolean
object
key
string
projectId
string
Additional properties are allowed.
Additional properties are allowed.
dashboard_token
string
Additional properties are allowed.
#qeafilter
Examples
{ "command": "qeafilter", "subcommand": "save", "token": "", "text": "qeafilter command", "result": "OK", "insertedCount": 0, "insertedRecord": { "ai": 2, "label": "string", "quando": 0, "fallback": 0, "flows_startingPoint": "string", "groups": { "name": "string", "counter": 0, "selected": true, "id": 0 }, "flows_id": 0, "flows_step": 0, "flows_block_order": 0, "flows_name": "string", "answer_nl": [ "bot answer {\\\"buttons\\\":[{\\\"key\\\":\\\"button-id-80\\\",\\\"title\\\":\\\"Click\\\",\\\"action\\\":\\\"text\\\",\\\"content\\\":\\\"Clicked\\\",\\\"dirty\\\":true}]}" ], "records": [ { "id": 0, "question_nl": "string", "deep_learning": true } ], "topics_text": "string", "topics_log": true }, "engine-notify": [ 0 ], "plugins": { "botID": [ { "id": 0, "name": "obfuscate", "bot_id": 0, "backend": true, "dashboard": true, "widgetchat": true, "parameters": { "key": "string", "projectId": "string" } } ] }, "dashboard_token": "string" }

This example has been generated automatically.
PUB qeafilter.save.token
Update an interaction

Operation IDqeafilter.save.token.request
- #qeafilter
Accepts the following message:
QeafilterSaveTokenRequest
Update an interaction
This command is used to save an interaction. The token is the interaction label, it is sent between "<" and ">"

object
uid: QeafilterSaveTokenRequestPayload
label
string
name
string
The name of the interaction

array<object>
name
string
Group name

counter
integer
The number of interactions in the group

selected
boolean
id
integer
ID of the group

array<object>
The user questions for the interaction

name
string
id
integer
deep_learning
boolean
array<object>
The Bot answer to the user questions

name
string
flows_id
integer
flows_startMessageLabel
string
The identification of the flow operator where the button jumps. This is to be sent when creating a button that jumps to a flow operator

fallback-team
string
array<object>
key
string
Key of the button

title
string
The text on the button

action
string
The type of action the button computes. If you jump to interaction/flow, the action is "goto"; for url is "url", for text message is "text"

Examples values:
" "buttons": [ { "key": "button-id-41", "title": "link", "action": "url", "content": "https://userbot.ai", "dirty": true }], "buttons": [ { "action": "goto", "title": "Click", "key": "button-id-34", "content": "Ciao", "dirty": false, "label": "Greeting" }], "buttons": [ { "action": "goto", "title": "Click", "flows_id": 2409, "key": "button-id-34", "content": "Flusso di benvenuto", "dirty": false, "flows_startMessageLabel": "2409-operator1-0-0" }], "buttons": [ { "key": "button-id-41", "title": "click", "action": "text", "content": "ciaoo", "dirty": true }]"
content
string
The content of the button action

dirty
boolean
label
string
The label of the interaction where the button jumps. This is to be sent when creating a button that jumps to an interaction

flows_startMessageLabel
string
The identification of the flow operator where the button jumps. This is to be sent when creating a button that jumps to a flow operator

Additional properties are allowed.
name
qeafilter
summary
Returns the information about the interaction updated
object
uid: QeafilterSaveTokenResponsePayload
command
string
Default value:"qeafilter"
subcommand
string
Default value:"save"
token
string
Default value:"interactionName"
text
string
Default value:"qeafilter command"
result
string
Examples values:
"OK"
insertedCount
integer
object
ai
integer
Default value:2
label
string
quando
integer
A timestamp of the creation of the record

fallback
integer
flows_startingPoint
string
object
name
string
Group name

counter
integer
The number of interactions in the group

selected
boolean
id
integer
ID of the group

Additional properties are allowed.
flows_id
integer
flows_step
integer
flows_block_order
integer
flows_name
string
array<string>
Items:
string
It is the answer of the bot to the interaction. Buttons is sent in case the request contains buttons keyword

Examples values:
"bot answer {\"buttons\":[{\"key\":\"button-id-80\",\"title\":\"Click\",\"action\":\"text\",\"content\":\"Clicked\",\"dirty\":true}]}"
array<object>
id
integer
question_nl
string
the question of the interaction

deep_learning
boolean
A flag set to true if the interaction is of type "è simile a", set to false for "è esattamente", not present for "contiene le parole"

topics_text
string
topics_log
boolean
Additional properties are allowed.
array<integer>
Items:
integer
Contains the id of the qea record inserted

object
array<object>
The botID is the id of the bot

id
integer
Plugin ID

name
string
Plugin name

Examples values:
"obfuscate"
bot_id
integer
Bot ID

backend
boolean
dashboard
boolean
widgetchat
boolean
object
key
string
projectId
string
Additional properties are allowed.
Additional properties are allowed.
dashboard_token
string
Additional properties are allowed.
schemaFormat
application/vnd.aai.asyncapi;version=2.4.0
#qeafilter
Examples
{ "label": "string", "name": "string", "groups": [ { "name": "string", "counter": 0, "selected": true, "id": 0 } ], "questions": [ { "name": "string", "id": 0, "deep_learning": true } ], "answers": [ { "name": "string" } ], "flows_id": 0, "flows_startMessageLabel": "string", "fallback-team": "string", "buttons": [ { "key": "string", "title": "string", "action": " \"buttons\": [ { \"key\": \"button-id-41\", \"title\": \"link\", \"action\": \"url\", \"content\": \"https://userbot.ai\", \"dirty\": true }], \"buttons\": [ { \"action\": \"goto\", \"title\": \"Click\", \"key\": \"button-id-34\", \"content\": \"Ciao\", \"dirty\": false, \"label\": \"Greeting\" }], \"buttons\": [ { \"action\": \"goto\", \"title\": \"Click\", \"flows_id\": 2409, \"key\": \"button-id-34\", \"content\": \"Flusso di benvenuto\", \"dirty\": false, \"flows_startMessageLabel\": \"2409-operator1-0-0\" }], \"buttons\": [ { \"key\": \"button-id-41\", \"title\": \"click\", \"action\": \"text\", \"content\": \"ciaoo\", \"dirty\": true }]", "content": "string", "dirty": true, "label": "string", "flows_startMessageLabel": "string" } ] }

This example has been generated automatically.
SUB qeafilter.save.token
Operation IDqeafilter.save.token.response
- #qeafilter
Accepts the following message:
QeafilterSaveTokenResponse
Returns the information about the interaction updated
object
uid: QeafilterSaveTokenResponsePayload
command
string
Default value:"qeafilter"
subcommand
string
Default value:"save"
token
string
Default value:"interactionName"
text
string
Default value:"qeafilter command"
result
string
Examples values:
"OK"
insertedCount
integer
object
ai
integer
Default value:2
label
string
quando
integer
A timestamp of the creation of the record

fallback
integer
flows_startingPoint
string
object
name
string
Group name

counter
integer
The number of interactions in the group

selected
boolean
id
integer
ID of the group

Additional properties are allowed.
flows_id
integer
flows_step
integer
flows_block_order
integer
flows_name
string
array<string>
Items:
string
It is the answer of the bot to the interaction. Buttons is sent in case the request contains buttons keyword

Examples values:
"bot answer {\"buttons\":[{\"key\":\"button-id-80\",\"title\":\"Click\",\"action\":\"text\",\"content\":\"Clicked\",\"dirty\":true}]}"
array<object>
id
integer
question_nl
string
the question of the interaction

deep_learning
boolean
A flag set to true if the interaction is of type "è simile a", set to false for "è esattamente", not present for "contiene le parole"

topics_text
string
topics_log
boolean
Additional properties are allowed.
array<integer>
Items:
integer
Contains the id of the qea record inserted

object
array<object>
The botID is the id of the bot

id
integer
Plugin ID

name
string
Plugin name

Examples values:
"obfuscate"
bot_id
integer
Bot ID

backend
boolean
dashboard
boolean
widgetchat
boolean
object
key
string
projectId
string
Additional properties are allowed.
Additional properties are allowed.
dashboard_token
string
Additional properties are allowed.
#qeafilter
Examples
{ "command": "qeafilter", "subcommand": "save", "token": "interactionName", "text": "qeafilter command", "result": "OK", "insertedCount": 0, "insertedRecord": { "ai": 2, "label": "string", "quando": 0, "fallback": 0, "flows_startingPoint": "string", "groups": { "name": "string", "counter": 0, "selected": true, "id": 0 }, "flows_id": 0, "flows_step": 0, "flows_block_order": 0, "flows_name": "string", "answer_nl": [ "bot answer {\\\"buttons\\\":[{\\\"key\\\":\\\"button-id-80\\\",\\\"title\\\":\\\"Click\\\",\\\"action\\\":\\\"text\\\",\\\"content\\\":\\\"Clicked\\\",\\\"dirty\\\":true}]}" ], "records": [ { "id": 0, "question_nl": "string", "deep_learning": true } ], "topics_text": "string", "topics_log": true }, "engine-notify": [ 0 ], "plugins": { "botID": [ { "id": 0, "name": "obfuscate", "bot_id": 0, "backend": true, "dashboard": true, "widgetchat": true, "parameters": { "key": "string", "projectId": "string" } } ] }, "dashboard_token": "string" }

This example has been generated automatically.
PUB qeafilter.delete
Delete an interaction

Operation IDqeafilter.delete.request
- #qeafilter
Accepts the following message:
QeafilterDeleteRequest
Delete an interaction
This command is used to delete an existing interaction

object
uid: QeafilterDeleteRequestPayload
array<string>
Items:
string
interaction label to be deleted, if a bulk action is performed, all the interaction labels to be deleted are inserted in this array

Examples values:
"interactionLabel"
Additional properties are allowed.
name
qeafilter
summary
Returns the information about the interaction deleted and the status of the operation
object
uid: QeafilterDeleteResponsePayload
command
string
Default value:"qeafilter"
subcommand
string
Default value:"delete"
token
string
Default value:null
text
string
Default value:"qeafilter command"
result
string
Examples values:
"success"
array<string>
Items:
string
The interaction labels to be deleted

bulk
boolean
True if more than one interaction needs to be deleted

object
array<object>
The botID is the id of the bot

id
integer
Plugin ID

name
string
Plugin name

Examples values:
"obfuscate"
bot_id
integer
Bot ID

backend
boolean
dashboard
boolean
widgetchat
boolean
object
key
string
projectId
string
Additional properties are allowed.
Additional properties are allowed.
dashboard_token
string
Default value:null
Additional properties are allowed.
schemaFormat
application/vnd.aai.asyncapi;version=2.4.0
#qeafilter
Examples
{ "data": [ "interactionLabel" ] }

This example has been generated automatically.
SUB qeafilter.delete
Operation IDqeafilter.delete.response
- #qeafilter
Accepts the following message:
QeafilterDeleteResponse
Returns the information about the interaction deleted and the status of the operation
object
uid: QeafilterDeleteResponsePayload
command
string
Default value:"qeafilter"
subcommand
string
Default value:"delete"
token
string
Default value:null
text
string
Default value:"qeafilter command"
result
string
Examples values:
"success"
array<string>
Items:
string
The interaction labels to be deleted

bulk
boolean
True if more than one interaction needs to be deleted

object
array<object>
The botID is the id of the bot

id
integer
Plugin ID

name
string
Plugin name

Examples values:
"obfuscate"
bot_id
integer
Bot ID

backend
boolean
dashboard
boolean
widgetchat
boolean
object
key
string
projectId
string
Additional properties are allowed.
Additional properties are allowed.
dashboard_token
string
Default value:null
Additional properties are allowed.
#qeafilter
Examples
{ "command": "qeafilter", "subcommand": "delete", "token": null, "text": "qeafilter command", "result": "success", "data": [ "string" ], "bulk": true, "plugins": { "botID": [ { "id": 0, "name": "obfuscate", "bot_id": 0, "backend": true, "dashboard": true, "widgetchat": true, "parameters": { "key": "string", "projectId": "string" } } ] }, "dashboard_token": null }

This example has been generated automatically.
PUB automated-messages.get
Ask list of automated messages created on the Bot

Operation IDautomated-messages.get.request
- #automated-messages
Accepts the following message:
AutomatedMessagesGetRequest
Ask a list of automated messages on a Bot
summary
List of automated messages on a Bot
object
uid: AutomatedMessagesGetResponsePayload
array<object>
id
integer
name
string
order
integer
object
uid: Answer
text
string
flows_id
integer
flows_step
string
created_at
integer
Timestamp

updated_at
integer
Timestamp

Additional properties are allowed.
array<object>
id
integer
entity
string
Allowed values:
"page_url"
"referrer"
"time_spent"
"site_visited_counter"
operator
string
Allowed values:
"is"
"is_not"
"has_any_value"
"contains"
"does_not_contain"
"greater_than"
"greater_than_or_equal"
oneOf
Adheres to:
string
Or to:
integer
Or to:
boolean
created_at
integer
Timestamp

updated_at
integer
Timestamp

created_at
integer
Timestamp

updated_at
integer
Timestamp

Additional properties are allowed.
schemaFormat
application/vnd.aai.asyncapi;version=2.4.0
Examples
SUB automated-messages.get
Retrieve list of automated messages from Bot

Operation IDautomated-messages.get.response
- #automated-messages
Accepts the following message:
AutomatedMessagesGetResponse
List of automated messages on a Bot
object
uid: AutomatedMessagesGetResponsePayload
array<object>
id
integer
name
string
order
integer
object
uid: Answer
text
string
flows_id
integer
flows_step
string
created_at
integer
Timestamp

updated_at
integer
Timestamp

Additional properties are allowed.
array<object>
id
integer
entity
string
Allowed values:
"page_url"
"referrer"
"time_spent"
"site_visited_counter"
operator
string
Allowed values:
"is"
"is_not"
"has_any_value"
"contains"
"does_not_contain"
"greater_than"
"greater_than_or_equal"
oneOf
Adheres to:
string
Or to:
integer
Or to:
boolean
created_at
integer
Timestamp

updated_at
integer
Timestamp

created_at
integer
Timestamp

updated_at
integer
Timestamp

Additional properties are allowed.
Examples
{ "messages": [ { "id": 0, "name": "string", "order": 0, "answer": { "text": "string", "flows_id": 0, "flows_step": "string", "created_at": 0, "updated_at": 0 }, "conditions": [ { "id": 0, "entity": "page_url", "operator": "is", "value": "string", "created_at": 0, "updated_at": 0 } ], "created_at": 0, "updated_at": 0 } ] }

This example has been generated automatically.
PUB automated-messages.delete
Request deletion of an Automated Message

Operation IDautomated-messages.delete.request
- #automated-messages
Accepts the following message:
AutomatedMessagesDeleteRequest
object
uid: AutomatedMessagesDeleteRequestPayload
required
array<integer>
List of Automated Messages' id to delete from database

Items:
integer
Additional properties are allowed.
object
command
string
status
number
Allowed values:
200
404
500
Additional properties are allowed.
object
array<integer>
Items:
integer
Additional properties are allowed.
schemaFormat
application/vnd.aai.asyncapi;version=2.4.0
Examples
{ "messagesId": [ 0 ] }

This example has been generated automatically.
SUB automated-messages.delete
Messages that you receive from the API when you delete one or more automated messages

Operation IDautomated-messages.delete.response
- #automated-messages
Accepts the following message:
AutomatedMessagesDeleteResponse
allOf
uid: AutomatedMessagesDeleteResponsePayload
object
command
string
status
number
Allowed values:
200
404
500
Additional properties are allowed.
object
array<integer>
Items:
integer
Additional properties are allowed.
Examples
{ "command": "string", "status": 200, "messagesId": [ 0 ] }

This example has been generated automatically.
PUB automated-messages.save
Save or update an Automated Message

Operation IDautomated-messages.save.request
- #automated-messages
Accepts the following message:
AutomatedMessagesSaveRequest
object
uid: AutomatedMessagesSaveRequestPayload
required
array<object>
name
required
string
order
required
integer
required
object
text
string
flows_id
integer
flows_step
string
Additional properties are allowed.
array<object>
entity
string
operator
string
value
string
Additional properties are allowed.
object
command
string
status
number
Allowed values:
200
404
500
Additional properties are allowed.
object
array<object>
id
integer
name
string
order
integer
object
uid: Answer
text
string
flows_id
integer
flows_step
string
created_at
integer
Timestamp

updated_at
integer
Timestamp

Additional properties are allowed.
array<object>
id
integer
entity
string
Allowed values:
"page_url"
"referrer"
"time_spent"
"site_visited_counter"
operator
string
Allowed values:
"is"
"is_not"
"has_any_value"
"contains"
"does_not_contain"
"greater_than"
"greater_than_or_equal"
oneOf
Adheres to:
string
Or to:
integer
Or to:
boolean
created_at
integer
Timestamp

updated_at
integer
Timestamp

created_at
integer
Timestamp

updated_at
integer
Timestamp

Additional properties are allowed.
schemaFormat
application/vnd.aai.asyncapi;version=2.4.0
Examples
{ "messages": [ { "name": "string", "order": 0, "answer": { "text": "string", "flows_id": 0, "flows_step": "string" }, "conditions": [ { "entity": "string", "operator": "string", "value": "string" } ] } ] }

This example has been generated automatically.
SUB automated-messages.save
Automated Message created or updated

Operation IDautomated-messages.save.response
- #automated-messages
Accepts the following message:
AutomatedMessagesSaveResponse
allOf
uid: AutomatedMessagesSaveResponsePayload
object
command
string
status
number
Allowed values:
200
404
500
Additional properties are allowed.
object
array<object>
id
integer
name
string
order
integer
object
uid: Answer
text
string
flows_id
integer
flows_step
string
created_at
integer
Timestamp

updated_at
integer
Timestamp

Additional properties are allowed.
array<object>
id
integer
entity
string
Allowed values:
"page_url"
"referrer"
"time_spent"
"site_visited_counter"
operator
string
Allowed values:
"is"
"is_not"
"has_any_value"
"contains"
"does_not_contain"
"greater_than"
"greater_than_or_equal"
oneOf
Adheres to:
string
Or to:
integer
Or to:
boolean
created_at
integer
Timestamp

updated_at
integer
Timestamp

created_at
integer
Timestamp

updated_at
integer
Timestamp

Additional properties are allowed.
Examples
{ "command": "string", "status": 200, "messages": [ { "id": 0, "name": "string", "order": 0, "answer": { "text": "string", "flows_id": 0, "flows_step": "string", "created_at": 0, "updated_at": 0 }, "conditions": [ { "id": 0, "entity": "page_url", "operator": "is", "value": "string", "created_at": 0, "updated_at": 0 } ], "created_at": 0, "updated_at": 0 } ] }

This example has been generated automatically.
PUB intel.leadlist
Request for all the stored leads

Operation IDintel.leadlist.request
- #intel
Accepts the following message:
SUB intel.leadlist
Obtain the list of all the leads that visited the site

Operation IDintel.leadlist.response
- #intel
Accepts the following message:
IntelLeadlistResponse
The List of leads
Carries an array of objects describing the lead companies that have visited the Userbot's customer site

array<object>
id
number
lead identifier

name
string
the company name

logo
string
the url of the company logo

city
string
the city in which the company resides

industry
string
the sector in which the company operates

description
string
a short description of the company

size
number
the number of employes working in the company

legalAddress
string
address of the company office

url
string
site or main social url

temperature
number
between 1 and 3: 1 cold, 2 warm, 3 hot

visits
number
number of different pages

timeOnPages
number
time spent on pages

lastVisit
string
last visit of the lead

#intel
Examples
[ { "id": 0, "name": "string", "logo": "string", "city": "string", "industry": "string", "description": "string", "size": 0, "legalAddress": "string", "url": "string", "temperature": 0, "visits": 0, "timeOnPages": 0, "lastVisit": "string" } ]

This example has been generated automatically.
PUB intel.visitdetails
Request the list of pages visited by the lead

Operation IDintel.visitdetails.request
- #intel
Accepts the following message:
IntelVisitdetailsRequest
Request the list of visited pages and times
Query for all the user navigation record stored

object
uid: IntelVisitdetailsRequestPayload
id
number
lead identifier

Additional properties are allowed.
#intel
Examples
{ "id": 0 }

This example has been generated automatically.
SUB intel.visitdetails
Obtain the list of pages visited by the lead

Operation IDintel.visitdetails.response
- #intel
Accepts the following message:
IntelVisitdetailsResponse
Receive of visited pages and times
Carries an array of objects consisting in the page url, the ISO UTC date in which the user landed and the one in which he left the Userbot's customer site

array<object>
url
string
the url of the visited page

enter
string
the ISO UTC date in which the user landed in the page

leave
string
the ISO UTC date in which the user left the page

session
number
It can be used to follow the pages visited by a user

#intel
Examples
[ { "url": "string", "enter": "string", "leave": "string", "session": 0 } ]

This example has been generated automatically.
PUB intel.keypeople
Request the list of the lead's key people

Operation IDintel.keypeople.request
- #intel
Accepts the following message:
IntelKeypeopleRequest
The List of key people
Query for an array of key people's contacts in a company

object
uid: IntelKeypeopleRequestPayload
id
number
lead identifier

Additional properties are allowed.
#intel
Examples
{ "id": 0 }

This example has been generated automatically.
SUB intel.keypeople
Obtain a list of contacts of the company's key people

Operation IDintel.keypeople.response
- #intel
Accepts the following message:
IntelKeypeopleResponse
The List of key people
Carries the array of objects consisting in the name, surname and contacts of the key people in a company

array<object>
fullname
string
photo
string
Linkedin
string
role
string
#intel
Examples
[ { "fullname": "string", "photo": "string", "Linkedin": "string", "role": "string" } ]

This example has been generated automatically.
PUB intel.addtag
Adds a tag

Operation IDintel.addtag.request
- #intel
Accepts the following message:
IntelAddTagRequest
Adds a tag for a company
Carries the array of objects consisting in the name, surname and contacts of the key people in a company

object
uid: IntelAddTagRequestPayload
company
number
customer
number
tagname
string
Additional properties are allowed.
#intel
Examples
{ "company": 0, "customer": 0, "tagname": "string" }

This example has been generated automatically.
SUB intel.addtag
Read status code in order to know if a tag was added

Operation IDintel.addtag.response
- #intel
Accepts the following message:
PUB intel.removetag
Removes a tag

Operation IDintel.removetag.request
- #intel
Accepts the following message:
IntelRemoveTagRequest
Adds a tag for a company
Carries the array of objects consisting in the name, surname and contacts of the key people in a company

object
uid: IntelRemoveTagRequestPayload
company
number
customer
number
tagname
string
Additional properties are allowed.
#intel
Examples
{ "company": 0, "customer": 0, "tagname": "string" }

This example has been generated automatically.
SUB intel.removetag
Read status code in order to know if a tag was removed

Operation IDintel.removetag.response
- #intel
Accepts the following message:
PUB rawstats.count-nps
Get NPS values

Operation IDrawstats.count-nps.request
- #stats
- #nps
Accepts the following message:
RawstatsCountNpsRequest
Ask NPS in a period
This command is used to get NPS stats in a period [from]-[to]

object
uid: RawstatsCountNpsRequestPayload
from
string
The start date, format is complete ISO-8601 date

Examples values:
"2022-05-23T22:00:00.000Z"
to
string
The end date, format is complete ISO-8601 date

Examples values:
"2022-05-25T21:59:59.999Z"
Additional properties are allowed.
name
stats
name
nps
summary
Ask NPS values between dates
description
Client can ask for NPS values get from Webchat during conversation. Values are divided in negative, positive, neutral
object
uid: RawstatsCountNpsResponsePayload
command
string
Default value:"rawstats"
subcommand
string
Default value:"count-nps"
response
string
Default value:"OK"
object
positive
integer
Average of positive scores (9,10) from ChatUsers

neutral
integer
Average of neutral scores (7,8) from ChatUsers

negative
integer
Average of negative scores (1-6) from ChatUsers

Additional properties are allowed.
object
array<object>
The botID is the id of the bot

id
integer
Plugin ID

name
string
Plugin name

Examples values:
"obfuscate"
bot_id
integer
Bot ID

backend
boolean
dashboard
boolean
widgetchat
boolean
object
key
string
projectId
string
Additional properties are allowed.
Additional properties are allowed.
dashboard_token
string
Default value:null
Additional properties are allowed.
schemaFormat
application/vnd.aai.asyncapi;version=2.4.0
#stats
Examples
{ "from": "2022-05-23T22:00:00.000Z", "to": "2022-05-25T21:59:59.999Z" }

This example has been generated automatically.
SUB rawstats.count-nps
Messages that you receive from the API

Operation IDrawstats.count-nps.response
- #stats
- #nps
Accepts the following message:
RawstatsCountNpsResponse
Ask NPS values between dates
Client can ask for NPS values get from Webchat during conversation. Values are divided in negative, positive, neutral

object
uid: RawstatsCountNpsResponsePayload
command
string
Default value:"rawstats"
subcommand
string
Default value:"count-nps"
response
string
Default value:"OK"
object
positive
integer
Average of positive scores (9,10) from ChatUsers

neutral
integer
Average of neutral scores (7,8) from ChatUsers

negative
integer
Average of negative scores (1-6) from ChatUsers

Additional properties are allowed.
object
array<object>
The botID is the id of the bot

id
integer
Plugin ID

name
string
Plugin name

Examples values:
"obfuscate"
bot_id
integer
Bot ID

backend
boolean
dashboard
boolean
widgetchat
boolean
object
key
string
projectId
string
Additional properties are allowed.
Additional properties are allowed.
dashboard_token
string
Default value:null
Additional properties are allowed.
#stats
#nps
Examples
{ "command": "rawstats", "subcommand": "count-nps", "response": "OK", "data": { "positive": 0, "neutral": 0, "negative": 0 }, "plugins": { "botID": [ { "id": 0, "name": "obfuscate", "bot_id": 0, "backend": true, "dashboard": true, "widgetchat": true, "parameters": { "key": "string", "projectId": "string" } } ] }, "dashboard_token": null }

This example has been generated automatically.
PUB rawstats.all
Rawstats all returns the insights for the bot divided per day, in the range from-to

Operation IDrawstats.all.request
- #stats
Accepts the following message:
RawstatsAllRequest
Ask insights for the bot
This command is used to get insights

object
uid: RawstatsAllRequestPayload
from
string
The start date of the insights, format is complete ISO-8601 date

Examples values:
"2022-05-23T22:00:00.000Z"
to
string
The end date of the insights, format is complete ISO-8601 date

Examples values:
"2022-05-25T21:59:59.999Z"
Additional properties are allowed.
name
stats
summary
Returns the insights for the bot in the range from-to, divided per day
object
uid: RawstatsAllResponsePayload
command
string
Default value:"rawstats"
subcommand
string
Default value:"all"
response
string
Examples values:
"OK"
statuscode
integer
Examples values:
"200"
"404"
"500"
object
array<object>
messages
integer
Total messages of the day

resolved
integer
Total messages resolved of the day

resolvedByHuman
integer
Total messages resolved by an agent of the day

resolvedByBot
integer
Total messages resolved by bot of the day

resolvedByBotWithHints
integer
Total messages resolved by bot with hints of the day

notManagedByBot
integer
Total messages not resolved by bot for the day

avgResponseHuman
integer
Average response time of the agent of the day

avgResponseBot
integer
Average response time of the bot of the day

messages_human
integer
Total messages by an agent of the day

messages_user
integer
Total messages by an user of the day

conversations_bot
integer
Total conversations managed by bot of the day

conversations_human
integer
Total conversations managed by agent of the day

sessions
integer
Total conversations of the day

day
string
Examples values:
"2022-05-24"
object
object
resolvedByHumans
integer
The total messages resolved by an agent

upscaledToHumans
integer
The total messages upscaled to human

resolvedByBot
integer
The total messages resolved by Bot

resolvedByBotWithHints
integer
The total messages resolved by Bot with hints

count
integer
notManagedByBot
integer
The total messages not managed by Bot

Additional properties are allowed.
object
upscaled
integer
The total chats upscaled to agent

resolvedByBot
integer
The total chats resolved by Bot

count
integer
Additional properties are allowed.
avgResponseHuman
integer
The average time an agent answers to an upscaled conversation

Additional properties are allowed.
Additional properties are allowed.
object
array<object>
The botID is the id of the bot

id
integer
Plugin ID

name
string
Plugin name

Examples values:
"obfuscate"
bot_id
integer
Bot ID

backend
boolean
dashboard
boolean
widgetchat
boolean
object
key
string
projectId
string
Additional properties are allowed.
Additional properties are allowed.
dashboard_token
string
Default value:null
Additional properties are allowed.
schemaFormat
application/vnd.aai.asyncapi;version=2.4.0
#stats
Examples
{ "from": "2022-05-23T22:00:00.000Z", "to": "2022-05-25T21:59:59.999Z" }

This example has been generated automatically.
SUB rawstats.all
Operation IDrawstats.all.response
- #stats
Accepts the following message:
RawstatsAllResponse
Returns the insights for the bot in the range from-to, divided per day
object
uid: RawstatsAllResponsePayload
command
string
Default value:"rawstats"
subcommand
string
Default value:"all"
response
string
Examples values:
"OK"
statuscode
integer
Examples values:
"200"
"404"
"500"
object
array<object>
messages
integer
Total messages of the day

resolved
integer
Total messages resolved of the day

resolvedByHuman
integer
Total messages resolved by an agent of the day

resolvedByBot
integer
Total messages resolved by bot of the day

resolvedByBotWithHints
integer
Total messages resolved by bot with hints of the day

notManagedByBot
integer
Total messages not resolved by bot for the day

avgResponseHuman
integer
Average response time of the agent of the day

avgResponseBot
integer
Average response time of the bot of the day

messages_human
integer
Total messages by an agent of the day

messages_user
integer
Total messages by an user of the day

conversations_bot
integer
Total conversations managed by bot of the day

conversations_human
integer
Total conversations managed by agent of the day

sessions
integer
Total conversations of the day

day
string
Examples values:
"2022-05-24"
object
object
resolvedByHumans
integer
The total messages resolved by an agent

upscaledToHumans
integer
The total messages upscaled to human

resolvedByBot
integer
The total messages resolved by Bot

resolvedByBotWithHints
integer
The total messages resolved by Bot with hints

count
integer
notManagedByBot
integer
The total messages not managed by Bot

Additional properties are allowed.
object
upscaled
integer
The total chats upscaled to agent

resolvedByBot
integer
The total chats resolved by Bot

count
integer
Additional properties are allowed.
avgResponseHuman
integer
The average time an agent answers to an upscaled conversation

Additional properties are allowed.
Additional properties are allowed.
object
array<object>
The botID is the id of the bot

id
integer
Plugin ID

name
string
Plugin name

Examples values:
"obfuscate"
bot_id
integer
Bot ID

backend
boolean
dashboard
boolean
widgetchat
boolean
object
key
string
projectId
string
Additional properties are allowed.
Additional properties are allowed.
dashboard_token
string
Default value:null
Additional properties are allowed.
#stats
Examples
{ "command": "rawstats", "subcommand": "all", "response": "OK", "statuscode": "200", "data": { "dates": [ { "messages": 0, "resolved": 0, "resolvedByHuman": 0, "resolvedByBot": 0, "resolvedByBotWithHints": 0, "notManagedByBot": 0, "avgResponseHuman": 0, "avgResponseBot": 0, "messages_human": 0, "messages_user": 0, "conversations_bot": 0, "conversations_human": 0, "sessions": 0, "day": "2022-05-24" } ], "totals": { "messages": { "resolvedByHumans": 0, "upscaledToHumans": 0, "resolvedByBot": 0, "resolvedByBotWithHints": 0, "count": 0, "notManagedByBot": 0 }, "sessions": { "upscaled": 0, "resolvedByBot": 0, "count": 0 }, "avgResponseHuman": 0 } }, "plugins": { "botID": [ { "id": 0, "name": "obfuscate", "bot_id": 0, "backend": true, "dashboard": true, "widgetchat": true, "parameters": { "key": "string", "projectId": "string" } } ] }, "dashboard_token": null }

This example has been generated automatically.
PUB rawstats.count-messages
Total amount of messages in a period

Operation IDrawstats.count-messages.request
- #stats
Accepts the following message:
RawstatsCountMessagesRequest
Ask total messages in a period
This command is used to get the total amount of messages in a period

object
uid: RawstatsCountMessagesRequestPayload
from
string
The start date, format is complete ISO-8601 date

Examples values:
"2022-05-23T22:00:00.000Z"
to
string
The end date, format is complete ISO-8601 date

Examples values:
"2022-05-25T21:59:59.999Z"
Additional properties are allowed.
name
stats
summary
Return total messages in a period
object
uid: RawstatsCountMessagesResponsePayload
command
string
Default value:"rawstats"
subcommand
string
Default value:"count-messages"
response
string
Examples values:
"OK"
statuscode
integer
Examples values:
"200"
"404"
"500"
object
count
integer
The total amount of messages for the period asked

Additional properties are allowed.
object
array<object>
The botID is the id of the bot

id
integer
Plugin ID

name
string
Plugin name

Examples values:
"obfuscate"
bot_id
integer
Bot ID

backend
boolean
dashboard
boolean
widgetchat
boolean
object
key
string
projectId
string
Additional properties are allowed.
Additional properties are allowed.
dashboard_token
string
Default value:null
Additional properties are allowed.
schemaFormat
application/vnd.aai.asyncapi;version=2.4.0
#stats
Examples
{ "from": "2022-05-23T22:00:00.000Z", "to": "2022-05-25T21:59:59.999Z" }

This example has been generated automatically.
SUB rawstats.count-messages
Operation IDrawstats.count-messages.response
- #stats
Accepts the following message:
RawstatsCountMessagesResponse
Return total messages in a period
object
uid: RawstatsCountMessagesResponsePayload
command
string
Default value:"rawstats"
subcommand
string
Default value:"count-messages"
response
string
Examples values:
"OK"
statuscode
integer
Examples values:
"200"
"404"
"500"
object
count
integer
The total amount of messages for the period asked

Additional properties are allowed.
object
array<object>
The botID is the id of the bot

id
integer
Plugin ID

name
string
Plugin name

Examples values:
"obfuscate"
bot_id
integer
Bot ID

backend
boolean
dashboard
boolean
widgetchat
boolean
object
key
string
projectId
string
Additional properties are allowed.
Additional properties are allowed.
dashboard_token
string
Default value:null
Additional properties are allowed.
#stats
Examples
{ "command": "rawstats", "subcommand": "count-messages", "response": "OK", "statuscode": "200", "data": { "count": 0 }, "plugins": { "botID": [ { "id": 0, "name": "obfuscate", "bot_id": 0, "backend": true, "dashboard": true, "widgetchat": true, "parameters": { "key": "string", "projectId": "string" } } ] }, "dashboard_token": null }

This example has been generated automatically.
PUB rawstats.count-sessions
Total amount of sessions in a period

Operation IDrawstats.count-sessions.request
- #stats
Accepts the following message:
RawstatsCountSessionsRequest
Ask total sessions in a period
This command is used to get the total amount of sessions in a period

object
uid: RawstatsCountSessionsRequestPayload
from
string
The start date, format is complete ISO-8601 date

Examples values:
"2022-05-23T22:00:00.000Z"
to
string
The end date, format is complete ISO-8601 date

Examples values:
"2022-05-25T21:59:59.999Z"
Additional properties are allowed.
name
stats
summary
Return total sessions in a period
object
uid: RawstatsCountSessionsResponsePayload
command
string
Default value:"rawstats"
subcommand
string
Default value:"count-sessions"
response
string
Examples values:
"OK"
statuscode
integer
Examples values:
"200"
"404"
"500"
object
count
integer
The total amount of chat sessions in the period asked

Additional properties are allowed.
object
array<object>
The botID is the id of the bot

id
integer
Plugin ID

name
string
Plugin name

Examples values:
"obfuscate"
bot_id
integer
Bot ID

backend
boolean
dashboard
boolean
widgetchat
boolean
object
key
string
projectId
string
Additional properties are allowed.
Additional properties are allowed.
dashboard_token
string
Default value:null
Additional properties are allowed.
schemaFormat
application/vnd.aai.asyncapi;version=2.4.0
#stats
Examples
{ "from": "2022-05-23T22:00:00.000Z", "to": "2022-05-25T21:59:59.999Z" }

This example has been generated automatically.
SUB rawstats.count-sessions
Operation IDrawstats.count-sessions.response
- #stats
Accepts the following message:
RawstatsCountSessionsResponse
Return total sessions in a period
object
uid: RawstatsCountSessionsResponsePayload
command
string
Default value:"rawstats"
subcommand
string
Default value:"count-sessions"
response
string
Examples values:
"OK"
statuscode
integer
Examples values:
"200"
"404"
"500"
object
count
integer
The total amount of chat sessions in the period asked

Additional properties are allowed.
object
array<object>
The botID is the id of the bot

id
integer
Plugin ID

name
string
Plugin name

Examples values:
"obfuscate"
bot_id
integer
Bot ID

backend
boolean
dashboard
boolean
widgetchat
boolean
object
key
string
projectId
string
Additional properties are allowed.
Additional properties are allowed.
dashboard_token
string
Default value:null
Additional properties are allowed.
#stats
Examples
{ "command": "rawstats", "subcommand": "count-sessions", "response": "OK", "statuscode": "200", "data": { "count": 0 }, "plugins": { "botID": [ { "id": 0, "name": "obfuscate", "bot_id": 0, "backend": true, "dashboard": true, "widgetchat": true, "parameters": { "key": "string", "projectId": "string" } } ] }, "dashboard_token": null }

This example has been generated automatically.
PUB rawstats.get
Sales Stats

Operation IDrawstats.get.request
- #stats
Accepts the following message:
RawstatsGetRequest
Ask sales stats in a period
This command is used to get the sales stats in a period

object
uid: RawstatsGetRequestPayload
startFrom
string
The start date, format is complete ISO-8601 date

Examples values:
"2022-05-23T22:00:00.000Z"
endTo
string
The end date, format is complete ISO-8601 date

Examples values:
"2022-05-25T21:59:59.999Z"
Additional properties are allowed.
name
stats
summary
Return sales stats in a period
object
uid: RawstatsGetResponsePayload
command
string
Default value:"rawstats"
subcommand
string
Default value:"get"
response
string
Examples values:
"OK"
statuscode
integer
Examples values:
"200"
"404"
"500"
object
object
companies stats

totalCompanies
integer
the total amount of companies

newCompanies
integer
the new companies

array<any>
company
string
the name of the company

employees
integer
the number of employees of the company

Additional properties are allowed.
object
conversations stats

totalConversations
integer
total amount of conversations

Additional properties are allowed.
object
industries stats

array<any>
industry
string
occurrence
integer
Additional properties are allowed.
object
email stats

totalEmailsCaptured
number
Additional properties are allowed.
object
meetings data

totalMeetingsScheduled
number
Additional properties are allowed.
Additional properties are allowed.
object
array<object>
The botID is the id of the bot

id
integer
Plugin ID

name
string
Plugin name

Examples values:
"obfuscate"
bot_id
integer
Bot ID

backend
boolean
dashboard
boolean
widgetchat
boolean
object
key
string
projectId
string
Additional properties are allowed.
Additional properties are allowed.
dashboard_token
string
Default value:null
Additional properties are allowed.
schemaFormat
application/vnd.aai.asyncapi;version=2.4.0
#stats
Examples
{ "startFrom": "2022-05-23T22:00:00.000Z", "endTo": "2022-05-25T21:59:59.999Z" }

This example has been generated automatically.
SUB rawstats.get
Operation IDrawstats.get.response
- #stats
Accepts the following message:
RawstatsGetResponse
Return sales stats in a period
object
uid: RawstatsGetResponsePayload
command
string
Default value:"rawstats"
subcommand
string
Default value:"get"
response
string
Examples values:
"OK"
statuscode
integer
Examples values:
"200"
"404"
"500"
object
object
companies stats

totalCompanies
integer
the total amount of companies

newCompanies
integer
the new companies

array<any>
company
string
the name of the company

employees
integer
the number of employees of the company

Additional properties are allowed.
object
conversations stats

totalConversations
integer
total amount of conversations

Additional properties are allowed.
object
industries stats

array<any>
industry
string
occurrence
integer
Additional properties are allowed.
object
email stats

totalEmailsCaptured
number
Additional properties are allowed.
object
meetings data

totalMeetingsScheduled
number
Additional properties are allowed.
Additional properties are allowed.
object
array<object>
The botID is the id of the bot

id
integer
Plugin ID

name
string
Plugin name

Examples values:
"obfuscate"
bot_id
integer
Bot ID

backend
boolean
dashboard
boolean
widgetchat
boolean
object
key
string
projectId
string
Additional properties are allowed.
Additional properties are allowed.
dashboard_token
string
Default value:null
Additional properties are allowed.
#stats
Examples
{ "command": "rawstats", "subcommand": "get", "response": "OK", "statuscode": "200", "data": { "companies": { "totalCompanies": 0, "newCompanies": 0, "size": [] }, "conversations": { "totalConversations": 0 }, "industries": { "industryPercentage": [] }, "email": { "totalEmailsCaptured": 0 }, "meetings": { "totalMeetingsScheduled": 0 } }, "plugins": { "botID": [ { "id": 0, "name": "obfuscate", "bot_id": 0, "backend": true, "dashboard": true, "widgetchat": true, "parameters": { "key": "string", "projectId": "string" } } ] }, "dashboard_token": null }

This example has been generated automatically.
PUB meetings.schedule
Save a new meetings scheduled using Calendly

Operation IDmeetings.schedule.request
- #meetings
Accepts the following message:
MeetingsScheduleRequest
object
uid: MeetingsScheduleRequestPayload
eventUrl
string
It contains a url to use with Calendly API to get the details of an event

Examples values:
"https://api.calendly.com/scheduled_events/c1deba23-dbcb-4b34-890e-f5d8d908091c"
inviteeUrl
string
It contains a url to use with Calendly API to get the invitee of an event

Examples values:
"https://api.calendly.com/scheduled_events/c1deba23-dbcb-4b34-890e-f5d8d908091c/invitees/f2bcd809-d909-4082-9876-a20e93d03b1f"
Additional properties are allowed.
#meetings
Examples
{ "eventUrl": "https://api.calendly.com/scheduled_events/c1deba23-dbcb-4b34-890e-f5d8d908091c", "inviteeUrl": "https://api.calendly.com/scheduled_events/c1deba23-dbcb-4b34-890e-f5d8d908091c/invitees/f2bcd809-d909-4082-9876-a20e93d03b1f" }

This example has been generated automatically.
PUB meetings.decline
Submit a not scheduled meeting using Calendly

Operation IDmeetings.decline.request
- #meetings
Accepts the following message:
MeetingsDeclineRequest
#meetings
Examples

Messages

#1BotGetVarsRequest
object
command
string
status
number
Allowed values:
200
404
500
Additional properties are allowed.
array<object>
id
number
name
string
type
string
Allowed values:
"text"
bot_id
number
uuid
string
schemaFormat
application/vnd.aai.asyncapi;version=2.4.0
#2BotGetVarsResponse
allOf
uid: BotGetVarsResponsePayload
object
command
string
status
number
Allowed values:
200
404
500
Additional properties are allowed.
restricted any
array<object>
id
number
name
string
type
string
Allowed values:
"text"
bot_id
number
uuid
string
#3WhoRequest
Ask data about the logged user
This command is used to get information about the logged user, in particular the user.id is needed to use chat commands (robin)

Payload
string
uid: WhoRequestPayload
Default value:"who"
name
chat
summary
Returns information about the logged user
object
uid: WhoResponsePayload
command
string
Default value:"who"
text
string
An information about the user

Examples values:
"You are:user.username(display_username)"
object
username
string
customer_id
integer
userLevel
integer
object
id
integer
nickname
string
email
string
md5_email
string
phone
string
password
string
nome
string
cognome
string
birth
string
pic
string
points
integer
user_level
integer
customer_id
integer
newsletter
integer
hash
integer
last_session
integer
json_stats
string
notes
string
confirm
integer
created_user
string
Examples values:
"2021-01-12T17:03:08.000Z"
owner_name
string
autocreate
integer
group_id
integer
chat_user
boolean
Additional properties are allowed.
display_username
string
Examples values:
"Mario_Rossi"
key
string
The server_key of the bot

Additional properties are allowed.
object
array<object>
The botID is the id of the bot

id
integer
Plugin ID

name
string
Plugin name

Examples values:
"obfuscate"
bot_id
integer
Bot ID

backend
boolean
dashboard
boolean
widgetchat
boolean
object
key
string
projectId
string
Additional properties are allowed.
Additional properties are allowed.
dashboard_token
string
Additional properties are allowed.
schemaFormat
application/vnd.aai.asyncapi;version=2.4.0
#chat
#4WhoResponse
Returns information about the logged user
object
uid: WhoResponsePayload
command
string
Default value:"who"
text
string
An information about the user

Examples values:
"You are:user.username(display_username)"
object
username
string
customer_id
integer
userLevel
integer
object
id
integer
nickname
string
email
string
md5_email
string
phone
string
password
string
nome
string
cognome
string
birth
string
pic
string
points
integer
user_level
integer
customer_id
integer
newsletter
integer
hash
integer
last_session
integer
json_stats
string
notes
string
confirm
integer
created_user
string
Examples values:
"2021-01-12T17:03:08.000Z"
owner_name
string
autocreate
integer
group_id
integer
chat_user
boolean
Additional properties are allowed.
display_username
string
Examples values:
"Mario_Rossi"
key
string
The server_key of the bot

Additional properties are allowed.
object
array<object>
The botID is the id of the bot

id
integer
Plugin ID

name
string
Plugin name

Examples values:
"obfuscate"
bot_id
integer
Bot ID

backend
boolean
dashboard
boolean
widgetchat
boolean
object
key
string
projectId
string
Additional properties are allowed.
Additional properties are allowed.
dashboard_token
string
Additional properties are allowed.
#chat
#5RobinSvGetSessionsRequest
Ask data about chats
This command returns the information about the chats on a bot

Payload
string
uid: RobinSvGetSessionsRequestPayload
The [user.id] is the value that can be get by the command who. Limit and offset (integers) are used to limit the amount of chat sessions to be returned.

Default value:"robin sv [user.id] get sessions [limit] [offset]"
name
chat
summary
Returns information about chats
object
uid: RobinSvGetSessionsResponsePayload
command
string
Default value:"robin"
subcommand
string
Default value:"get"
region
string
Default value:"sessions"
subject
string
Default value:"op"
status
integer
Examples values:
"200"
"404"
"500"
array<object>
robin_email
string
counter
integer
id
integer
quando
string
test_chat
boolean
bot_id
integer
user
string
userid
integer
chat
integer
muted
boolean
vision
integer
wspath
string
client_number
integer
last_status
integer
breaked
string
ticket_status
string
ticket_assigned
string
robin_op
integer
json_trace
string
last_message
string
source
string
last_payload
string
vars
string
last_chat_text
string
last_chat_username
string
user_id
integer
nickname
string
email
string
phone
string
nome
string
cognome
string
birth
string
pic
string
customer_id
integer
last_session
string
json_stats
string
notes
string
object
online
integer
away
integer
deposit
integer
total
integer
notifications
integer
array<any>
array<any>
array<any>
Additional properties are allowed.
object
array<object>
The botID is the id of the bot

id
integer
Plugin ID

name
string
Plugin name

Examples values:
"obfuscate"
bot_id
integer
Bot ID

backend
boolean
dashboard
boolean
widgetchat
boolean
object
key
string
projectId
string
Additional properties are allowed.
Additional properties are allowed.
dashboard_token
string
Additional properties are allowed.
schemaFormat
application/vnd.aai.asyncapi;version=2.4.0
#chat
#6RobinSvGetSessionsResponse
Returns information about chats
object
uid: RobinSvGetSessionsResponsePayload
command
string
Default value:"robin"
subcommand
string
Default value:"get"
region
string
Default value:"sessions"
subject
string
Default value:"op"
status
integer
Examples values:
"200"
"404"
"500"
array<object>
robin_email
string
counter
integer
id
integer
quando
string
test_chat
boolean
bot_id
integer
user
string
userid
integer
chat
integer
muted
boolean
vision
integer
wspath
string
client_number
integer
last_status
integer
breaked
string
ticket_status
string
ticket_assigned
string
robin_op
integer
json_trace
string
last_message
string
source
string
last_payload
string
vars
string
last_chat_text
string
last_chat_username
string
user_id
integer
nickname
string
email
string
phone
string
nome
string
cognome
string
birth
string
pic
string
customer_id
integer
last_session
string
json_stats
string
notes
string
object
online
integer
away
integer
deposit
integer
total
integer
notifications
integer
array<any>
array<any>
array<any>
Additional properties are allowed.
object
array<object>
The botID is the id of the bot

id
integer
Plugin ID

name
string
Plugin name

Examples values:
"obfuscate"
bot_id
integer
Bot ID

backend
boolean
dashboard
boolean
widgetchat
boolean
object
key
string
projectId
string
Additional properties are allowed.
Additional properties are allowed.
dashboard_token
string
Additional properties are allowed.
#chat
#7RobinSvGetSessionRequest
Ask data about a single chat by session id
This command returns the information about the single chat identified by session.id

Payload
string
uid: RobinSvGetSessionRequestPayload
The [user.id] is the value that can be get by the command who. The [session.id] is obtained by robin.sv.[user.id].get.sessions.[limit].[offset] command

Default value:"robin sv [user.id] get [session.id]"
name
chat
summary
Returns information about a single chat, identified by session.id
object
uid: RobinSvGetSessionResponsePayload
command
string
Default value:"robin"
subcommand
string
Default value:"get"
region
string
Default value:"session.id"
subject
string
Default value:"op"
status
integer
Examples values:
"200"
"404"
"500"
array<object>
id
integer
bot_id
integer
session
integer
message_uuid
string
userid
integer
username
string
chat
string
qea_id
integer
status
integer
quando_chat
string
Examples values:
"2022-05-19T09:24:25.000Z"
sentiment
string
hbo
string
Examples values:
"h"
"b"
"o"
kpi_processed
boolean
like_dislike
integer
thumbs
integer
ai_score
integer
robin_op
integer
ticket_assigned
string
robin_email
string
canBeTrained
boolean
object
online
integer
away
integer
deposit
integer
total
integer
notifications
integer
array<any>
array<any>
array<any>
Additional properties are allowed.
source
string
Examples values:
"webchat"
"facebook"
source_urlweb
string
Examples values:
"http://127.0.0.1:5500/index-1634.html"
object
array<object>
The botID is the id of the bot

id
integer
Plugin ID

name
string
Plugin name

Examples values:
"obfuscate"
bot_id
integer
Bot ID

backend
boolean
dashboard
boolean
widgetchat
boolean
object
key
string
projectId
string
Additional properties are allowed.
Additional properties are allowed.
dashboard_token
string
Additional properties are allowed.
schemaFormat
application/vnd.aai.asyncapi;version=2.4.0
#chat
#8RobinSvGetSessionResponse
Returns information about a single chat, identified by session.id
object
uid: RobinSvGetSessionResponsePayload
command
string
Default value:"robin"
subcommand
string
Default value:"get"
region
string
Default value:"session.id"
subject
string
Default value:"op"
status
integer
Examples values:
"200"
"404"
"500"
array<object>
id
integer
bot_id
integer
session
integer
message_uuid
string
userid
integer
username
string
chat
string
qea_id
integer
status
integer
quando_chat
string
Examples values:
"2022-05-19T09:24:25.000Z"
sentiment
string
hbo
string
Examples values:
"h"
"b"
"o"
kpi_processed
boolean
like_dislike
integer
thumbs
integer
ai_score
integer
robin_op
integer
ticket_assigned
string
robin_email
string
canBeTrained
boolean
object
online
integer
away
integer
deposit
integer
total
integer
notifications
integer
array<any>
array<any>
array<any>
Additional properties are allowed.
source
string
Examples values:
"webchat"
"facebook"
source_urlweb
string
Examples values:
"http://127.0.0.1:5500/index-1634.html"
object
array<object>
The botID is the id of the bot

id
integer
Plugin ID

name
string
Plugin name

Examples values:
"obfuscate"
bot_id
integer
Bot ID

backend
boolean
dashboard
boolean
widgetchat
boolean
object
key
string
projectId
string
Additional properties are allowed.
Additional properties are allowed.
dashboard_token
string
Additional properties are allowed.
#chat
#9ChatAssignToAgentRequest
Ask to assign a chat to an agent
This command returns the information about the single chat identified by session.id
object
uid: ChatAssignToAgentRequestPayload
Used to ask to assign a chat to an agent

session
integer
The id of the session to be assigned to the agent

agent
string
The agent email to which to assign the conversation

Examples values:
"agent-email@userbot.ai"
Additional properties are allowed.
name
chat
summary
Assigns the chat to an agent
object
uid: ChatAssignToAgentResponsePayload
command
string
Default value:"chat-assign-to-agent"
subcommand
string
Examples values:
"{"session":123456,"agent":"agent-email@userbot.ai"}"
text
string
Examples values:
"Assigned to "agent-email@userbot.ai""
status
integer
Examples values:
"200"
"404"
"500"
object
array<object>
The botID is the id of the bot

id
integer
Plugin ID

name
string
Plugin name

Examples values:
"obfuscate"
bot_id
integer
Bot ID

backend
boolean
dashboard
boolean
widgetchat
boolean
object
key
string
projectId
string
Additional properties are allowed.
Additional properties are allowed.
dashboard_token
string
Additional properties are allowed.
schemaFormat
application/vnd.aai.asyncapi;version=2.4.0
#chat
#10ChatAssignToAgentResponse
Assigns the chat to an agent
object
uid: ChatAssignToAgentResponsePayload
command
string
Default value:"chat-assign-to-agent"
subcommand
string
Examples values:
"{"session":123456,"agent":"agent-email@userbot.ai"}"
text
string
Examples values:
"Assigned to "agent-email@userbot.ai""
status
integer
Examples values:
"200"
"404"
"500"
object
array<object>
The botID is the id of the bot

id
integer
Plugin ID

name
string
Plugin name

Examples values:
"obfuscate"
bot_id
integer
Bot ID

backend
boolean
dashboard
boolean
widgetchat
boolean
object
key
string
projectId
string
Additional properties are allowed.
Additional properties are allowed.
dashboard_token
string
Additional properties are allowed.
#chat
#11ChatAssignToBotRequest
Ask to assign a chat to the Bot
This command returns the information about the single chat identified by session.id

object
uid: ChatAssignToBotRequestPayload
Used to ask to assign a chat to the Bot

session
integer
The id of the session to be assigned to the Bot

Additional properties are allowed.
name
chat
summary
Assigns the chat to the Bot
object
uid: ChatAssignToBotResponsePayload
command
string
Default value:"chat-assign-to-bot"
subcommand
string
Examples values:
"{"session":123456}"
text
string
Examples values:
"Reassigned to bot"
status
integer
Examples values:
"200"
"404"
"500"
object
array<object>
The botID is the id of the bot

id
integer
Plugin ID

name
string
Plugin name

Examples values:
"obfuscate"
bot_id
integer
Bot ID

backend
boolean
dashboard
boolean
widgetchat
boolean
object
key
string
projectId
string
Additional properties are allowed.
Additional properties are allowed.
dashboard_token
string
Additional properties are allowed.
schemaFormat
application/vnd.aai.asyncapi;version=2.4.0
#chat
#12ChatAssignToBotResponse
Assigns the chat to the Bot
object
uid: ChatAssignToBotResponsePayload
command
string
Default value:"chat-assign-to-bot"
subcommand
string
Examples values:
"{"session":123456}"
text
string
Examples values:
"Reassigned to bot"
status
integer
Examples values:
"200"
"404"
"500"
object
array<object>
The botID is the id of the bot

id
integer
Plugin ID

name
string
Plugin name

Examples values:
"obfuscate"
bot_id
integer
Bot ID

backend
boolean
dashboard
boolean
widgetchat
boolean
object
key
string
projectId
string
Additional properties are allowed.
Additional properties are allowed.
dashboard_token
string
Additional properties are allowed.
#chat
#13SayRequest
Send a chat message by agent in the chat session with id [session.id]
The wspath is in the payload of robin.sv.[user.id].get.sessions

Payload
string
uid: SayRequestPayload
wspath can be get by robin.sv.[user.id].get.sessions. chat_message is the actual message that is sent in the chat

Default value:"say.[wspath].[-100].[session.id].[chat_message]"
name
chat
name
chat-notification
summary
Response is information about the current chat message
object
uid: SayResponsePayload
command
string
Default value:"chat-notification"
object
online
integer
away
integer
deposit
integer
total
integer
notifications
integer
array<any>
array<any>
array<any>
Additional properties are allowed.
notificationId
integer
object
id
integer
quando
string
test_chat
boolean
bot_id
integer
user
string
userid
integer
chat
integer
muted
boolean
This flag is used to mute the Bot, for example in particular cases when the conversation is given to an agent

vision
integer
wspath
string
This is used for the say command

client_number
integer
last_status
string
breaked
string
ticket_status
integer
ticket_assigned
string
robin_op
string
json_trace
string
last_message
string
source
string
last_payload
string
vars
string
isHumanMessage
boolean
humanMessage
string
counter
integer
Additional properties are allowed.
object
nfrom
integer
nto
integer
session_id
integer
bot_argument
string
customer_id
integer
user_id
integer
object
id
integer
bot_id
integer
session
integer
message_uuid
string
userid
integer
username
string
chat
string
qea_id
integer
status
integer
quando_chat
string
sentiment
string
hbo
string
kpi_processed
boolean
like_dislike
boolean
thumbs
boolean
ai_score
integer
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
schemaFormat
application/vnd.aai.asyncapi;version=2.4.0
#chat
#chat-notification
#14SayResponse
Response is information about the current chat message
object
uid: SayResponsePayload
command
string
Default value:"chat-notification"
object
online
integer
away
integer
deposit
integer
total
integer
notifications
integer
array<any>
array<any>
array<any>
Additional properties are allowed.
notificationId
integer
object
id
integer
quando
string
test_chat
boolean
bot_id
integer
user
string
userid
integer
chat
integer
muted
boolean
This flag is used to mute the Bot, for example in particular cases when the conversation is given to an agent

vision
integer
wspath
string
This is used for the say command

client_number
integer
last_status
string
breaked
string
ticket_status
integer
ticket_assigned
string
robin_op
string
json_trace
string
last_message
string
source
string
last_payload
string
vars
string
isHumanMessage
boolean
humanMessage
string
counter
integer
Additional properties are allowed.
object
nfrom
integer
nto
integer
session_id
integer
bot_argument
string
customer_id
integer
user_id
integer
object
id
integer
bot_id
integer
session
integer
message_uuid
string
userid
integer
username
string
chat
string
qea_id
integer
status
integer
quando_chat
string
sentiment
string
hbo
string
kpi_processed
boolean
like_dislike
boolean
thumbs
boolean
ai_score
integer
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
#chat
#chat-notification
#15ChatUsersGetRequest
Ask a list of chat users
Client can ask to the server the list of users that interacted with a given bot, based on offset and limit parameters. This is because there is infinite scrolling on the dash USERS and the data needs to be limited
object
uid: ChatUsersGetRequestPayload
offset
integer
Default value:0
limit
integer
Default value:25
array<object>
mode
string
Allowed values:
"ASC"
"DESC"
field
string
search
string
A string used to search in all ChatUser properties

Default value:""
anonymous
boolean
If property is true must be returned also anonymous users

Default value:
array<object>
entity
string
operator
string
If type is equal to "tag" valid operators will be only "is" and "is_not".

Allowed values:
"is"
"is_not"
"has_any_value"
"contains"
"does_not_contain"
"greater_than"
"greater_than_or_equal"
"less_than"
"less_than_or_equal"
type
string
Allowed values:
"variable"
"tag"
value
string
tags
boolean
if tags is true it will load tags on every ChatUsers of the response

Default value:
Additional properties are allowed.
name
chatusers
summary
List the chat users of a single bot
object
uid: ChatUsersGetResponsePayload
array<object>
uid: ChatUser
id
integer
name
string
The name of the user

surname
string
The surname of the user

email
string
The email of the user

phone
string
The phone of the user

firstChat
string
format: date-time
The first time the user chatted

lastChat
string
format: date-time
The last time the user chatted

language
string
browser
string
Browser used if Web page was visited

source
string
Last source of contact (web, facebook, etc...)

array<string>
List of tags assigned to ChatUser.

Items:
string
total
integer
Total number of chat users in a Bot

anonymous
integer
Total number of anonymous users in a Bot

namedUsers
integer
Total number of not anonymous users in a Bot

filteredCounter
integer
Total number of chat users that has match a filtered search using filters, anonymouse and search params

Additional properties are allowed.
schemaFormat
application/vnd.aai.asyncapi;version=2.4.0
#chatusers
#16ChatUsersGetResponse
List the chat users of a single bot
object
uid: ChatUsersGetResponsePayload
array<object>
uid: ChatUser
id
integer
name
string
The name of the user

surname
string
The surname of the user

email
string
The email of the user

phone
string
The phone of the user

firstChat
string
format: date-time
The first time the user chatted

lastChat
string
format: date-time
The last time the user chatted

language
string
browser
string
Browser used if Web page was visited

source
string
Last source of contact (web, facebook, etc...)

array<string>
List of tags assigned to ChatUser.

Items:
string
total
integer
Total number of chat users in a Bot

anonymous
integer
Total number of anonymous users in a Bot

namedUsers
integer
Total number of not anonymous users in a Bot

filteredCounter
integer
Total number of chat users that has match a filtered search using filters, anonymouse and search params

Additional properties are allowed.
#chatusers
#17ChatUsersGetVarsRequest
Ask variables assigned to a Chat User
Client can ask to the server the list of pair name-value variables assigned to a Chat User

object
uid: ChatUsersGetVarsRequestPayload
userId
integer
Additional properties are allowed.
summary
Return variables assigned to a Chat User
object
uid: ChatUsersGetVarsResponsePayload
array<object>
uid: Variable
oneOf
Adheres to:
string
Or to:
integer
name
string
type
string
Additional properties are allowed.
schemaFormat
application/vnd.aai.asyncapi;version=2.4.0
#18ChatUsersGetVarsResponse
Return variables assigned to a Chat User
object
uid: ChatUsersGetVarsResponsePayload
array<object>
uid: Variable
oneOf
Adheres to:
string
Or to:
integer
name
string
type
string
Additional properties are allowed.
#19ChatUsersCreateRequest
array<object>
firstname
required
string
The name of the User

lastname
required
string
The surname of the User

email
required
string
The email of the User

phone
required
string
The phone number of the User

consentConfirmation
required
boolean
The consent confirmation checkbox means Customer has the explicit consent of the User to be signing up

userid
integer
The userid is the id of the user that needs to be updated, if an user is created userid is not sent
object
command
string
status
number
Allowed values:
200
404
500
Additional properties are allowed.
array<object>
command
string
status
number
Allowed values:
200
404
500
schemaFormat
application/vnd.aai.asyncapi;version=2.4.0
#20ChatUsersCreateResponse
allOf
uid: ChatUsersCreateResponsePayload
object
command
string
status
number
Allowed values:
200
404
500
Additional properties are allowed.
And with:
any
#21ChatUsersDeleteRequest
object
uid: ChatUsersDeleteRequestPayload
all
boolean
If true it means all users must be deleted from the database

array<integer>
List of Chat User's id to delete from database

Items:
integer
array<any>
If this parameter is in the payload, and is set to all true, delete all the users except those specified in this array of usersId

Additional properties are allowed.
object
command
string
status
number
Allowed values:
200
404
500
Additional properties are allowed.
object
array<integer>
Items:
integer
Additional properties are allowed.
schemaFormat
application/vnd.aai.asyncapi;version=2.4.0
#22ChatUsersDeleteResponse
allOf
uid: ChatUsersDeleteResponsePayload
object
command
string
status
number
Allowed values:
200
404
500
Additional properties are allowed.
object
array<integer>
Items:
integer
Additional properties are allowed.
#23ChatUsersInsightsRequest
allOf
uid: ChatUsersInsightsRequestPayload
object
startFrom
integer
Timestamp

endTo
integer
Timestamp

Additional properties are allowed.
object
all
boolean
If true it will request a total number of ChatUsers available in a defined time period

newChatUsers
boolean
If true it will request a number of new ChatUsers created in a defined time period

averageMessagesPerSession
boolean
If true it will request the average number of ChatUser messages per session in a defined time period

averageDurationSession
boolean
If true it will request the average duration of ChatUser session in a defined time period

Additional properties are allowed.
object
command
string
status
number
Allowed values:
200
404
500
Additional properties are allowed.
object
all
integer
Total number of ChatUsers until that period

newChatUsers
integer
Total number of new ChatUsers between the time period defined

averageMessagesPerSession
integer
Average Chatusers' messages per session in the defined time period

averageDurationSession
integer
Average Chatusers' duration session in the defined time period

Additional properties are allowed.
schemaFormat
application/vnd.aai.asyncapi;version=2.4.0
#24ChatUsersInsightsResponse
allOf
uid: ChatUsersInsightsResponsePayload
object
command
string
status
number
Allowed values:
200
404
500
Additional properties are allowed.
object
all
integer
Total number of ChatUsers until that period

newChatUsers
integer
Total number of new ChatUsers between the time period defined

averageMessagesPerSession
integer
Average Chatusers' messages per session in the defined time period

averageDurationSession
integer
Average Chatusers' duration session in the defined time period

Additional properties are allowed.
#25ChatUsersImportRequest
object
uid: ChatUsersImportRequestPayload
file
string
format: binary
Binary data of the CSV file sent

Additional properties are allowed.
object
command
string
status
number
Allowed values:
200
404
500
Additional properties are allowed.
object
array<array<any>>
array<any>
Additional properties are allowed.
schemaFormat
application/vnd.aai.asyncapi;version=2.4.0
#26ChatUsersImportResponse
allOf
uid: ChatUsersImportResponsePayload
object
command
string
status
number
Allowed values:
200
404
500
Additional properties are allowed.
object
array<array<any>>
array<any>
Additional properties are allowed.
#27ChatUsersGetFeedbackListRequest
allOf
object
offset
integer
Default value:0
limit
integer
Max number of elements to extract

Default value:25
Additional properties are allowed.
object
startFrom
required
string
endTo
required
string
Additional properties are allowed.
object
command
string
status
number
Allowed values:
200
404
500
Additional properties are allowed.
object
array<object>
uid: Feedback
vote
integer
text
string
sessionId
string
It contains the Session Id where feedback was submitted. It's used to create a URL link to open the chat directly.

userId
integer
name
string
User's name

surname
string
User's surname

email
string
User's email

createdAt
string
Timestamp

updatedAt
string
Timestamp

Additional properties are allowed.
schemaFormat
application/vnd.aai.asyncapi;version=2.4.0
#28ChatUsersGetFeedbackListResponse
allOf
uid: ChatUsersGetFeedbackListResponsePayload
object
command
string
status
number
Allowed values:
200
404
500
Additional properties are allowed.
object
array<object>
uid: Feedback
vote
integer
text
string
sessionId
string
It contains the Session Id where feedback was submitted. It's used to create a URL link to open the chat directly.

userId
integer
name
string
User's name

surname
string
User's surname

email
string
User's email

createdAt
string
Timestamp

updatedAt
string
Timestamp

Additional properties are allowed.
#29ChatUsersSetVariableRequest
object
uid: ChatUsersSetVariableRequestPayload
When is passed a variable_id an update will occur. If the variable object is passed a new variable will be created.

object
name
required
string
The Variable name to add

value
required
string
The Variable value

type
required
string
The Variable type. Default is "text"

Allowed values:
"text"
"number"
"date"
Additional properties are allowed.
required
array<number>
Array of Users' id to update a variable

Items:
number
Additional properties are allowed.
object
command
string
status
number
Allowed values:
200
404
500
Additional properties are allowed.
schemaFormat
application/vnd.aai.asyncapi;version=2.4.0
#30ChatUsersSetVariableResponse
allOf
uid: ChatUsersSetVariableResponsePayload
object
command
string
status
number
Allowed values:
200
404
500
Additional properties are allowed.
#31ChatUsersGetBotTagsRequest
object
command
string
status
number
Allowed values:
200
404
500
Additional properties are allowed.
array<object>
uid: Tag
id
integer
name
string
schemaFormat
application/vnd.aai.asyncapi;version=2.4.0
#32ChatUsersGetBotTagsResponse
allOf
uid: ChatUsersGetBotTagsResponsePayload
object
command
string
status
number
Allowed values:
200
404
500
Additional properties are allowed.
restricted any
array<object>
uid: Tag
id
integer
name
string
#33ChatUsersAddTagRequest
object
uid: ChatUsersAddTagRequestPayload
name
string
The Tag name to add

array<integer>
List of users id to add the tag

Items:
integer
Additional properties are allowed.
object
command
string
status
number
Allowed values:
200
404
500
Additional properties are allowed.
schemaFormat
application/vnd.aai.asyncapi;version=2.4.0
#34ChatUsersAddTagResponse
allOf
uid: ChatUsersAddTagResponsePayload
object
command
string
status
number
Allowed values:
200
404
500
Additional properties are allowed.
#35ChatUsersRemoveTagRequest
object
uid: ChatUsersRemoveElementRequestPayload
name
string
The Element name to add

array<integer>
List of users id affected

Items:
integer
deleteAll
boolean
if true, delete all the users with the given tag name

Additional properties are allowed.
object
command
string
status
number
Allowed values:
200
404
500
Additional properties are allowed.
schemaFormat
application/vnd.aai.asyncapi;version=2.4.0
#36ChatUsersRemoveTagResponse
allOf
uid: ChatUsersRemoveTagResponsePayload
object
command
string
status
number
Allowed values:
200
404
500
Additional properties are allowed.
#37ChatUsersCreateSegmentRequest
object
uid: ChatUsersCreateSegmentRequestPayload
name
string
The Segment name

array<object>
uid: SegmentFilter
List of filters applied that create the Segment structure

oneOf
Adheres to:
string
Or to:
integer
entity
string
type
string
Allowed values:
"variable"
"tag"
operator
string
Allowed values:
"is"
"is_not"
"has_any_value"
"contains"
"does_not_contain"
"begins_with"
"after"
"before"
"greater_than"
"less_than"
"greater_than_or_equal"
"less_than_or_equal"
Additional properties are allowed.
object
command
string
status
number
Allowed values:
200
404
500
Additional properties are allowed.
schemaFormat
application/vnd.aai.asyncapi;version=2.4.0
#38ChatUsersCreateSegmentResponse
allOf
uid: ChatUsersCreateSegmentResponsePayload
object
command
string
status
number
Allowed values:
200
404
500
Additional properties are allowed.
#39ChatUsersGetBotSegmentsRequest
object
command
string
status
number
Allowed values:
200
404
500
Additional properties are allowed.
array<object>
uid: Segment
id
integer
name
string
array<object>
uid: SegmentFilter
oneOf
Adheres to:
string
Or to:
integer
entity
string
type
string
Allowed values:
"variable"
"tag"
operator
string
Allowed values:
"is"
"is_not"
"has_any_value"
"contains"
"does_not_contain"
"begins_with"
"after"
"before"
"greater_than"
"less_than"
"greater_than_or_equal"
"less_than_or_equal"
schemaFormat
application/vnd.aai.asyncapi;version=2.4.0
#40ChatUsersGetBotSegmentsResponse
allOf
uid: ChatUsersGetBotSegmentsResponsePayload
object
command
string
status
number
Allowed values:
200
404
500
Additional properties are allowed.
restricted any
array<object>
uid: Segment
id
integer
name
string
array<object>
uid: SegmentFilter
oneOf
Adheres to:
string
Or to:
integer
entity
string
type
string
Allowed values:
"variable"
"tag"
operator
string
Allowed values:
"is"
"is_not"
"has_any_value"
"contains"
"does_not_contain"
"begins_with"
"after"
"before"
"greater_than"
"less_than"
"greater_than_or_equal"
"less_than_or_equal"
#41SitekeyUndefinedRequest
Start the communication with Userbot
This command is used to start the communication with Userbot. Example is "sitekey undefined bbfad81389103ba06485d07bfedb4036"

object
uid: SitekeyUndefinedRequestPayload
no payload is sent with this command at all

Additional properties are allowed.
name
sitekey
name
login
summary
Validates sitekey
object
uid: SitekeyUndefinedResponsePayload
command
string
Default value:"sitekey"
text
string
Describes the validation status of the key

status
integer
Total status code of the request

Examples values:
200
404
500
object
object
alert50
boolean
alert80
boolean
limitReached
boolean
type
string
Examples values:
"fair-use"
Additional properties are allowed.
Additional properties are allowed.
object
unique
integer
limit
integer
Additional properties are allowed.
object
Information about the customer

nome
string
Customer name

base_mail
string
Customer email

chats_start_interval
integer
chats_end_interval
integer
chat_limits
integer
ownerUserId
integer
User ID of the account owner

agentsLimit
integer
Limit of the agents that the customer can have

activeAgents
integer
Number of the active agents

Additional properties are allowed.
object
array<object>
The botID is the id of the bot

id
integer
Plugin ID

name
string
Plugin name

Examples values:
"obfuscate"
bot_id
integer
Bot ID

backend
boolean
dashboard
boolean
widgetchat
boolean
object
key
string
projectId
string
Additional properties are allowed.
Additional properties are allowed.
dashboard_token
string
Additional properties are allowed.
schemaFormat
application/vnd.aai.asyncapi;version=2.4.0
#sitekey
#login
#42SitekeyUndefinedResponse
Validates sitekey
object
uid: SitekeyUndefinedResponsePayload
command
string
Default value:"sitekey"
text
string
Describes the validation status of the key

status
integer
Total status code of the request

Examples values:
200
404
500
object
object
alert50
boolean
alert80
boolean
limitReached
boolean
type
string
Examples values:
"fair-use"
Additional properties are allowed.
Additional properties are allowed.
object
unique
integer
limit
integer
Additional properties are allowed.
object
Information about the customer

nome
string
Customer name

base_mail
string
Customer email

chats_start_interval
integer
chats_end_interval
integer
chat_limits
integer
ownerUserId
integer
User ID of the account owner

agentsLimit
integer
Limit of the agents that the customer can have

activeAgents
integer
Number of the active agents

Additional properties are allowed.
object
array<object>
The botID is the id of the bot

id
integer
Plugin ID

name
string
Plugin name

Examples values:
"obfuscate"
bot_id
integer
Bot ID

backend
boolean
dashboard
boolean
widgetchat
boolean
object
key
string
projectId
string
Additional properties are allowed.
Additional properties are allowed.
dashboard_token
string
Additional properties are allowed.
#sitekey
#login
#43ApiLoginApikeyRequest
Send the login request to Userbot
This command is used to authenticate the user with Userbot. Example is "apiLogin 123456789wasd"

object
uid: ApiLoginApikeyRequestPayload
No payload is sent with this command

Additional properties are allowed.
name
apiLogin
name
login
summary
Authenticate
object
uid: ApiLoginApikeyResponsePayload
text
string
Default value:"apiKey setted"
object
command
string
Default value:"apiLogin"
text
string
status
integer
Allowed values:
200
404
500
Additional properties are allowed.
Additional properties are allowed.
schemaFormat
application/vnd.aai.asyncapi;version=2.4.0
#apiLogin
#login
#44ApiLoginApikeyResponse
Authenticate
object
uid: ApiLoginApikeyResponsePayload
text
string
Default value:"apiKey setted"
object
command
string
Default value:"apiLogin"
text
string
status
integer
Allowed values:
200
404
500
Additional properties are allowed.
Additional properties are allowed.
#apiLogin
#login
#45BotStatsRequest
Get bot stats
This command is used to get bot stats

object
uid: BotStatsRequestPayload
type
string
Default value:"all"
Additional properties are allowed.
name
bot
summary
Sends all the stats for the bots of the user
object
uid: BotStatsResponsePayload
command
string
subcommand
string
text
string
status
integer
Allowed values:
200
401
500
object
array<any>
Items:
any
Additional properties are allowed.
Additional properties are allowed.
schemaFormat
application/vnd.aai.asyncapi;version=2.4.0
#bot
#46BotStatsResponse
Sends all the stats for the bots of the user
object
uid: BotStatsResponsePayload
command
string
subcommand
string
text
string
status
integer
Allowed values:
200
401
500
object
array<any>
Items:
any
Additional properties are allowed.
Additional properties are allowed.
#bot
#47QeafilterSearchPageDbAiRequest
Get interactions
This command is used to get the list of interactions. qeafilter search {[payload]}
object
uid: QeafilterSearchPageDbAiRequestPayload
created_from_date
string
created_to_date
string
text
string
array<integer>
Items:
integer
2 is for confirmed and trained interactions, 1 is for the "to approve" interactions

Allowed values:
1
2
array<object>
name
string
Group name

counter
integer
The number of interactions in the group

selected
boolean
id
integer
ID of the group

limit_from
integer
limit_to
integer
Additional properties are allowed.
name
qeafilter
summary
Returns the information about the interactions
object
uid: QeafilterSearchPageDbAiResponsePayload
command
string
Default value:"qeafilter"
subcommand
string
Default value:"search"
token
string
Default value:"page-db-ai"
array<object>
ai
integer
Indicates if an interaction is trained

label
string
quando
integer
The time of creation of the interaction, timestamp

fallback
integer
flows_startingPoint
integer
array<object>
name
string
Group name

counter
integer
The number of interactions in the group

selected
boolean
id
integer
ID of the group

flows_id
integer
flows_step
boolean
flows_block_order
integer
flows_name
string
array<string>
Items:
string
It is the answer of the bot to the interaction. Buttons is sent in case the request contains buttons keyword

Examples values:
"bot answer {\"buttons\":[{\"key\":\"button-id-80\",\"title\":\"Click\",\"action\":\"text\",\"content\":\"Clicked\",\"dirty\":true}]}"
topics_text
string
topics_log
boolean
intent
string
ai_1_pending
integer
Counts the amount of pending so not yet trained interactions

ai_1_trained
integer
Counts the total trained interactions

count
integer
countFiltered
integer
object
array<object>
The botID is the id of the bot

id
integer
Plugin ID

name
string
Plugin name

Examples values:
"obfuscate"
bot_id
integer
Bot ID

backend
boolean
dashboard
boolean
widgetchat
boolean
object
key
string
projectId
string
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
schemaFormat
application/vnd.aai.asyncapi;version=2.4.0
#qeafilter
#48QeafilterSearchPageDbAiResponse
Returns the information about the interactions
object
uid: QeafilterSearchPageDbAiResponsePayload
command
string
Default value:"qeafilter"
subcommand
string
Default value:"search"
token
string
Default value:"page-db-ai"
array<object>
ai
integer
Indicates if an interaction is trained

label
string
quando
integer
The time of creation of the interaction, timestamp

fallback
integer
flows_startingPoint
integer
array<object>
name
string
Group name

counter
integer
The number of interactions in the group

selected
boolean
id
integer
ID of the group

flows_id
integer
flows_step
boolean
flows_block_order
integer
flows_name
string
array<string>
Items:
string
It is the answer of the bot to the interaction. Buttons is sent in case the request contains buttons keyword

Examples values:
"bot answer {\"buttons\":[{\"key\":\"button-id-80\",\"title\":\"Click\",\"action\":\"text\",\"content\":\"Clicked\",\"dirty\":true}]}"
topics_text
string
topics_log
boolean
intent
string
ai_1_pending
integer
Counts the amount of pending so not yet trained interactions

ai_1_trained
integer
Counts the total trained interactions

count
integer
countFiltered
integer
object
array<object>
The botID is the id of the bot

id
integer
Plugin ID

name
string
Plugin name

Examples values:
"obfuscate"
bot_id
integer
Bot ID

backend
boolean
dashboard
boolean
widgetchat
boolean
object
key
string
projectId
string
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
#qeafilter
#49QeafilterSaveRequest
Save an interaction
This command is used to save an interaction
object
uid: QeafilterSaveRequestPayload
label
string
name
string
The name of the interaction

array<object>
name
string
Group name

counter
integer
The number of interactions in the group

selected
boolean
id
integer
ID of the group

array<object>
The user questions for the interaction

name
string
id
integer
deep_learning
boolean
array<object>
The Bot answer to the user questions

name
string
flows_id
integer
fallback-team
string
array<object>
key
string
Key of the button

title
string
The text on the button

action
string
The type of action the button computes. If you jump to interaction/flow, the action is "goto"; for url is "url", for text message is "text"

Examples values:
" "buttons": [ { "key": "button-id-41", "title": "link", "action": "url", "content": "https://userbot.ai", "dirty": true }], "buttons": [ { "action": "goto", "title": "Click", "key": "button-id-34", "content": "Ciao", "dirty": false, "label": "Greeting" }], "buttons": [ { "action": "goto", "title": "Click", "flows_id": 2409, "key": "button-id-34", "content": "Flusso di benvenuto", "dirty": false, "flows_startMessageLabel": "2409-operator1-0-0" }], "buttons": [ { "key": "button-id-41", "title": "click", "action": "text", "content": "ciaoo", "dirty": true }]"
content
string
The content of the button action

dirty
boolean
label
string
The label of the interaction where the button jumps. This is to be sent when creating a button that jumps to an interaction

flows_startMessageLabel
string
The identification of the flow operator where the button jumps. This is to be sent when creating a button that jumps to a flow operator

Additional properties are allowed.
name
qeafilter
summary
Returns the information about the interaction saved
object
uid: QeafilterSaveResponsePayload
command
string
Default value:"qeafilter"
subcommand
string
Default value:"save"
token
string
Default value:""
text
string
Default value:"qeafilter command"
result
string
Examples values:
"OK"
insertedCount
integer
object
ai
integer
Default value:2
label
string
quando
integer
A timestamp of the creation of the record

fallback
integer
flows_startingPoint
string
object
name
string
Group name

counter
integer
The number of interactions in the group

selected
boolean
id
integer
ID of the group

Additional properties are allowed.
flows_id
integer
flows_step
integer
flows_block_order
integer
flows_name
string
array<string>
Items:
string
It is the answer of the bot to the interaction. Buttons is sent in case the request contains buttons keyword

Examples values:
"bot answer {\"buttons\":[{\"key\":\"button-id-80\",\"title\":\"Click\",\"action\":\"text\",\"content\":\"Clicked\",\"dirty\":true}]}"
array<object>
id
integer
question_nl
string
the question of the interaction

deep_learning
boolean
A flag set to true if the interaction is of type "è simile a", set to false for "è esattamente", not present for "contiene le parole"

topics_text
string
topics_log
boolean
Additional properties are allowed.
array<integer>
Items:
integer
Contains the id of the qea record inserted

object
array<object>
The botID is the id of the bot

id
integer
Plugin ID

name
string
Plugin name

Examples values:
"obfuscate"
bot_id
integer
Bot ID

backend
boolean
dashboard
boolean
widgetchat
boolean
object
key
string
projectId
string
Additional properties are allowed.
Additional properties are allowed.
dashboard_token
string
Additional properties are allowed.
schemaFormat
application/vnd.aai.asyncapi;version=2.4.0
#qeafilter
#50QeafilterSaveResponse
Returns the information about the interaction saved
object
uid: QeafilterSaveResponsePayload
command
string
Default value:"qeafilter"
subcommand
string
Default value:"save"
token
string
Default value:""
text
string
Default value:"qeafilter command"
result
string
Examples values:
"OK"
insertedCount
integer
object
ai
integer
Default value:2
label
string
quando
integer
A timestamp of the creation of the record

fallback
integer
flows_startingPoint
string
object
name
string
Group name

counter
integer
The number of interactions in the group

selected
boolean
id
integer
ID of the group

Additional properties are allowed.
flows_id
integer
flows_step
integer
flows_block_order
integer
flows_name
string
array<string>
Items:
string
It is the answer of the bot to the interaction. Buttons is sent in case the request contains buttons keyword

Examples values:
"bot answer {\"buttons\":[{\"key\":\"button-id-80\",\"title\":\"Click\",\"action\":\"text\",\"content\":\"Clicked\",\"dirty\":true}]}"
array<object>
id
integer
question_nl
string
the question of the interaction

deep_learning
boolean
A flag set to true if the interaction is of type "è simile a", set to false for "è esattamente", not present for "contiene le parole"

topics_text
string
topics_log
boolean
Additional properties are allowed.
array<integer>
Items:
integer
Contains the id of the qea record inserted

object
array<object>
The botID is the id of the bot

id
integer
Plugin ID

name
string
Plugin name

Examples values:
"obfuscate"
bot_id
integer
Bot ID

backend
boolean
dashboard
boolean
widgetchat
boolean
object
key
string
projectId
string
Additional properties are allowed.
Additional properties are allowed.
dashboard_token
string
Additional properties are allowed.
#qeafilter
#51QeafilterSaveTokenRequest
Update an interaction
This command is used to save an interaction. The token is the interaction label, it is sent between "<" and ">"
object
uid: QeafilterSaveTokenRequestPayload
label
string
name
string
The name of the interaction

array<object>
name
string
Group name

counter
integer
The number of interactions in the group

selected
boolean
id
integer
ID of the group

array<object>
The user questions for the interaction

name
string
id
integer
deep_learning
boolean
array<object>
The Bot answer to the user questions

name
string
flows_id
integer
flows_startMessageLabel
string
The identification of the flow operator where the button jumps. This is to be sent when creating a button that jumps to a flow operator

fallback-team
string
array<object>
key
string
Key of the button

title
string
The text on the button

action
string
The type of action the button computes. If you jump to interaction/flow, the action is "goto"; for url is "url", for text message is "text"

Examples values:
" "buttons": [ { "key": "button-id-41", "title": "link", "action": "url", "content": "https://userbot.ai", "dirty": true }], "buttons": [ { "action": "goto", "title": "Click", "key": "button-id-34", "content": "Ciao", "dirty": false, "label": "Greeting" }], "buttons": [ { "action": "goto", "title": "Click", "flows_id": 2409, "key": "button-id-34", "content": "Flusso di benvenuto", "dirty": false, "flows_startMessageLabel": "2409-operator1-0-0" }], "buttons": [ { "key": "button-id-41", "title": "click", "action": "text", "content": "ciaoo", "dirty": true }]"
content
string
The content of the button action

dirty
boolean
label
string
The label of the interaction where the button jumps. This is to be sent when creating a button that jumps to an interaction

flows_startMessageLabel
string
The identification of the flow operator where the button jumps. This is to be sent when creating a button that jumps to a flow operator

Additional properties are allowed.
name
qeafilter
summary
Returns the information about the interaction updated
object
uid: QeafilterSaveTokenResponsePayload
command
string
Default value:"qeafilter"
subcommand
string
Default value:"save"
token
string
Default value:"interactionName"
text
string
Default value:"qeafilter command"
result
string
Examples values:
"OK"
insertedCount
integer
object
ai
integer
Default value:2
label
string
quando
integer
A timestamp of the creation of the record

fallback
integer
flows_startingPoint
string
object
name
string
Group name

counter
integer
The number of interactions in the group

selected
boolean
id
integer
ID of the group

Additional properties are allowed.
flows_id
integer
flows_step
integer
flows_block_order
integer
flows_name
string
array<string>
Items:
string
It is the answer of the bot to the interaction. Buttons is sent in case the request contains buttons keyword

Examples values:
"bot answer {\"buttons\":[{\"key\":\"button-id-80\",\"title\":\"Click\",\"action\":\"text\",\"content\":\"Clicked\",\"dirty\":true}]}"
array<object>
id
integer
question_nl
string
the question of the interaction

deep_learning
boolean
A flag set to true if the interaction is of type "è simile a", set to false for "è esattamente", not present for "contiene le parole"

topics_text
string
topics_log
boolean
Additional properties are allowed.
array<integer>
Items:
integer
Contains the id of the qea record inserted

object
array<object>
The botID is the id of the bot

id
integer
Plugin ID

name
string
Plugin name

Examples values:
"obfuscate"
bot_id
integer
Bot ID

backend
boolean
dashboard
boolean
widgetchat
boolean
object
key
string
projectId
string
Additional properties are allowed.
Additional properties are allowed.
dashboard_token
string
Additional properties are allowed.
schemaFormat
application/vnd.aai.asyncapi;version=2.4.0
#qeafilter
#52QeafilterSaveTokenResponse
Returns the information about the interaction updated
object
uid: QeafilterSaveTokenResponsePayload
command
string
Default value:"qeafilter"
subcommand
string
Default value:"save"
token
string
Default value:"interactionName"
text
string
Default value:"qeafilter command"
result
string
Examples values:
"OK"
insertedCount
integer
object
ai
integer
Default value:2
label
string
quando
integer
A timestamp of the creation of the record

fallback
integer
flows_startingPoint
string
object
name
string
Group name

counter
integer
The number of interactions in the group

selected
boolean
id
integer
ID of the group

Additional properties are allowed.
flows_id
integer
flows_step
integer
flows_block_order
integer
flows_name
string
array<string>
Items:
string
It is the answer of the bot to the interaction. Buttons is sent in case the request contains buttons keyword

Examples values:
"bot answer {\"buttons\":[{\"key\":\"button-id-80\",\"title\":\"Click\",\"action\":\"text\",\"content\":\"Clicked\",\"dirty\":true}]}"
array<object>
id
integer
question_nl
string
the question of the interaction

deep_learning
boolean
A flag set to true if the interaction is of type "è simile a", set to false for "è esattamente", not present for "contiene le parole"

topics_text
string
topics_log
boolean
Additional properties are allowed.
array<integer>
Items:
integer
Contains the id of the qea record inserted

object
array<object>
The botID is the id of the bot

id
integer
Plugin ID

name
string
Plugin name

Examples values:
"obfuscate"
bot_id
integer
Bot ID

backend
boolean
dashboard
boolean
widgetchat
boolean
object
key
string
projectId
string
Additional properties are allowed.
Additional properties are allowed.
dashboard_token
string
Additional properties are allowed.
#qeafilter
#53QeafilterDeleteRequest
Delete an interaction
This command is used to delete an existing interaction
object
uid: QeafilterDeleteRequestPayload
array<string>
Items:
string
interaction label to be deleted, if a bulk action is performed, all the interaction labels to be deleted are inserted in this array

Examples values:
"interactionLabel"
Additional properties are allowed.
name
qeafilter
summary
Returns the information about the interaction deleted and the status of the operation
object
uid: QeafilterDeleteResponsePayload
command
string
Default value:"qeafilter"
subcommand
string
Default value:"delete"
token
string
Default value:null
text
string
Default value:"qeafilter command"
result
string
Examples values:
"success"
array<string>
Items:
string
The interaction labels to be deleted

bulk
boolean
True if more than one interaction needs to be deleted

object
array<object>
The botID is the id of the bot

id
integer
Plugin ID

name
string
Plugin name

Examples values:
"obfuscate"
bot_id
integer
Bot ID

backend
boolean
dashboard
boolean
widgetchat
boolean
object
key
string
projectId
string
Additional properties are allowed.
Additional properties are allowed.
dashboard_token
string
Default value:null
Additional properties are allowed.
schemaFormat
application/vnd.aai.asyncapi;version=2.4.0
#qeafilter
#54QeafilterDeleteResponse
Returns the information about the interaction deleted and the status of the operation
object
uid: QeafilterDeleteResponsePayload
command
string
Default value:"qeafilter"
subcommand
string
Default value:"delete"
token
string
Default value:null
text
string
Default value:"qeafilter command"
result
string
Examples values:
"success"
array<string>
Items:
string
The interaction labels to be deleted

bulk
boolean
True if more than one interaction needs to be deleted

object
array<object>
The botID is the id of the bot

id
integer
Plugin ID

name
string
Plugin name

Examples values:
"obfuscate"
bot_id
integer
Bot ID

backend
boolean
dashboard
boolean
widgetchat
boolean
object
key
string
projectId
string
Additional properties are allowed.
Additional properties are allowed.
dashboard_token
string
Default value:null
Additional properties are allowed.
#qeafilter
#55AutomatedMessagesGetRequest
Ask a list of automated messages on a Bot
summary
List of automated messages on a Bot
object
uid: AutomatedMessagesGetResponsePayload
array<object>
id
integer
name
string
order
integer
object
uid: Answer
text
string
flows_id
integer
flows_step
string
created_at
integer
Timestamp

updated_at
integer
Timestamp

Additional properties are allowed.
array<object>
id
integer
entity
string
Allowed values:
"page_url"
"referrer"
"time_spent"
"site_visited_counter"
operator
string
Allowed values:
"is"
"is_not"
"has_any_value"
"contains"
"does_not_contain"
"greater_than"
"greater_than_or_equal"
oneOf
Adheres to:
string
Or to:
integer
Or to:
boolean
created_at
integer
Timestamp

updated_at
integer
Timestamp

created_at
integer
Timestamp

updated_at
integer
Timestamp

Additional properties are allowed.
schemaFormat
application/vnd.aai.asyncapi;version=2.4.0
#56AutomatedMessagesGetResponse
List of automated messages on a Bot
object
uid: AutomatedMessagesGetResponsePayload
array<object>
id
integer
name
string
order
integer
object
uid: Answer
text
string
flows_id
integer
flows_step
string
created_at
integer
Timestamp

updated_at
integer
Timestamp

Additional properties are allowed.
array<object>
id
integer
entity
string
Allowed values:
"page_url"
"referrer"
"time_spent"
"site_visited_counter"
operator
string
Allowed values:
"is"
"is_not"
"has_any_value"
"contains"
"does_not_contain"
"greater_than"
"greater_than_or_equal"
oneOf
Adheres to:
string
Or to:
integer
Or to:
boolean
created_at
integer
Timestamp

updated_at
integer
Timestamp

created_at
integer
Timestamp

updated_at
integer
Timestamp

Additional properties are allowed.
#57AutomatedMessagesDeleteRequest
object
uid: AutomatedMessagesDeleteRequestPayload
required
array<integer>
List of Automated Messages' id to delete from database

Items:
integer
Additional properties are allowed.
object
command
string
status
number
Allowed values:
200
404
500
Additional properties are allowed.
object
array<integer>
Items:
integer
Additional properties are allowed.
schemaFormat
application/vnd.aai.asyncapi;version=2.4.0
#58AutomatedMessagesDeleteResponse
allOf
uid: AutomatedMessagesDeleteResponsePayload
object
command
string
status
number
Allowed values:
200
404
500
Additional properties are allowed.
object
array<integer>
Items:
integer
Additional properties are allowed.
#59AutomatedMessagesSaveRequest
object
uid: AutomatedMessagesSaveRequestPayload
required
array<object>
name
required
string
order
required
integer
required
object
text
string
flows_id
integer
flows_step
string
Additional properties are allowed.
array<object>
entity
string
operator
string
value
string
Additional properties are allowed.
object
command
string
status
number
Allowed values:
200
404
500
Additional properties are allowed.
object
array<object>
id
integer
name
string
order
integer
object
uid: Answer
text
string
flows_id
integer
flows_step
string
created_at
integer
Timestamp

updated_at
integer
Timestamp

Additional properties are allowed.
array<object>
id
integer
entity
string
Allowed values:
"page_url"
"referrer"
"time_spent"
"site_visited_counter"
operator
string
Allowed values:
"is"
"is_not"
"has_any_value"
"contains"
"does_not_contain"
"greater_than"
"greater_than_or_equal"
oneOf
Adheres to:
string
Or to:
integer
Or to:
boolean
created_at
integer
Timestamp

updated_at
integer
Timestamp

created_at
integer
Timestamp

updated_at
integer
Timestamp

Additional properties are allowed.
schemaFormat
application/vnd.aai.asyncapi;version=2.4.0
#60AutomatedMessagesSaveResponse
allOf
uid: AutomatedMessagesSaveResponsePayload
object
command
string
status
number
Allowed values:
200
404
500
Additional properties are allowed.
object
array<object>
id
integer
name
string
order
integer
object
uid: Answer
text
string
flows_id
integer
flows_step
string
created_at
integer
Timestamp

updated_at
integer
Timestamp

Additional properties are allowed.
array<object>
id
integer
entity
string
Allowed values:
"page_url"
"referrer"
"time_spent"
"site_visited_counter"
operator
string
Allowed values:
"is"
"is_not"
"has_any_value"
"contains"
"does_not_contain"
"greater_than"
"greater_than_or_equal"
oneOf
Adheres to:
string
Or to:
integer
Or to:
boolean
created_at
integer
Timestamp

updated_at
integer
Timestamp

created_at
integer
Timestamp

updated_at
integer
Timestamp

Additional properties are allowed.
#61RawstatsCountNpsRequest
Ask NPS in a period
This command is used to get NPS stats in a period [from]-[to]
object
uid: RawstatsCountNpsRequestPayload
from
string
The start date, format is complete ISO-8601 date

Examples values:
"2022-05-23T22:00:00.000Z"
to
string
The end date, format is complete ISO-8601 date

Examples values:
"2022-05-25T21:59:59.999Z"
Additional properties are allowed.
name
stats
name
nps
summary
Ask NPS values between dates
description
Client can ask for NPS values get from Webchat during conversation. Values are divided in negative, positive, neutral
object
uid: RawstatsCountNpsResponsePayload
command
string
Default value:"rawstats"
subcommand
string
Default value:"count-nps"
response
string
Default value:"OK"
object
positive
integer
Average of positive scores (9,10) from ChatUsers

neutral
integer
Average of neutral scores (7,8) from ChatUsers

negative
integer
Average of negative scores (1-6) from ChatUsers

Additional properties are allowed.
object
array<object>
The botID is the id of the bot

id
integer
Plugin ID

name
string
Plugin name

Examples values:
"obfuscate"
bot_id
integer
Bot ID

backend
boolean
dashboard
boolean
widgetchat
boolean
object
key
string
projectId
string
Additional properties are allowed.
Additional properties are allowed.
dashboard_token
string
Default value:null
Additional properties are allowed.
schemaFormat
application/vnd.aai.asyncapi;version=2.4.0
#stats
#62RawstatsCountNpsResponse
Ask NPS values between dates
Client can ask for NPS values get from Webchat during conversation. Values are divided in negative, positive, neutral
object
uid: RawstatsCountNpsResponsePayload
command
string
Default value:"rawstats"
subcommand
string
Default value:"count-nps"
response
string
Default value:"OK"
object
positive
integer
Average of positive scores (9,10) from ChatUsers

neutral
integer
Average of neutral scores (7,8) from ChatUsers

negative
integer
Average of negative scores (1-6) from ChatUsers

Additional properties are allowed.
object
array<object>
The botID is the id of the bot

id
integer
Plugin ID

name
string
Plugin name

Examples values:
"obfuscate"
bot_id
integer
Bot ID

backend
boolean
dashboard
boolean
widgetchat
boolean
object
key
string
projectId
string
Additional properties are allowed.
Additional properties are allowed.
dashboard_token
string
Default value:null
Additional properties are allowed.
#stats
#nps
#63RawstatsAllRequest
Ask insights for the bot
This command is used to get insights
object
uid: RawstatsAllRequestPayload
from
string
The start date of the insights, format is complete ISO-8601 date

Examples values:
"2022-05-23T22:00:00.000Z"
to
string
The end date of the insights, format is complete ISO-8601 date

Examples values:
"2022-05-25T21:59:59.999Z"
Additional properties are allowed.
name
stats
summary
Returns the insights for the bot in the range from-to, divided per day
object
uid: RawstatsAllResponsePayload
command
string
Default value:"rawstats"
subcommand
string
Default value:"all"
response
string
Examples values:
"OK"
statuscode
integer
Examples values:
"200"
"404"
"500"
object
array<object>
messages
integer
Total messages of the day

resolved
integer
Total messages resolved of the day

resolvedByHuman
integer
Total messages resolved by an agent of the day

resolvedByBot
integer
Total messages resolved by bot of the day

resolvedByBotWithHints
integer
Total messages resolved by bot with hints of the day

notManagedByBot
integer
Total messages not resolved by bot for the day

avgResponseHuman
integer
Average response time of the agent of the day

avgResponseBot
integer
Average response time of the bot of the day

messages_human
integer
Total messages by an agent of the day

messages_user
integer
Total messages by an user of the day

conversations_bot
integer
Total conversations managed by bot of the day

conversations_human
integer
Total conversations managed by agent of the day

sessions
integer
Total conversations of the day

day
string
Examples values:
"2022-05-24"
object
object
resolvedByHumans
integer
The total messages resolved by an agent

upscaledToHumans
integer
The total messages upscaled to human

resolvedByBot
integer
The total messages resolved by Bot

resolvedByBotWithHints
integer
The total messages resolved by Bot with hints

count
integer
notManagedByBot
integer
The total messages not managed by Bot

Additional properties are allowed.
object
upscaled
integer
The total chats upscaled to agent

resolvedByBot
integer
The total chats resolved by Bot

count
integer
Additional properties are allowed.
avgResponseHuman
integer
The average time an agent answers to an upscaled conversation

Additional properties are allowed.
Additional properties are allowed.
object
array<object>
The botID is the id of the bot

id
integer
Plugin ID

name
string
Plugin name

Examples values:
"obfuscate"
bot_id
integer
Bot ID

backend
boolean
dashboard
boolean
widgetchat
boolean
object
key
string
projectId
string
Additional properties are allowed.
Additional properties are allowed.
dashboard_token
string
Default value:null
Additional properties are allowed.
schemaFormat
application/vnd.aai.asyncapi;version=2.4.0
#stats
#64RawstatsAllResponse
Returns the insights for the bot in the range from-to, divided per day
object
uid: RawstatsAllResponsePayload
command
string
Default value:"rawstats"
subcommand
string
Default value:"all"
response
string
Examples values:
"OK"
statuscode
integer
Examples values:
"200"
"404"
"500"
object
array<object>
messages
integer
Total messages of the day

resolved
integer
Total messages resolved of the day

resolvedByHuman
integer
Total messages resolved by an agent of the day

resolvedByBot
integer
Total messages resolved by bot of the day

resolvedByBotWithHints
integer
Total messages resolved by bot with hints of the day

notManagedByBot
integer
Total messages not resolved by bot for the day

avgResponseHuman
integer
Average response time of the agent of the day

avgResponseBot
integer
Average response time of the bot of the day

messages_human
integer
Total messages by an agent of the day

messages_user
integer
Total messages by an user of the day

conversations_bot
integer
Total conversations managed by bot of the day

conversations_human
integer
Total conversations managed by agent of the day

sessions
integer
Total conversations of the day

day
string
Examples values:
"2022-05-24"
object
object
resolvedByHumans
integer
The total messages resolved by an agent

upscaledToHumans
integer
The total messages upscaled to human

resolvedByBot
integer
The total messages resolved by Bot

resolvedByBotWithHints
integer
The total messages resolved by Bot with hints

count
integer
notManagedByBot
integer
The total messages not managed by Bot

Additional properties are allowed.
object
upscaled
integer
The total chats upscaled to agent

resolvedByBot
integer
The total chats resolved by Bot

count
integer
Additional properties are allowed.
avgResponseHuman
integer
The average time an agent answers to an upscaled conversation

Additional properties are allowed.
Additional properties are allowed.
object
array<object>
The botID is the id of the bot

id
integer
Plugin ID

name
string
Plugin name

Examples values:
"obfuscate"
bot_id
integer
Bot ID

backend
boolean
dashboard
boolean
widgetchat
boolean
object
key
string
projectId
string
Additional properties are allowed.
Additional properties are allowed.
dashboard_token
string
Default value:null
Additional properties are allowed.
#stats
#65RawstatsCountMessagesRequest
Ask total messages in a period
This command is used to get the total amount of messages in a period
object
uid: RawstatsCountMessagesRequestPayload
from
string
The start date, format is complete ISO-8601 date

Examples values:
"2022-05-23T22:00:00.000Z"
to
string
The end date, format is complete ISO-8601 date

Examples values:
"2022-05-25T21:59:59.999Z"
Additional properties are allowed.
name
stats
summary
Return total messages in a period
object
uid: RawstatsCountMessagesResponsePayload
command
string
Default value:"rawstats"
subcommand
string
Default value:"count-messages"
response
string
Examples values:
"OK"
statuscode
integer
Examples values:
"200"
"404"
"500"
object
count
integer
The total amount of messages for the period asked

Additional properties are allowed.
object
array<object>
The botID is the id of the bot

id
integer
Plugin ID

name
string
Plugin name

Examples values:
"obfuscate"
bot_id
integer
Bot ID

backend
boolean
dashboard
boolean
widgetchat
boolean
object
key
string
projectId
string
Additional properties are allowed.
Additional properties are allowed.
dashboard_token
string
Default value:null
Additional properties are allowed.
schemaFormat
application/vnd.aai.asyncapi;version=2.4.0
#stats
#66RawstatsCountMessagesResponse
Return total messages in a period
object
uid: RawstatsCountMessagesResponsePayload
command
string
Default value:"rawstats"
subcommand
string
Default value:"count-messages"
response
string
Examples values:
"OK"
statuscode
integer
Examples values:
"200"
"404"
"500"
object
count
integer
The total amount of messages for the period asked

Additional properties are allowed.
object
array<object>
The botID is the id of the bot

id
integer
Plugin ID

name
string
Plugin name

Examples values:
"obfuscate"
bot_id
integer
Bot ID

backend
boolean
dashboard
boolean
widgetchat
boolean
object
key
string
projectId
string
Additional properties are allowed.
Additional properties are allowed.
dashboard_token
string
Default value:null
Additional properties are allowed.
#stats
#67RawstatsCountSessionsRequest
Ask total sessions in a period
This command is used to get the total amount of sessions in a period
object
uid: RawstatsCountSessionsRequestPayload
from
string
The start date, format is complete ISO-8601 date

Examples values:
"2022-05-23T22:00:00.000Z"
to
string
The end date, format is complete ISO-8601 date

Examples values:
"2022-05-25T21:59:59.999Z"
Additional properties are allowed.
name
stats
summary
Return total sessions in a period
object
uid: RawstatsCountSessionsResponsePayload
command
string
Default value:"rawstats"
subcommand
string
Default value:"count-sessions"
response
string
Examples values:
"OK"
statuscode
integer
Examples values:
"200"
"404"
"500"
object
count
integer
The total amount of chat sessions in the period asked

Additional properties are allowed.
object
array<object>
The botID is the id of the bot

id
integer
Plugin ID

name
string
Plugin name

Examples values:
"obfuscate"
bot_id
integer
Bot ID

backend
boolean
dashboard
boolean
widgetchat
boolean
object
key
string
projectId
string
Additional properties are allowed.
Additional properties are allowed.
dashboard_token
string
Default value:null
Additional properties are allowed.
schemaFormat
application/vnd.aai.asyncapi;version=2.4.0
#stats
#68RawstatsCountSessionsResponse
Return total sessions in a period
object
uid: RawstatsCountSessionsResponsePayload
command
string
Default value:"rawstats"
subcommand
string
Default value:"count-sessions"
response
string
Examples values:
"OK"
statuscode
integer
Examples values:
"200"
"404"
"500"
object
count
integer
The total amount of chat sessions in the period asked

Additional properties are allowed.
object
array<object>
The botID is the id of the bot

id
integer
Plugin ID

name
string
Plugin name

Examples values:
"obfuscate"
bot_id
integer
Bot ID

backend
boolean
dashboard
boolean
widgetchat
boolean
object
key
string
projectId
string
Additional properties are allowed.
Additional properties are allowed.
dashboard_token
string
Default value:null
Additional properties are allowed.
#stats
#69RawstatsGetRequest
Ask sales stats in a period
This command is used to get the sales stats in a period
object
uid: RawstatsGetRequestPayload
startFrom
string
The start date, format is complete ISO-8601 date

Examples values:
"2022-05-23T22:00:00.000Z"
endTo
string
The end date, format is complete ISO-8601 date

Examples values:
"2022-05-25T21:59:59.999Z"
Additional properties are allowed.
name
stats
summary
Return sales stats in a period
object
uid: RawstatsGetResponsePayload
command
string
Default value:"rawstats"
subcommand
string
Default value:"get"
response
string
Examples values:
"OK"
statuscode
integer
Examples values:
"200"
"404"
"500"
object
object
companies stats

totalCompanies
integer
the total amount of companies

newCompanies
integer
the new companies

array<any>
company
string
the name of the company

employees
integer
the number of employees of the company

Additional properties are allowed.
object
conversations stats

totalConversations
integer
total amount of conversations

Additional properties are allowed.
object
industries stats

array<any>
industry
string
occurrence
integer
Additional properties are allowed.
object
email stats

totalEmailsCaptured
number
Additional properties are allowed.
object
meetings data

totalMeetingsScheduled
number
Additional properties are allowed.
Additional properties are allowed.
object
array<object>
The botID is the id of the bot

id
integer
Plugin ID

name
string
Plugin name

Examples values:
"obfuscate"
bot_id
integer
Bot ID

backend
boolean
dashboard
boolean
widgetchat
boolean
object
key
string
projectId
string
Additional properties are allowed.
Additional properties are allowed.
dashboard_token
string
Default value:null
Additional properties are allowed.
schemaFormat
application/vnd.aai.asyncapi;version=2.4.0
#stats
#70RawstatsGetResponse
Return sales stats in a period
object
uid: RawstatsGetResponsePayload
command
string
Default value:"rawstats"
subcommand
string
Default value:"get"
response
string
Examples values:
"OK"
statuscode
integer
Examples values:
"200"
"404"
"500"
object
object
companies stats

totalCompanies
integer
the total amount of companies

newCompanies
integer
the new companies

array<any>
company
string
the name of the company

employees
integer
the number of employees of the company

Additional properties are allowed.
object
conversations stats

totalConversations
integer
total amount of conversations

Additional properties are allowed.
object
industries stats

array<any>
industry
string
occurrence
integer
Additional properties are allowed.
object
email stats

totalEmailsCaptured
number
Additional properties are allowed.
object
meetings data

totalMeetingsScheduled
number
Additional properties are allowed.
Additional properties are allowed.
object
array<object>
The botID is the id of the bot

id
integer
Plugin ID

name
string
Plugin name

Examples values:
"obfuscate"
bot_id
integer
Bot ID

backend
boolean
dashboard
boolean
widgetchat
boolean
object
key
string
projectId
string
Additional properties are allowed.
Additional properties are allowed.
dashboard_token
string
Default value:null
Additional properties are allowed.
#stats
#71IntelLeadlistResponse
The List of leads
Carries an array of objects describing the lead companies that have visited the Userbot's customer site

array<object>
id
number
lead identifier

name
string
the company name

logo
string
the url of the company logo

city
string
the city in which the company resides

industry
string
the sector in which the company operates

description
string
a short description of the company

size
number
the number of employes working in the company

legalAddress
string
address of the company office

url
string
site or main social url

temperature
number
between 1 and 3: 1 cold, 2 warm, 3 hot

visits
number
number of different pages

timeOnPages
number
time spent on pages

lastVisit
string
last visit of the lead
#intel
#72IntelVisitdetailsRequest
Request the list of visited pages and times
Query for all the user navigation record stored

object
uid: IntelVisitdetailsRequestPayload
id
number
lead identifier

Additional properties are allowed.
#intel
#73IntelVisitdetailsResponse
Receive of visited pages and times
Carries an array of objects consisting in the page url, the ISO UTC date in which the user landed and the one in which he left the Userbot's customer site

array<object>
url
string
the url of the visited page

enter
string
the ISO UTC date in which the user landed in the page

leave
string
the ISO UTC date in which the user left the page

session
number
It can be used to follow the pages visited by a user
#intel
#74IntelKeypeopleRequest
The List of key people
Query for an array of key people's contacts in a company

object
uid: IntelKeypeopleRequestPayload
id
number
lead identifier

Additional properties are allowed.
#intel
#75IntelKeypeopleResponse
The List of key people
Carries the array of objects consisting in the name, surname and contacts of the key people in a company

array<object>
fullname
string
photo
string
Linkedin
string
role
string
#intel
#76IntelAddTagRequest
Adds a tag for a company
Carries the array of objects consisting in the name, surname and contacts of the key people in a company

object
uid: IntelAddTagRequestPayload
company
number
customer
number
tagname
string
Additional properties are allowed.
#intel
#77IntelRemoveTagRequest
Adds a tag for a company
Carries the array of objects consisting in the name, surname and contacts of the key people in a company

object
uid: IntelRemoveTagRequestPayload
company
number
customer
number
tagname
string
Additional properties are allowed.
#intel
#78MeetingsScheduleRequest
object
uid: MeetingsScheduleRequestPayload
eventUrl
string
It contains a url to use with Calendly API to get the details of an event

Examples values:
"https://api.calendly.com/scheduled_events/c1deba23-dbcb-4b34-890e-f5d8d908091c"
inviteeUrl
string
It contains a url to use with Calendly API to get the invitee of an event

Examples values:
"https://api.calendly.com/scheduled_events/c1deba23-dbcb-4b34-890e-f5d8d908091c/invitees/f2bcd809-d909-4082-9876-a20e93d03b1f"
Additional properties are allowed.
#meetings
#79MeetingsDeclineRequest
#meetings

Schemas

allOf
uid: BotGetVarsResponsePayload
object
command
string
status
number
Allowed values:
200
404
500
Additional properties are allowed.
restricted any
array<object>
id
number
name
string
type
string
Allowed values:
"text"
bot_id
number
uuid
string
WhoRequestPayload
string
uid: WhoRequestPayload
Default value:"who"
object
uid: WhoResponsePayload
command
string
Default value:"who"
text
string
An information about the user

Examples values:
"You are:user.username(display_username)"
object
username
string
customer_id
integer
userLevel
integer
object
id
integer
nickname
string
email
string
md5_email
string
phone
string
password
string
nome
string
cognome
string
birth
string
pic
string
points
integer
user_level
integer
customer_id
integer
newsletter
integer
hash
integer
last_session
integer
json_stats
string
notes
string
confirm
integer
created_user
string
Examples values:
"2021-01-12T17:03:08.000Z"
owner_name
string
autocreate
integer
group_id
integer
chat_user
boolean
Additional properties are allowed.
display_username
string
Examples values:
"Mario_Rossi"
key
string
The server_key of the bot

Additional properties are allowed.
object
array<object>
The botID is the id of the bot

id
integer
Plugin ID

name
string
Plugin name

Examples values:
"obfuscate"
bot_id
integer
Bot ID

backend
boolean
dashboard
boolean
widgetchat
boolean
object
key
string
projectId
string
Additional properties are allowed.
Additional properties are allowed.
dashboard_token
string
Additional properties are allowed.
RobinSvGetSessionsRequestPayload
string
uid: RobinSvGetSessionsRequestPayload
The [user.id] is the value that can be get by the command who. Limit and offset (integers) are used to limit the amount of chat sessions to be returned.

Default value:"robin sv [user.id] get sessions [limit] [offset]"
object
uid: RobinSvGetSessionsResponsePayload
command
string
Default value:"robin"
subcommand
string
Default value:"get"
region
string
Default value:"sessions"
subject
string
Default value:"op"
status
integer
Examples values:
"200"
"404"
"500"
array<object>
robin_email
string
counter
integer
id
integer
quando
string
test_chat
boolean
bot_id
integer
user
string
userid
integer
chat
integer
muted
boolean
vision
integer
wspath
string
client_number
integer
last_status
integer
breaked
string
ticket_status
string
ticket_assigned
string
robin_op
integer
json_trace
string
last_message
string
source
string
last_payload
string
vars
string
last_chat_text
string
last_chat_username
string
user_id
integer
nickname
string
email
string
phone
string
nome
string
cognome
string
birth
string
pic
string
customer_id
integer
last_session
string
json_stats
string
notes
string
object
online
integer
away
integer
deposit
integer
total
integer
notifications
integer
array<any>
array<any>
array<any>
Additional properties are allowed.
object
array<object>
The botID is the id of the bot

id
integer
Plugin ID

name
string
Plugin name

Examples values:
"obfuscate"
bot_id
integer
Bot ID

backend
boolean
dashboard
boolean
widgetchat
boolean
object
key
string
projectId
string
Additional properties are allowed.
Additional properties are allowed.
dashboard_token
string
Additional properties are allowed.
RobinSvGetSessionRequestPayload
string
uid: RobinSvGetSessionRequestPayload
The [user.id] is the value that can be get by the command who. The [session.id] is obtained by robin.sv.[user.id].get.sessions.[limit].[offset] command

Default value:"robin sv [user.id] get [session.id]"
object
uid: RobinSvGetSessionResponsePayload
command
string
Default value:"robin"
subcommand
string
Default value:"get"
region
string
Default value:"session.id"
subject
string
Default value:"op"
status
integer
Examples values:
"200"
"404"
"500"
array<object>
id
integer
bot_id
integer
session
integer
message_uuid
string
userid
integer
username
string
chat
string
qea_id
integer
status
integer
quando_chat
string
Examples values:
"2022-05-19T09:24:25.000Z"
sentiment
string
hbo
string
Examples values:
"h"
"b"
"o"
kpi_processed
boolean
like_dislike
integer
thumbs
integer
ai_score
integer
robin_op
integer
ticket_assigned
string
robin_email
string
canBeTrained
boolean
object
online
integer
away
integer
deposit
integer
total
integer
notifications
integer
array<any>
array<any>
array<any>
Additional properties are allowed.
source
string
Examples values:
"webchat"
"facebook"
source_urlweb
string
Examples values:
"http://127.0.0.1:5500/index-1634.html"
object
array<object>
The botID is the id of the bot

id
integer
Plugin ID

name
string
Plugin name

Examples values:
"obfuscate"
bot_id
integer
Bot ID

backend
boolean
dashboard
boolean
widgetchat
boolean
object
key
string
projectId
string
Additional properties are allowed.
Additional properties are allowed.
dashboard_token
string
Additional properties are allowed.
object
uid: ChatAssignToAgentRequestPayload
Used to ask to assign a chat to an agent

session
integer
The id of the session to be assigned to the agent

agent
string
The agent email to which to assign the conversation

Examples values:
"agent-email@userbot.ai"
Additional properties are allowed.
object
uid: ChatAssignToAgentResponsePayload
command
string
Default value:"chat-assign-to-agent"
subcommand
string
Examples values:
"{"session":123456,"agent":"agent-email@userbot.ai"}"
text
string
Examples values:
"Assigned to "agent-email@userbot.ai""
status
integer
Examples values:
"200"
"404"
"500"
object
array<object>
The botID is the id of the bot

id
integer
Plugin ID

name
string
Plugin name

Examples values:
"obfuscate"
bot_id
integer
Bot ID

backend
boolean
dashboard
boolean
widgetchat
boolean
object
key
string
projectId
string
Additional properties are allowed.
Additional properties are allowed.
dashboard_token
string
Additional properties are allowed.
object
uid: ChatAssignToBotRequestPayload
Used to ask to assign a chat to the Bot

session
integer
The id of the session to be assigned to the Bot

Additional properties are allowed.
object
uid: ChatAssignToBotResponsePayload
command
string
Default value:"chat-assign-to-bot"
subcommand
string
Examples values:
"{"session":123456}"
text
string
Examples values:
"Reassigned to bot"
status
integer
Examples values:
"200"
"404"
"500"
object
array<object>
The botID is the id of the bot

id
integer
Plugin ID

name
string
Plugin name

Examples values:
"obfuscate"
bot_id
integer
Bot ID

backend
boolean
dashboard
boolean
widgetchat
boolean
object
key
string
projectId
string
Additional properties are allowed.
Additional properties are allowed.
dashboard_token
string
Additional properties are allowed.
SayRequestPayload
string
uid: SayRequestPayload
wspath can be get by robin.sv.[user.id].get.sessions. chat_message is the actual message that is sent in the chat

Default value:"say.[wspath].[-100].[session.id].[chat_message]"
object
uid: SayResponsePayload
command
string
Default value:"chat-notification"
object
online
integer
away
integer
deposit
integer
total
integer
notifications
integer
array<any>
array<any>
array<any>
Additional properties are allowed.
notificationId
integer
object
id
integer
quando
string
test_chat
boolean
bot_id
integer
user
string
userid
integer
chat
integer
muted
boolean
This flag is used to mute the Bot, for example in particular cases when the conversation is given to an agent

vision
integer
wspath
string
This is used for the say command

client_number
integer
last_status
string
breaked
string
ticket_status
integer
ticket_assigned
string
robin_op
string
json_trace
string
last_message
string
source
string
last_payload
string
vars
string
isHumanMessage
boolean
humanMessage
string
counter
integer
Additional properties are allowed.
object
nfrom
integer
nto
integer
session_id
integer
bot_argument
string
customer_id
integer
user_id
integer
object
id
integer
bot_id
integer
session
integer
message_uuid
string
userid
integer
username
string
chat
string
qea_id
integer
status
integer
quando_chat
string
sentiment
string
hbo
string
kpi_processed
boolean
like_dislike
boolean
thumbs
boolean
ai_score
integer
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
object
uid: ChatUser
id
integer
name
string
The name of the user

surname
string
The surname of the user

email
string
The email of the user

phone
string
The phone of the user

firstChat
string
format: date-time
The first time the user chatted

lastChat
string
format: date-time
The last time the user chatted

language
string
browser
string
Browser used if Web page was visited

source
string
Last source of contact (web, facebook, etc...)

array<string>
List of tags assigned to ChatUser.

Items:
string
Additional properties are allowed.
object
uid: Variable
oneOf
Adheres to:
string
Or to:
integer
name
string
type
string
Additional properties are allowed.
object
uid: Tag
id
integer
name
string
Additional properties are allowed.
object
uid: Segment
id
integer
name
string
array<object>
uid: SegmentFilter
oneOf
Adheres to:
string
Or to:
integer
entity
string
type
string
Allowed values:
"variable"
"tag"
operator
string
Allowed values:
"is"
"is_not"
"has_any_value"
"contains"
"does_not_contain"
"begins_with"
"after"
"before"
"greater_than"
"less_than"
"greater_than_or_equal"
"less_than_or_equal"
Additional properties are allowed.
object
uid: SegmentFilter
oneOf
Adheres to:
string
Or to:
integer
entity
string
type
string
Allowed values:
"variable"
"tag"
operator
string
Allowed values:
"is"
"is_not"
"has_any_value"
"contains"
"does_not_contain"
"begins_with"
"after"
"before"
"greater_than"
"less_than"
"greater_than_or_equal"
"less_than_or_equal"
Additional properties are allowed.
object
uid: Feedback
vote
integer
text
string
sessionId
string
It contains the Session Id where feedback was submitted. It's used to create a URL link to open the chat directly.

userId
integer
name
string
User's name

surname
string
User's surname

email
string
User's email

createdAt
string
Timestamp

updatedAt
string
Timestamp

Additional properties are allowed.
object
uid: ChatUsersGetRequestPayload
offset
integer
Default value:0
limit
integer
Default value:25
array<object>
mode
string
Allowed values:
"ASC"
"DESC"
field
string
search
string
A string used to search in all ChatUser properties

Default value:""
anonymous
boolean
If property is true must be returned also anonymous users

Default value:
array<object>
entity
string
operator
string
If type is equal to "tag" valid operators will be only "is" and "is_not".

Allowed values:
"is"
"is_not"
"has_any_value"
"contains"
"does_not_contain"
"greater_than"
"greater_than_or_equal"
"less_than"
"less_than_or_equal"
type
string
Allowed values:
"variable"
"tag"
value
string
tags
boolean
if tags is true it will load tags on every ChatUsers of the response

Default value:
Additional properties are allowed.
object
uid: ChatUsersGetResponsePayload
array<object>
uid: ChatUser
id
integer
name
string
The name of the user

surname
string
The surname of the user

email
string
The email of the user

phone
string
The phone of the user

firstChat
string
format: date-time
The first time the user chatted

lastChat
string
format: date-time
The last time the user chatted

language
string
browser
string
Browser used if Web page was visited

source
string
Last source of contact (web, facebook, etc...)

array<string>
List of tags assigned to ChatUser.

Items:
string
total
integer
Total number of chat users in a Bot

anonymous
integer
Total number of anonymous users in a Bot

namedUsers
integer
Total number of not anonymous users in a Bot

filteredCounter
integer
Total number of chat users that has match a filtered search using filters, anonymouse and search params

Additional properties are allowed.
object
uid: ChatUsersGetVarsRequestPayload
userId
integer
Additional properties are allowed.
object
uid: ChatUsersGetVarsResponsePayload
array<object>
uid: Variable
oneOf
Adheres to:
string
Or to:
integer
name
string
type
string
Additional properties are allowed.
array<object>
firstname
required
string
The name of the User

lastname
required
string
The surname of the User

email
required
string
The email of the User

phone
required
string
The phone number of the User

consentConfirmation
required
boolean
The consent confirmation checkbox means Customer has the explicit consent of the User to be signing up

userid
integer
The userid is the id of the user that needs to be updated, if an user is created userid is not sent
allOf
uid: ChatUsersCreateResponsePayload
object
command
string
status
number
Allowed values:
200
404
500
Additional properties are allowed.
And with:
any
object
uid: ChatUsersDeleteRequestPayload
all
boolean
If true it means all users must be deleted from the database

array<integer>
List of Chat User's id to delete from database

Items:
integer
array<any>
If this parameter is in the payload, and is set to all true, delete all the users except those specified in this array of usersId

Additional properties are allowed.
allOf
uid: ChatUsersDeleteResponsePayload
object
command
string
status
number
Allowed values:
200
404
500
Additional properties are allowed.
object
array<integer>
Items:
integer
Additional properties are allowed.
allOf
uid: ChatUsersInsightsRequestPayload
object
startFrom
integer
Timestamp

endTo
integer
Timestamp

Additional properties are allowed.
object
all
boolean
If true it will request a total number of ChatUsers available in a defined time period

newChatUsers
boolean
If true it will request a number of new ChatUsers created in a defined time period

averageMessagesPerSession
boolean
If true it will request the average number of ChatUser messages per session in a defined time period

averageDurationSession
boolean
If true it will request the average duration of ChatUser session in a defined time period

Additional properties are allowed.
allOf
uid: ChatUsersInsightsResponsePayload
object
command
string
status
number
Allowed values:
200
404
500
Additional properties are allowed.
object
all
integer
Total number of ChatUsers until that period

newChatUsers
integer
Total number of new ChatUsers between the time period defined

averageMessagesPerSession
integer
Average Chatusers' messages per session in the defined time period

averageDurationSession
integer
Average Chatusers' duration session in the defined time period

Additional properties are allowed.
object
uid: ChatUsersImportRequestPayload
file
string
format: binary
Binary data of the CSV file sent

Additional properties are allowed.
allOf
uid: ChatUsersImportResponsePayload
object
command
string
status
number
Allowed values:
200
404
500
Additional properties are allowed.
object
array<array<any>>
array<any>
Additional properties are allowed.
object
uid: ChatUsersCreateSegmentRequestPayload
name
string
The Segment name

array<object>
uid: SegmentFilter
List of filters applied that create the Segment structure

oneOf
Adheres to:
string
Or to:
integer
entity
string
type
string
Allowed values:
"variable"
"tag"
operator
string
Allowed values:
"is"
"is_not"
"has_any_value"
"contains"
"does_not_contain"
"begins_with"
"after"
"before"
"greater_than"
"less_than"
"greater_than_or_equal"
"less_than_or_equal"
Additional properties are allowed.
allOf
uid: ChatUsersCreateSegmentResponsePayload
object
command
string
status
number
Allowed values:
200
404
500
Additional properties are allowed.
allOf
uid: ChatUsersGetBotSegmentsResponsePayload
object
command
string
status
number
Allowed values:
200
404
500
Additional properties are allowed.
restricted any
array<object>
uid: Segment
id
integer
name
string
array<object>
uid: SegmentFilter
oneOf
Adheres to:
string
Or to:
integer
entity
string
type
string
Allowed values:
"variable"
"tag"
operator
string
Allowed values:
"is"
"is_not"
"has_any_value"
"contains"
"does_not_contain"
"begins_with"
"after"
"before"
"greater_than"
"less_than"
"greater_than_or_equal"
"less_than_or_equal"
object
uid: ChatUsersSetVariableRequestPayload
When is passed a variable_id an update will occur. If the variable object is passed a new variable will be created.

object
name
required
string
The Variable name to add

value
required
string
The Variable value

type
required
string
The Variable type. Default is "text"

Allowed values:
"text"
"number"
"date"
Additional properties are allowed.
required
array<number>
Array of Users' id to update a variable

Items:
number
Additional properties are allowed.
allOf
uid: ChatUsersSetVariableResponsePayload
object
command
string
status
number
Allowed values:
200
404
500
Additional properties are allowed.
allOf
uid: ChatUsersGetBotTagsResponsePayload
object
command
string
status
number
Allowed values:
200
404
500
Additional properties are allowed.
restricted any
array<object>
uid: Tag
id
integer
name
string
object
uid: ChatUsersAddTagRequestPayload
name
string
The Tag name to add

array<integer>
List of users id to add the tag

Items:
integer
Additional properties are allowed.
allOf
uid: ChatUsersAddTagResponsePayload
object
command
string
status
number
Allowed values:
200
404
500
Additional properties are allowed.
object
uid: ChatUsersRemoveElementRequestPayload
name
string
The Element name to add

array<integer>
List of users id affected

Items:
integer
deleteAll
boolean
if true, delete all the users with the given tag name

Additional properties are allowed.
allOf
uid: ChatUsersRemoveTagResponsePayload
object
command
string
status
number
Allowed values:
200
404
500
Additional properties are allowed.
object
uid: ChatUsersRemoveElementRequestPayload
name
string
The Element name to add

array<integer>
List of users id affected

Items:
integer
deleteAll
boolean
if true, delete all the users with the given tag name

Additional properties are allowed.
object
uid: ChatUsersRemoveElementRequestPayload
name
string
The Element name to add

array<integer>
List of users id affected

Items:
integer
deleteAll
boolean
if true, delete all the users with the given tag name

Additional properties are allowed.
object
uid: SitekeyUndefinedRequestPayload
no payload is sent with this command at all

Additional properties are allowed.
object
uid: SitekeyUndefinedResponsePayload
command
string
Default value:"sitekey"
text
string
Describes the validation status of the key

status
integer
Total status code of the request

Examples values:
200
404
500
object
object
alert50
boolean
alert80
boolean
limitReached
boolean
type
string
Examples values:
"fair-use"
Additional properties are allowed.
Additional properties are allowed.
object
unique
integer
limit
integer
Additional properties are allowed.
object
Information about the customer

nome
string
Customer name

base_mail
string
Customer email

chats_start_interval
integer
chats_end_interval
integer
chat_limits
integer
ownerUserId
integer
User ID of the account owner

agentsLimit
integer
Limit of the agents that the customer can have

activeAgents
integer
Number of the active agents

Additional properties are allowed.
object
array<object>
The botID is the id of the bot

id
integer
Plugin ID

name
string
Plugin name

Examples values:
"obfuscate"
bot_id
integer
Bot ID

backend
boolean
dashboard
boolean
widgetchat
boolean
object
key
string
projectId
string
Additional properties are allowed.
Additional properties are allowed.
dashboard_token
string
Additional properties are allowed.
object
uid: ApiLoginApikeyRequestPayload
No payload is sent with this command

Additional properties are allowed.
object
uid: ApiLoginApikeyResponsePayload
text
string
Default value:"apiKey setted"
object
command
string
Default value:"apiLogin"
text
string
status
integer
Allowed values:
200
404
500
Additional properties are allowed.
Additional properties are allowed.
object
uid: BotStatsRequestPayload
type
string
Default value:"all"
Additional properties are allowed.
object
uid: BotStatsResponsePayload
command
string
subcommand
string
text
string
status
integer
Allowed values:
200
401
500
object
array<any>
Items:
any
Additional properties are allowed.
Additional properties are allowed.
object
uid: QeafilterSearchPageDbAiRequestPayload
created_from_date
string
created_to_date
string
text
string
array<integer>
Items:
integer
2 is for confirmed and trained interactions, 1 is for the "to approve" interactions

Allowed values:
1
2
array<object>
name
string
Group name

counter
integer
The number of interactions in the group

selected
boolean
id
integer
ID of the group

limit_from
integer
limit_to
integer
Additional properties are allowed.
object
uid: QeafilterSearchPageDbAiResponsePayload
command
string
Default value:"qeafilter"
subcommand
string
Default value:"search"
token
string
Default value:"page-db-ai"
array<object>
ai
integer
Indicates if an interaction is trained

label
string
quando
integer
The time of creation of the interaction, timestamp

fallback
integer
flows_startingPoint
integer
array<object>
name
string
Group name

counter
integer
The number of interactions in the group

selected
boolean
id
integer
ID of the group

flows_id
integer
flows_step
boolean
flows_block_order
integer
flows_name
string
array<string>
Items:
string
It is the answer of the bot to the interaction. Buttons is sent in case the request contains buttons keyword

Examples values:
"bot answer {\"buttons\":[{\"key\":\"button-id-80\",\"title\":\"Click\",\"action\":\"text\",\"content\":\"Clicked\",\"dirty\":true}]}"
topics_text
string
topics_log
boolean
intent
string
ai_1_pending
integer
Counts the amount of pending so not yet trained interactions

ai_1_trained
integer
Counts the total trained interactions

count
integer
countFiltered
integer
object
array<object>
The botID is the id of the bot

id
integer
Plugin ID

name
string
Plugin name

Examples values:
"obfuscate"
bot_id
integer
Bot ID

backend
boolean
dashboard
boolean
widgetchat
boolean
object
key
string
projectId
string
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
object
uid: QeafilterSaveRequestPayload
label
string
name
string
The name of the interaction

array<object>
name
string
Group name

counter
integer
The number of interactions in the group

selected
boolean
id
integer
ID of the group

array<object>
The user questions for the interaction

name
string
id
integer
deep_learning
boolean
array<object>
The Bot answer to the user questions

name
string
flows_id
integer
fallback-team
string
array<object>
key
string
Key of the button

title
string
The text on the button

action
string
The type of action the button computes. If you jump to interaction/flow, the action is "goto"; for url is "url", for text message is "text"

Examples values:
" "buttons": [ { "key": "button-id-41", "title": "link", "action": "url", "content": "https://userbot.ai", "dirty": true }], "buttons": [ { "action": "goto", "title": "Click", "key": "button-id-34", "content": "Ciao", "dirty": false, "label": "Greeting" }], "buttons": [ { "action": "goto", "title": "Click", "flows_id": 2409, "key": "button-id-34", "content": "Flusso di benvenuto", "dirty": false, "flows_startMessageLabel": "2409-operator1-0-0" }], "buttons": [ { "key": "button-id-41", "title": "click", "action": "text", "content": "ciaoo", "dirty": true }]"
content
string
The content of the button action

dirty
boolean
label
string
The label of the interaction where the button jumps. This is to be sent when creating a button that jumps to an interaction

flows_startMessageLabel
string
The identification of the flow operator where the button jumps. This is to be sent when creating a button that jumps to a flow operator

Additional properties are allowed.
object
uid: QeafilterSaveResponsePayload
command
string
Default value:"qeafilter"
subcommand
string
Default value:"save"
token
string
Default value:""
text
string
Default value:"qeafilter command"
result
string
Examples values:
"OK"
insertedCount
integer
object
ai
integer
Default value:2
label
string
quando
integer
A timestamp of the creation of the record

fallback
integer
flows_startingPoint
string
object
name
string
Group name

counter
integer
The number of interactions in the group

selected
boolean
id
integer
ID of the group

Additional properties are allowed.
flows_id
integer
flows_step
integer
flows_block_order
integer
flows_name
string
array<string>
Items:
string
It is the answer of the bot to the interaction. Buttons is sent in case the request contains buttons keyword

Examples values:
"bot answer {\"buttons\":[{\"key\":\"button-id-80\",\"title\":\"Click\",\"action\":\"text\",\"content\":\"Clicked\",\"dirty\":true}]}"
array<object>
id
integer
question_nl
string
the question of the interaction

deep_learning
boolean
A flag set to true if the interaction is of type "è simile a", set to false for "è esattamente", not present for "contiene le parole"

topics_text
string
topics_log
boolean
Additional properties are allowed.
array<integer>
Items:
integer
Contains the id of the qea record inserted

object
array<object>
The botID is the id of the bot

id
integer
Plugin ID

name
string
Plugin name

Examples values:
"obfuscate"
bot_id
integer
Bot ID

backend
boolean
dashboard
boolean
widgetchat
boolean
object
key
string
projectId
string
Additional properties are allowed.
Additional properties are allowed.
dashboard_token
string
Additional properties are allowed.
object
uid: QeafilterSaveTokenRequestPayload
label
string
name
string
The name of the interaction

array<object>
name
string
Group name

counter
integer
The number of interactions in the group

selected
boolean
id
integer
ID of the group

array<object>
The user questions for the interaction

name
string
id
integer
deep_learning
boolean
array<object>
The Bot answer to the user questions

name
string
flows_id
integer
flows_startMessageLabel
string
The identification of the flow operator where the button jumps. This is to be sent when creating a button that jumps to a flow operator

fallback-team
string
array<object>
key
string
Key of the button

title
string
The text on the button

action
string
The type of action the button computes. If you jump to interaction/flow, the action is "goto"; for url is "url", for text message is "text"

Examples values:
" "buttons": [ { "key": "button-id-41", "title": "link", "action": "url", "content": "https://userbot.ai", "dirty": true }], "buttons": [ { "action": "goto", "title": "Click", "key": "button-id-34", "content": "Ciao", "dirty": false, "label": "Greeting" }], "buttons": [ { "action": "goto", "title": "Click", "flows_id": 2409, "key": "button-id-34", "content": "Flusso di benvenuto", "dirty": false, "flows_startMessageLabel": "2409-operator1-0-0" }], "buttons": [ { "key": "button-id-41", "title": "click", "action": "text", "content": "ciaoo", "dirty": true }]"
content
string
The content of the button action

dirty
boolean
label
string
The label of the interaction where the button jumps. This is to be sent when creating a button that jumps to an interaction

flows_startMessageLabel
string
The identification of the flow operator where the button jumps. This is to be sent when creating a button that jumps to a flow operator

Additional properties are allowed.
object
uid: QeafilterSaveTokenResponsePayload
command
string
Default value:"qeafilter"
subcommand
string
Default value:"save"
token
string
Default value:"interactionName"
text
string
Default value:"qeafilter command"
result
string
Examples values:
"OK"
insertedCount
integer
object
ai
integer
Default value:2
label
string
quando
integer
A timestamp of the creation of the record

fallback
integer
flows_startingPoint
string
object
name
string
Group name

counter
integer
The number of interactions in the group

selected
boolean
id
integer
ID of the group

Additional properties are allowed.
flows_id
integer
flows_step
integer
flows_block_order
integer
flows_name
string
array<string>
Items:
string
It is the answer of the bot to the interaction. Buttons is sent in case the request contains buttons keyword

Examples values:
"bot answer {\"buttons\":[{\"key\":\"button-id-80\",\"title\":\"Click\",\"action\":\"text\",\"content\":\"Clicked\",\"dirty\":true}]}"
array<object>
id
integer
question_nl
string
the question of the interaction

deep_learning
boolean
A flag set to true if the interaction is of type "è simile a", set to false for "è esattamente", not present for "contiene le parole"

topics_text
string
topics_log
boolean
Additional properties are allowed.
array<integer>
Items:
integer
Contains the id of the qea record inserted

object
array<object>
The botID is the id of the bot

id
integer
Plugin ID

name
string
Plugin name

Examples values:
"obfuscate"
bot_id
integer
Bot ID

backend
boolean
dashboard
boolean
widgetchat
boolean
object
key
string
projectId
string
Additional properties are allowed.
Additional properties are allowed.
dashboard_token
string
Additional properties are allowed.
object
uid: QeafilterDeleteRequestPayload
array<string>
Items:
string
interaction label to be deleted, if a bulk action is performed, all the interaction labels to be deleted are inserted in this array

Examples values:
"interactionLabel"
Additional properties are allowed.
object
uid: QeafilterDeleteResponsePayload
command
string
Default value:"qeafilter"
subcommand
string
Default value:"delete"
token
string
Default value:null
text
string
Default value:"qeafilter command"
result
string
Examples values:
"success"
array<string>
Items:
string
The interaction labels to be deleted

bulk
boolean
True if more than one interaction needs to be deleted

object
array<object>
The botID is the id of the bot

id
integer
Plugin ID

name
string
Plugin name

Examples values:
"obfuscate"
bot_id
integer
Bot ID

backend
boolean
dashboard
boolean
widgetchat
boolean
object
key
string
projectId
string
Additional properties are allowed.
Additional properties are allowed.
dashboard_token
string
Default value:null
Additional properties are allowed.
object
uid: AutomatedMessage
id
integer
name
string
order
integer
object
uid: Answer
text
string
flows_id
integer
flows_step
string
created_at
integer
Timestamp

updated_at
integer
Timestamp

Additional properties are allowed.
array<object>
id
integer
entity
string
Allowed values:
"page_url"
"referrer"
"time_spent"
"site_visited_counter"
operator
string
Allowed values:
"is"
"is_not"
"has_any_value"
"contains"
"does_not_contain"
"greater_than"
"greater_than_or_equal"
oneOf
Adheres to:
string
Or to:
integer
Or to:
boolean
created_at
integer
Timestamp

updated_at
integer
Timestamp

created_at
integer
Timestamp

updated_at
integer
Timestamp

Additional properties are allowed.
object
uid: AutomatedMesssageCondition
id
integer
entity
string
Allowed values:
"page_url"
"referrer"
"time_spent"
"site_visited_counter"
operator
string
Allowed values:
"is"
"is_not"
"has_any_value"
"contains"
"does_not_contain"
"greater_than"
"greater_than_or_equal"
oneOf
Adheres to:
string
Or to:
integer
Or to:
boolean
created_at
integer
Timestamp

updated_at
integer
Timestamp

Additional properties are allowed.
object
uid: Answer
text
string
flows_id
integer
flows_step
string
created_at
integer
Timestamp

updated_at
integer
Timestamp

Additional properties are allowed.
object
uid: AutomatedMessagesGetResponsePayload
array<object>
id
integer
name
string
order
integer
object
uid: Answer
text
string
flows_id
integer
flows_step
string
created_at
integer
Timestamp

updated_at
integer
Timestamp

Additional properties are allowed.
array<object>
id
integer
entity
string
Allowed values:
"page_url"
"referrer"
"time_spent"
"site_visited_counter"
operator
string
Allowed values:
"is"
"is_not"
"has_any_value"
"contains"
"does_not_contain"
"greater_than"
"greater_than_or_equal"
oneOf
Adheres to:
string
Or to:
integer
Or to:
boolean
created_at
integer
Timestamp

updated_at
integer
Timestamp

created_at
integer
Timestamp

updated_at
integer
Timestamp

Additional properties are allowed.
object
uid: AutomatedMessagesDeleteRequestPayload
required
array<integer>
List of Automated Messages' id to delete from database

Items:
integer
Additional properties are allowed.
allOf
uid: AutomatedMessagesDeleteResponsePayload
object
command
string
status
number
Allowed values:
200
404
500
Additional properties are allowed.
object
array<integer>
Items:
integer
Additional properties are allowed.
object
uid: AutomatedMessagesSaveRequestPayload
required
array<object>
name
required
string
order
required
integer
required
object
text
string
flows_id
integer
flows_step
string
Additional properties are allowed.
array<object>
entity
string
operator
string
value
string
Additional properties are allowed.
allOf
uid: AutomatedMessagesSaveResponsePayload
object
command
string
status
number
Allowed values:
200
404
500
Additional properties are allowed.
object
array<object>
id
integer
name
string
order
integer
object
uid: Answer
text
string
flows_id
integer
flows_step
string
created_at
integer
Timestamp

updated_at
integer
Timestamp

Additional properties are allowed.
array<object>
id
integer
entity
string
Allowed values:
"page_url"
"referrer"
"time_spent"
"site_visited_counter"
operator
string
Allowed values:
"is"
"is_not"
"has_any_value"
"contains"
"does_not_contain"
"greater_than"
"greater_than_or_equal"
oneOf
Adheres to:
string
Or to:
integer
Or to:
boolean
created_at
integer
Timestamp

updated_at
integer
Timestamp

created_at
integer
Timestamp

updated_at
integer
Timestamp

Additional properties are allowed.
object
uid: RawstatsCountNpsRequestPayload
from
string
The start date, format is complete ISO-8601 date

Examples values:
"2022-05-23T22:00:00.000Z"
to
string
The end date, format is complete ISO-8601 date

Examples values:
"2022-05-25T21:59:59.999Z"
Additional properties are allowed.
object
uid: RawstatsCountNpsResponsePayload
command
string
Default value:"rawstats"
subcommand
string
Default value:"count-nps"
response
string
Default value:"OK"
object
positive
integer
Average of positive scores (9,10) from ChatUsers

neutral
integer
Average of neutral scores (7,8) from ChatUsers

negative
integer
Average of negative scores (1-6) from ChatUsers

Additional properties are allowed.
object
array<object>
The botID is the id of the bot

id
integer
Plugin ID

name
string
Plugin name

Examples values:
"obfuscate"
bot_id
integer
Bot ID

backend
boolean
dashboard
boolean
widgetchat
boolean
object
key
string
projectId
string
Additional properties are allowed.
Additional properties are allowed.
dashboard_token
string
Default value:null
Additional properties are allowed.
object
uid: RawstatsAllRequestPayload
from
string
The start date of the insights, format is complete ISO-8601 date

Examples values:
"2022-05-23T22:00:00.000Z"
to
string
The end date of the insights, format is complete ISO-8601 date

Examples values:
"2022-05-25T21:59:59.999Z"
Additional properties are allowed.
object
uid: RawstatsAllResponsePayload
command
string
Default value:"rawstats"
subcommand
string
Default value:"all"
response
string
Examples values:
"OK"
statuscode
integer
Examples values:
"200"
"404"
"500"
object
array<object>
messages
integer
Total messages of the day

resolved
integer
Total messages resolved of the day

resolvedByHuman
integer
Total messages resolved by an agent of the day

resolvedByBot
integer
Total messages resolved by bot of the day

resolvedByBotWithHints
integer
Total messages resolved by bot with hints of the day

notManagedByBot
integer
Total messages not resolved by bot for the day

avgResponseHuman
integer
Average response time of the agent of the day

avgResponseBot
integer
Average response time of the bot of the day

messages_human
integer
Total messages by an agent of the day

messages_user
integer
Total messages by an user of the day

conversations_bot
integer
Total conversations managed by bot of the day

conversations_human
integer
Total conversations managed by agent of the day

sessions
integer
Total conversations of the day

day
string
Examples values:
"2022-05-24"
object
object
resolvedByHumans
integer
The total messages resolved by an agent

upscaledToHumans
integer
The total messages upscaled to human

resolvedByBot
integer
The total messages resolved by Bot

resolvedByBotWithHints
integer
The total messages resolved by Bot with hints

count
integer
notManagedByBot
integer
The total messages not managed by Bot

Additional properties are allowed.
object
upscaled
integer
The total chats upscaled to agent

resolvedByBot
integer
The total chats resolved by Bot

count
integer
Additional properties are allowed.
avgResponseHuman
integer
The average time an agent answers to an upscaled conversation

Additional properties are allowed.
Additional properties are allowed.
object
array<object>
The botID is the id of the bot

id
integer
Plugin ID

name
string
Plugin name

Examples values:
"obfuscate"
bot_id
integer
Bot ID

backend
boolean
dashboard
boolean
widgetchat
boolean
object
key
string
projectId
string
Additional properties are allowed.
Additional properties are allowed.
dashboard_token
string
Default value:null
Additional properties are allowed.
object
uid: RawstatsCountMessagesRequestPayload
from
string
The start date, format is complete ISO-8601 date

Examples values:
"2022-05-23T22:00:00.000Z"
to
string
The end date, format is complete ISO-8601 date

Examples values:
"2022-05-25T21:59:59.999Z"
Additional properties are allowed.
object
uid: RawstatsCountMessagesResponsePayload
command
string
Default value:"rawstats"
subcommand
string
Default value:"count-messages"
response
string
Examples values:
"OK"
statuscode
integer
Examples values:
"200"
"404"
"500"
object
count
integer
The total amount of messages for the period asked

Additional properties are allowed.
object
array<object>
The botID is the id of the bot

id
integer
Plugin ID

name
string
Plugin name

Examples values:
"obfuscate"
bot_id
integer
Bot ID

backend
boolean
dashboard
boolean
widgetchat
boolean
object
key
string
projectId
string
Additional properties are allowed.
Additional properties are allowed.
dashboard_token
string
Default value:null
Additional properties are allowed.
object
uid: RawstatsCountSessionsRequestPayload
from
string
The start date, format is complete ISO-8601 date

Examples values:
"2022-05-23T22:00:00.000Z"
to
string
The end date, format is complete ISO-8601 date

Examples values:
"2022-05-25T21:59:59.999Z"
Additional properties are allowed.
object
uid: RawstatsCountSessionsResponsePayload
command
string
Default value:"rawstats"
subcommand
string
Default value:"count-sessions"
response
string
Examples values:
"OK"
statuscode
integer
Examples values:
"200"
"404"
"500"
object
count
integer
The total amount of chat sessions in the period asked

Additional properties are allowed.
object
array<object>
The botID is the id of the bot

id
integer
Plugin ID

name
string
Plugin name

Examples values:
"obfuscate"
bot_id
integer
Bot ID

backend
boolean
dashboard
boolean
widgetchat
boolean
object
key
string
projectId
string
Additional properties are allowed.
Additional properties are allowed.
dashboard_token
string
Default value:null
Additional properties are allowed.
object
uid: RawstatsGetRequestPayload
startFrom
string
The start date, format is complete ISO-8601 date

Examples values:
"2022-05-23T22:00:00.000Z"
endTo
string
The end date, format is complete ISO-8601 date

Examples values:
"2022-05-25T21:59:59.999Z"
Additional properties are allowed.
object
uid: RawstatsGetResponsePayload
command
string
Default value:"rawstats"
subcommand
string
Default value:"get"
response
string
Examples values:
"OK"
statuscode
integer
Examples values:
"200"
"404"
"500"
object
object
companies stats

totalCompanies
integer
the total amount of companies

newCompanies
integer
the new companies

array<any>
company
string
the name of the company

employees
integer
the number of employees of the company

Additional properties are allowed.
object
conversations stats

totalConversations
integer
total amount of conversations

Additional properties are allowed.
object
industries stats

array<any>
industry
string
occurrence
integer
Additional properties are allowed.
object
email stats

totalEmailsCaptured
number
Additional properties are allowed.
object
meetings data

totalMeetingsScheduled
number
Additional properties are allowed.
Additional properties are allowed.
object
array<object>
The botID is the id of the bot

id
integer
Plugin ID

name
string
Plugin name

Examples values:
"obfuscate"
bot_id
integer
Bot ID

backend
boolean
dashboard
boolean
widgetchat
boolean
object
key
string
projectId
string
Additional properties are allowed.
Additional properties are allowed.
dashboard_token
string
Default value:null
Additional properties are allowed.
array<object>
id
number
lead identifier

name
string
the company name

logo
string
the url of the company logo

city
string
the city in which the company resides

industry
string
the sector in which the company operates

description
string
a short description of the company

size
number
the number of employes working in the company

legalAddress
string
address of the company office

url
string
site or main social url

temperature
number
between 1 and 3: 1 cold, 2 warm, 3 hot

visits
number
number of different pages

timeOnPages
number
time spent on pages

lastVisit
string
last visit of the lead
object
uid: IntelVisitdetailsRequestPayload
id
number
lead identifier

Additional properties are allowed.
array<object>
url
string
the url of the visited page

enter
string
the ISO UTC date in which the user landed in the page

leave
string
the ISO UTC date in which the user left the page

session
number
It can be used to follow the pages visited by a user
object
uid: IntelKeypeopleRequestPayload
id
number
lead identifier

Additional properties are allowed.
array<object>
fullname
string
photo
string
Linkedin
string
role
string
object
uid: IntelAddTagRequestPayload
company
number
customer
number
tagname
string
Additional properties are allowed.
object
uid: IntelRemoveTagRequestPayload
company
number
customer
number
tagname
string
Additional properties are allowed.
allOf
uid: ChatUsersGetFeedbackListResponsePayload
object
command
string
status
number
Allowed values:
200
404
500
Additional properties are allowed.
object
array<object>
uid: Feedback
vote
integer
text
string
sessionId
string
It contains the Session Id where feedback was submitted. It's used to create a URL link to open the chat directly.

userId
integer
name
string
User's name

surname
string
User's surname

email
string
User's email

createdAt
string
Timestamp

updatedAt
string
Timestamp

Additional properties are allowed.
allOf
uid: ChatUsersGetFeedbackListResponsePayload
object
command
string
status
number
Allowed values:
200
404
500
Additional properties are allowed.
object
array<object>
uid: Feedback
vote
integer
text
string
sessionId
string
It contains the Session Id where feedback was submitted. It's used to create a URL link to open the chat directly.

userId
integer
name
string
User's name

surname
string
User's surname

email
string
User's email

createdAt
string
Timestamp

updatedAt
string
Timestamp

Additional properties are allowed.
object
uid: MeetingsScheduleRequestPayload
eventUrl
string
It contains a url to use with Calendly API to get the details of an event

Examples values:
"https://api.calendly.com/scheduled_events/c1deba23-dbcb-4b34-890e-f5d8d908091c"
inviteeUrl
string
It contains a url to use with Calendly API to get the invitee of an event

Examples values:
"https://api.calendly.com/scheduled_events/c1deba23-dbcb-4b34-890e-f5d8d908091c/invitees/f2bcd809-d909-4082-9876-a20e93d03b1f"
Additional properties are allowed.

Userbot 1.0.0

Servers

Operations

PUB bot.get-vars

Examples

SUB bot.get-vars

Examples

This example has been generated automatically.

PUB chatusers.get

Examples

This example has been generated automatically.

SUB chatusers.get

Examples

This example has been generated automatically.

PUB chatusers.create

Examples

This example has been generated automatically.

SUB chatusers.create

Examples

This example has been generated automatically.

PUB chatusers.delete

Examples

This example has been generated automatically.

SUB chatusers.delete

Examples

This example has been generated automatically.

PUB chatusers.insights

Examples

This example has been generated automatically.

SUB chatusers.insights

Examples

This example has been generated automatically.

PUB chatusers.import

Examples

This example has been generated automatically.

SUB chatusers.import

Examples

This example has been generated automatically.

PUB chatusers.get-feedback

Examples

This example has been generated automatically.

SUB chatusers.get-feedback

Examples

This example has been generated automatically.

PUB chatusers.create-segment

Examples

This example has been generated automatically.

SUB chatusers.create-segment

Examples

This example has been generated automatically.

PUB chatusers.remove-segment

Examples

This example has been generated automatically.

SUB chatusers.remove-segment

Examples

This example has been generated automatically.

PUB chatusers.edit-segment

Examples

This example has been generated automatically.

SUB chatusers.edit-segment

Examples

This example has been generated automatically.

PUB chatusers.get-bot-segments

Examples

SUB chatusers.get-bot-segments

Examples

This example has been generated automatically.

PUB chatusers.get-bot-tags

Examples

SUB chatusers.get-bot-tags

Examples

This example has been generated automatically.

PUB chatusers.add-tag

Examples

This example has been generated automatically.

SUB chatusers.add-tag

Examples

This example has been generated automatically.

PUB chatusers.remove-tag

Examples