Comm100

COMM100 RESTFUL API

LiveChat Agent Private Message Android Push Audio & Video Chat Auto Distribution Campaign Chat Custom Variable Custom Variable Config Dynamic Campaign Installation Integration Calendly IOS Push LiveChat_BannedIp LiveChat_BannedVisitor LiveChat_CampaignAutoInvitation LiveChat_ConversionAction LiveChat_Field LiveChat_Segment LiveChat_Shift LiveChat_Wrap-Up Field Offline Message SecureForm_Label Segment Config Shift Config Visitor History Visitor Single Sign-On (SSO) Webhook Wrapup Category Config Chat Server Real Time

Ticketing Agent Preference Auto Distribution Channel Channel App Channel Contact Identity Type Draft Event log Field Mapping Junk Message Note Operating Hours & Holidays Routing Config Tag Ticket Ticket Recycle Bin Ticketing_BlockedSender Ticketing_ChannelAccount Ticketing_Field Ticketing_Holiday Ticketing_SLAPolicy Ticketing_Trigger View

Bot Agent Assist Learning Question Bot_AgentAssistSynonym Bot_Chatbot Bot_ChatbotCannedQuickReply Bot_ChatbotEntity Bot_ChatbotIntentCategory Bot_ChatbotSmartTrigger Bot_Taskbot Chatbot Intent Chatbot Intent Answer Chatbot Intent Question Chatbot Learning Question Chatbot Message When A Visitor Start A Chat Chatbot Message When Not Helpful Chatbot Message When Providing Possible Answer Chatbot No Answer Message Level2Menu_AgentAssist Prebuilt Entity Taskbot Booked Calendly Meeting Taskbot Version

KB KnowledgeBase_Article KnowledgeBase_Category KnowledgeBase_CustomPage KnowledgeBase_Design KnowledgeBase_Image KnowledgeBase_KnowledgeBase KnowledgeBase_Tag Preview

Global Action Type Agent Agent Single Sign-On Config Audit Log Auto Translation Contact Contact identity Credit Card Masking Config Custom Agent Away Status Config Department Config Global_AgentAwayStatus Global_Loginipallowlist Global_PrivateCannedMessage Global_PrivateCannedMessageCategory Global_PublicCannedMessage Global_PublicCannedMessageCategory Global_Role Global_Skills LiveChat_Department Login IP Allowlist Config Module Password Policy Config Permission Restricted Words Config Role Config Site Profile SkillConfig System Avatar Visitor

Reporting Cube Report

Visitor Side JavaScript API Agent Console JavaScript API

Prebuilt Entity

Prebuilt Entities

- Prebuilt Entities Manage

GET bot/prebuiltEntities

- Get the list of Prebuilt Entities

GET bot/prebuiltEntities/{id}

- Get a single Prebuilt Entity

Model

Prebuilt Entity JSON Format

Prebuilt Entity is represented as simple flat JSON objects with the following keys:

Name	Type	Description
`dialogflowEntityId`	string	Id of the dialogflow entity.
`id`	guid	Id of the entity.
`name`	string	Name of the prebuilt entity.
`description`	string	Description of the prebuilt entity.
`example`	string []	Examples of the prebuilt entity.
`languageCode`	string	Code of the language.

Endpoint

Get the list of Prebuilt Entities

GET bot/prebuiltEntities

Parameters:

Name	Type	In	Required	Description
`languageCode`	string	query	yes	Code of the language.

Response:

An array of Prebuilt Entity

Example

Sample Request:

curl https://api15.comm100.io/v4/bot/prebuiltEntities \

-X 'GET' \

Response:

HTTP/1.1 200 OK

Get a single Prebuilt Entity

GET bot/prebuiltEntities/{id}

Parameters:

No Parameters

Response:

Prebuilt Entity

Example

Sample Request:

curl https://api15.comm100.io/v4/bot/prebuiltEntities/386B93B1-C148-EB11-8100-00155D081D0B \

-X 'GET' \

Response:

HTTP/1.1 200 OK