Topics zijn per klant gescheiden. Lijst- en detailaanvragen kunnen worden gefilterd op kanaal, zodat bellers enkel de topics ontvangen die van toepassing zijn op de actieve context van e-mail, chat, telefoon, WhatsApp of Teams. Het wijzigen van topics betreft instellingen, terwijl topicacties, topicdocumenten en paginamapping topics koppelen aan de automatiserings- en promptcontext die elders in AnswerPal wordt gebruikt.
GET /api/Topics – Bearer JWT (TicketAccessOrPhoneAuth)channelId beperkt de resultaten tot topics toegestaan voor dat kanaal; aanvragen met telefoon-auth gebruiken het tokenkanaal.GET /api/Topics/{id} – Bearer JWT (TicketAccessOrPhoneAuth)channelId past dezelfde kanaaltoegangsfilter toe en geeft 404 terug wanneer het topic niet is toegestaan voor dat kanaal.POST /api/Topics – Bearer JWT (ManageSettings)PUT /api/Topics/{id} – Bearer JWT (ManageSettings)DELETE /api/Topics/{id} – Bearer JWT (ManageSettings)GET /api/TopicChannels – Bearer JWT (ManageSettings)topicId, channelId, pageNumber, pageSize, sortBy en sortOrder. pageNumber wordt genormaliseerd en pageSize wordt beperkt tot 1-100.GET /api/TopicChannels/{id} – Bearer JWT (ManageSettings)POST /api/TopicChannels – Bearer JWT (ManageSettings)POST /api/TopicChannels/bulk – Bearer JWT (ManageSettings)DELETE /api/TopicChannels/{id} – Bearer JWT (ManageSettings)DELETE /api/TopicChannels/bulk – Bearer JWT (ManageSettings)GET /api/TopicActions – Bearer JWTtopicId, actionId, hookName, channelId, isActive, paginering en sortering.GET /api/TopicActions/{id} – Bearer JWTPOST /api/TopicActions – Bearer JWTactionID voor de herbruikbare actiedefinitie en priority voor de uitvoeringsvolgorde.POST /api/TopicActions/bulk – Bearer JWTPUT /api/TopicActions/{id} – Bearer JWTpriority van een bestaande koppeling bij.DELETE /api/TopicActions/{id} – Bearer JWTGET /api/TopicDocuments – Bearer JWTtopicId, documentId, channelId, hookName, isHook, paginering en sortering.GET /api/TopicDocuments/{id} – Bearer JWTPOST /api/TopicDocuments – Bearer JWTPOST /api/TopicDocuments/bulk – Bearer JWTPUT /api/TopicDocuments/{id} – Bearer JWTDELETE /api/TopicDocuments/{id} – Bearer JWTGET /api/PageTopicMappings – Bearer JWTGET /api/PageTopicMappings/{id} – Bearer JWTPOST /api/PageTopicMappings – Bearer JWTPUT /api/PageTopicMappings/{id} – Bearer JWTDELETE /api/PageTopicMappings/{id} – Bearer JWTPOST /api/ConditionalRules/from-text – Bearer JWTBeschermde AnswerPal API endpoints gebruiken JWT Bearer-authenticatie. De lijst- en detailroutes voor topics aanvaarden ook telefonische-authenticatiecontext via TicketAccessOrPhoneAuth; instellingenroutes vereisen ManageSettings.
PaginatedResult<T> met items, totalCount en totalPages terug.channelId meegeven resulteert in 403.GET /api/Topics en GET /api/Topics/{id} geven TopicDTO-data terug. Gebruik channelId wanneer u het set van onderwerpen nodig hebt dat van toepassing is op een specifiek kanaal.
GET /api/Topics – Bearer JWT (TicketAccessOrPhoneAuth)channelId beperkt de resultaten tot onderwerpen die voor dat kanaal toegelaten zijn; phone-auth requesten gebruiken het kanaal van het token.GET /api/Topics/{id} – Bearer JWT (TicketAccessOrPhoneAuth)channelId past dezelfde kanaal-toelatingslijst toe en geeft 404 terug als het onderwerp niet is toegelaten voor dat kanaal.POST /api/Topics – Bearer JWT (ManageSettings)PUT /api/Topics/{id} – Bearer JWT (ManageSettings)DELETE /api/Topics/{id} – Bearer JWT (ManageSettings)POST /api/Topics, PUT /api/Topics/{id} en DELETE /api/Topics/{id} vereisen ManageSettings. De server bezit de klantscope en valideert overrides voor telefoonmodellen.
Wanneer een kanaalcontext aanwezig is, bepaalt AnswerPal het type kanaal en past TopicChannels plus kanaalonderwerpbeleid toe om toegelaten onderwerpen te bepalen. Telefonische authenticatie kan geen ander kanaal opvragen dan het kanaal van het token.
Vereisten voor aangepaste velden van onderwerpen worden niet meer rechtstreeks op onderwerpen opgeslagen. Ze worden afgeleid uit de onderwerpdocumenten, wereldwijde specialTopic=All documenten en de kanaalcontext.
De relatie-endpoints koppelen onderwerpen aan kanalen, acties, documenten en pagina-URL-context. Ze hergebruiken hetzelfde kanaalscopepatroon: ofwel een concreet channelID of een specialChannel waarde.
TopicChannels definiëren de standaardrelevantie voor een onderwerp op één exact kanaal of één speciaal kanaaltype.
GET /api/TopicChannels – Bearer JWT (ManageSettings)topicId, channelId, pageNumber, pageSize, sortBy en sortOrder. pageNumber wordt genormaliseerd en pageSize wordt begrensd tot 1-100.GET /api/TopicChannels/{id} – Bearer JWT (ManageSettings)POST /api/TopicChannels – Bearer JWT (ManageSettings)POST /api/TopicChannels/bulk – Bearer JWT (ManageSettings)DELETE /api/TopicChannels/{id} – Bearer JWT (ManageSettings)DELETE /api/TopicChannels/bulk – Bearer JWT (ManageSettings)Topicacties koppelen herbruikbare acties aan onderwerpen of onderwerp/kanaalcombinaties. Prioriteit behoort toe aan de link, niet aan de Action-definitie.
GET /api/TopicActions – Bearer JWTtopicId, actionId, hookName, channelId, isActive, paginatie en sortering.GET /api/TopicActions/{id} – Bearer JWTPOST /api/TopicActions – Bearer JWTactionID voor de herbruikbare actiedefinitie en priority voor de uitvoeringsvolgorde.POST /api/TopicActions/bulk – Bearer JWTPUT /api/TopicActions/{id} – Bearer JWTpriority van een bestaande link.DELETE /api/TopicActions/{id} – Bearer JWTTopicdocumenten koppelen promptdocumenten aan onderwerpen en kanaalscopes. De Documenten-API beheert documentdefinities; deze API beheert de koppeling.
GET /api/TopicDocuments – Bearer JWTtopicId, documentId, channelId, hookName, isHook, paginatie en sortering.GET /api/TopicDocuments/{id} – Bearer JWTPOST /api/TopicDocuments – Bearer JWTPOST /api/TopicDocuments/bulk – Bearer JWTPUT /api/TopicDocuments/{id} – Bearer JWTDELETE /api/TopicDocuments/{id} – Bearer JWTPageTopicMappings koppelen URL-patronen aan onderwerpen zodat webcontext onderwerpselectie of automatisering kan beïnvloeden.
GET /api/PageTopicMappings – Bearer JWTGET /api/PageTopicMappings/{id} – Bearer JWTPOST /api/PageTopicMappings – Bearer JWTPUT /api/PageTopicMappings/{id} – Bearer JWTDELETE /api/PageTopicMappings/{id} – Bearer JWTDit is een verwante helper voor automatiseringsregels, geen onderwerp-CRUD-endpoint.
POST /api/ConditionalRules/from-text – Bearer JWTTopicacties bepalen welke herbruikbare automatiseringsacties uitgevoerd worden voor een topic en binnen het bereik van een kanaal.
GET /api/TopicActions – Bearer JWTtopicId, actionId, hookName, channelId, isActive, paginering en sortering.GET /api/TopicActions/{id} – Bearer JWTPOST /api/TopicActions – Bearer JWTactionID voor de definitie van de herbruikbare actie en priority voor de uitvoeringsvolgorde.POST /api/TopicActions/bulk – Bearer JWTPUT /api/TopicActions/{id} – Bearer JWTpriority bij van een bestaande koppeling.DELETE /api/TopicActions/{id} – Bearer JWTtopicActionIDtopicID, specialTopictopicID; hook/event-automatisering gebruikt specialTopic en wordt behandeld op de pagina over Hooks.actionIDpriorityPUT /api/TopicActions/{id}. Moet nul of hoger zijn.channelID, specialChannelEmail, Chat, Phone, WhatsApp, Teams en All.topicName, actionName, channelNamedocumentIDactionID voor de actie-definitie.TopicDocuments koppelen prompt-documenten aan topics of speciale topics. De huidige DTO is beperkt tot topic/special-topic, document en kanaal/special-channel velden.
GET /api/TopicDocuments – Bearer JWTtopicId, documentId, channelId, hookName, isHook, paginering en sortering.GET /api/TopicDocuments/{id} – Bearer JWTPOST /api/TopicDocuments – Bearer JWTPOST /api/TopicDocuments/bulk – Bearer JWTPUT /api/TopicDocuments/{id} – Bearer JWTDELETE /api/TopicDocuments/{id} – Bearer JWTtopicDocumentIDtopicID, specialTopictopicID. Prompt-context voor hooks gebruikt specialTopic en wordt behandeld op de Hooks-pagina.documentIDchannelID, specialChannelspecialChannel moet zijn: Email, Chat, Phone, WhatsApp, Teams of All.customerID, topicName, documentName, channelNamePOST /api/Topics
{
"name": "Order status",
"description": "Questions about order tracking and delivery status",
"phoneSettings": {
"modelOverridesByCustomerType": {
"Lead": 12,
"Customer": 18
}
}
} POST /api/TopicChannels
{
"topicID": 101,
"specialChannel": "Email"
} POST /api/TopicActions
{
"topicID": 101,
"actionID": 55,
"priority": 10,
"specialChannel": "All"
} POST /api/TopicDocuments
{
"topicID": 101,
"documentID": 501,
"specialChannel": "All"
} POST /api/PageTopicMappings
{
"topicID": 101,
"urlPattern": "/pricing",
"matchType": "Contains",
"pathScope": "RelativePath",
"specialChannel": "Chat"
} PageTopicMappings koppelen URL-patronen aan topics, waardoor pagina-bewuste topicselectie mogelijk is voor web- en chatcontexten.
GET /api/PageTopicMappings – Bearer JWTGET /api/PageTopicMappings/{id} – Bearer JWTPOST /api/PageTopicMappings – Bearer JWTPUT /api/PageTopicMappings/{id} – Bearer JWTDELETE /api/PageTopicMappings/{id} – Bearer JWTpageTopicMappingIDtopicID, specialTopicurlPatternmatchTypeExact, StartsWith, Contains of EndsWith.pathScopeDomain, Hostname, RelativePath of FullPath.channelID, specialChannelcustomerID, topicName, channelNamecreatedByCustomerRepID, creationDate, lastModifiedByCustomerRepID, lastModifiedDateDe onderstaande voorbeelden gebruiken de huidige DTO-velden. Verouderde topic-link velden die niet langer deel uitmaken van de DTO’s worden bewust niet weergegeven.
topicIDname, descriptionphoneSettingscustomFieldRequirementsnamedescriptionphoneSettings.modelOverridesByCustomerTypeLead, Customer en Partner. Model-ID’s moeten actief zijn en compatibel met belgebruik voor de klant of globale catalogus.customFieldRequirementscustomFieldDefinitionID, isRequiredfieldName, displayName, fieldType, descriptiontopicChannelIDtopicIDchannelID, specialChannelspecialChannel wordt genormaliseerd en moet Email, Chat, Phone, WhatsApp, Teams of All zijn.customerID, topicName, channelNamemode/api/Channels/{id}/topic-policy, gedocumenteerd op de Channels-pagina. Waarden zijn AllApplicableExcept en NoneExcept.includeTopicIds, excludeTopicIdstopicActionIDtopicID, specialTopictopicID; hook/event-automatisatie gebruikt specialTopic en wordt behandeld op de Hooks-pagina.actionIDpriorityPUT /api/TopicActions/{id}. Moet nul of hoger zijn.channelID, specialChannelEmail, Chat, Phone, WhatsApp, Teams en All.topicName, actionName, channelNamedocumentIDactionID voor de actiedefinitie.pageTopicMappingIDtopicID, specialTopicurlPatternmatchTypeExact, StartsWith, Contains of EndsWith.pathScopeDomain, Hostname, RelativePath of FullPath.channelID, specialChannelcustomerID, topicName, channelNamecreatedByCustomerRepID, creationDate, lastModifiedByCustomerRepID, lastModifiedDatetopicDocumentIDtopicID, specialTopictopicID. Hook-promptcontext gebruikt specialTopic en wordt behandeld op de Hooks-pagina.documentIDchannelID, specialChannelspecialChannel moet Email, Chat, Phone, WhatsApp, Teams of All zijn.customerID, topicName, documentName, channelNameBeschermde AnswerPal API-endpoints gebruiken JWT Bearer-authenticatie. De topic-lijst-/detailroutes accepteren ook telefonische-authenticatiecontext via TicketAccessOrPhoneAuth; settings-routes vereisen ManageSettings.
PaginatedResult<T> terug met items, totalCount en totalPages.channelId opgeven resulteert in 403.Gebruik de tab Voorbeeldrequests hierboven voor kopieerbare payloads.
Ja. GET /api/Topics en GET /api/Topics/{id} gebruiken TicketAccessOrPhoneAuth. Telefonische-authenticatieverzoeken zijn beperkt tot de klant en het kanaal van het token.
Ze worden afgeleid uit gekoppelde topicdocumenten en specialTopic=All-documenten die overeenkomen met de topic- en kanaalcontext. customFieldRequirements meesturen bij aanmaak/wijziging van een Topic is legacy-compatibel maar wordt genegeerd.
TopicChannels geven standaard topicrelevantie aan voor een kanaal of kanaaltype. Kanaalonderwerpbeleid, gedocumenteerd op de Channels-pagina, voegt include/exclude-overrides toe voor één concreet kanaal.
Neen. PUT /api/TopicActions/{id} werkt momenteel enkel priority bij. Maak een nieuwe koppeling aan als de combinatie topic/actie/kanaal moet wijzigen.
AnswerPal: AI-gedreven oplossingen voor klantenservice die je ondersteuning en communicatie moeiteloos versterken.
Voor ondersteunings-, commerciële en partnervragen kunt u mailen naar [email protected]
AnswerPal
Bisschoppenhoflaan 380
2100 Antwerpen
België
+32.36416685
BE 0862.692.858