Gratis setup bij jaarabonnementen

Meld je vandaag aan!

Onderwerpen

API-referentie: Topics endpoints

De Topics API beheert de categorieën die AnswerPal gebruikt om conversaties te classificeren en topic-specifieke automatisering aan te sturen. De huidige implementatie omvat topicdefinities, kanaalrelevantie, koppelingen tussen onderwerpen en acties, koppelingen tussen onderwerpen en documenten, pagina-tot-topic-mapping en een gerelateerde hulp voor conditionele regels.

Overzicht en huidige endpoints

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.

Topics

  • GET /api/Topics – Bearer JWT (TicketAccessOrPhoneAuth)
    Toon topics met paginering en sortering. Optionele query channelId beperkt de resultaten tot topics toegestaan voor dat kanaal; aanvragen met telefoon-auth gebruiken het tokenkanaal.
  • GET /api/Topics/{id} – Bearer JWT (TicketAccessOrPhoneAuth)
    Lees één topic. Optionele channelId past dezelfde kanaaltoegangsfilter toe en geeft 404 terug wanneer het topic niet is toegestaan voor dat kanaal.
  • POST /api/Topics – Bearer JWT (ManageSettings)
    Maak een topic aan. De server stelt de klantscope in en valideert model-overrides voor telefoon voor het opslaan.
  • PUT /api/Topics/{id} – Bearer JWT (ManageSettings)
    Werk topicnaam, beschrijving en telefooninstellingen bij. Invoer voor customFieldRequirements in legacy wordt genegeerd omdat de vereisten nu worden afgeleid van gekoppelde documenten.
  • DELETE /api/Topics/{id} – Bearer JWT (ManageSettings)
    Verwijder een eigen topic. Geeft 204 bij succes of 404 wanneer het topic ontbreekt.

TopicChannels

  • GET /api/TopicChannels – Bearer JWT (ManageSettings)
    Toon koppelingen tussen topics en kanalen. Query ondersteunt topicId, channelId, pageNumber, pageSize, sortBy en sortOrder. pageNumber wordt genormaliseerd en pageSize wordt beperkt tot 1-100.
  • GET /api/TopicChannels/{id} – Bearer JWT (ManageSettings)
    Lees één koppeling tussen topic en kanaal binnen de gescopeerde klant.
  • POST /api/TopicChannels – Bearer JWT (ManageSettings)
    Maak een standaardrelevantie-koppeling tussen een topic en een specifiek kanaal of een speciaal kanaaltype. Dubbele combinaties geven 409 Conflict.
  • POST /api/TopicChannels/bulk – Bearer JWT (ManageSettings)
    Maak meerdere koppelingen tussen topics en kanalen. Dubbele invoerrijen en reeds bestaande combinaties worden door de service overgeslagen.
  • DELETE /api/TopicChannels/{id} – Bearer JWT (ManageSettings)
    Verwijder een koppeling tussen topic en kanaal.
  • DELETE /api/TopicChannels/bulk – Bearer JWT (ManageSettings)
    Verwijder meerdere koppelingen tussen topics en kanalen. De request body is een array van TopicChannelID-waarden; een lege body geeft 400 terug.

TopicActions

  • GET /api/TopicActions – Bearer JWT
    Toon koppelingen tussen topics en acties. Filters zijn onder andere topicId, actionId, hookName, channelId, isActive, paginering en sortering.
  • GET /api/TopicActions/{id} – Bearer JWT
    Lees één koppeling tussen topic en actie met opgeloste topic-, actie- en kanaalnamen.
  • POST /api/TopicActions – Bearer JWT
    Maak een koppeling tussen topic en actie. Gebruik actionID voor de herbruikbare actiedefinitie en priority voor de uitvoeringsvolgorde.
  • POST /api/TopicActions/bulk – Bearer JWT
    Maak meerdere koppelingen tussen topics en acties. Bestaande overeenkomende combinaties worden overgeslagen.
  • PUT /api/TopicActions/{id} – Bearer JWT
    Werk enkel het veld priority van een bestaande koppeling bij.
  • DELETE /api/TopicActions/{id} – Bearer JWT
    Verwijder één koppeling tussen topic en actie.

TopicDocuments

  • GET /api/TopicDocuments – Bearer JWT
    Toon koppelingen tussen topics en documenten. Filters omvatten topicId, documentId, channelId, hookName, isHook, paginering en sortering.
  • GET /api/TopicDocuments/{id} – Bearer JWT
    Lees één koppeling tussen topic en document binnen de gescopeerde klant.
  • POST /api/TopicDocuments – Bearer JWT
    Maak een koppeling tussen een document en een topic, speciaal topic, kanaal of speciaal kanaal. Dubbele combinaties geven 409 Conflict.
  • POST /api/TopicDocuments/bulk – Bearer JWT
    Maak meerdere koppelingen tussen topics en documenten. De huidige bulk create geeft een serverfout als de database dubbele combinaties weigert.
  • PUT /api/TopicDocuments/{id} – Bearer JWT
    Werk document, topic/speciaal topic en kanaal/speciaal kanaal velden bij voor één koppeling.
  • DELETE /api/TopicDocuments/{id} – Bearer JWT
    Verwijder één koppeling tussen topic en document.

PageTopicMappings

  • GET /api/PageTopicMappings – Bearer JWT
    Toon URL-naar-topic koppelingen met de gedeelde pagineringsparameters.
  • GET /api/PageTopicMappings/{id} – Bearer JWT
    Lees één page-topic mapping binnen de gescopeerde klant.
  • POST /api/PageTopicMappings – Bearer JWT
    Maak een mapping van een URL-patroon en pathscope naar een topic of speciaal topic. De server slaat aanmaker en aanmaakdatum op.
  • PUT /api/PageTopicMappings/{id} – Bearer JWT
    Werk URL-patroon, matchtype, pathscope, topic/speciaal topic en kanaalscope bij. De server registreert de metadata van de laatste wijziging.
  • DELETE /api/PageTopicMappings/{id} – Bearer JWT
    Verwijder één page-topic mapping.

Gerelateerde helper

  • POST /api/ConditionalRules/from-text – Bearer JWT
    Gerelateerde automatiseringshelper. Zet een natuurlijke taalinstructie om naar JSON conditionele regels. De geauthenticeerde klant moet een OpenAI API-sleutel geconfigureerd hebben.

Toegang en foutmeldingen

Beschermde AnswerPal API endpoints gebruiken JWT Bearer-authenticatie. De lijst- en detailroutes voor topics aanvaarden ook telefonische-authenticatiecontext via TicketAccessOrPhoneAuth; instellingenroutes vereisen ManageSettings.

  • Lijstroutes geven PaginatedResult<T> met items, totalCount en totalPages terug.
  • Succesvolle create-routes geven gewoonlijk 201 Created of 200 OK terug bij bulk create. Succesvolle update- en delete-routes geven meestal 204 No Content.
  • 400 wordt gebruikt voor validatiefouten, 403 voor verboden combinaties van phone-auth/kanaal, 404 voor ontbrekende of ontoegankelijke resources en 409 voor dubbele single-link creates waarbij de API conflicten behandelt.
  • Telefonische authenticatie topic reads zijn verbonden aan het tokenkanaal. Een andere channelId meegeven resulteert in 403.

Endpointdetails

Onderwerpen

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)
    Lijst onderwerpen met paginatie en sortering. Optionele query 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)
    Leest één onderwerp. Optionele 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)
    Maak één onderwerp aan. De server stelt de klantscope in en valideert overrides voor telefoonmodellen voor het opslaan.
  • PUT /api/Topics/{id} – Bearer JWT (ManageSettings)
    Wijzig onderwerpnaam, beschrijving en telefooninstellingen. Invoer voor customFieldRequirements via legacy wordt genegeerd omdat vereisten nu afgeleid worden uit gekoppelde documenten.
  • DELETE /api/Topics/{id} – Bearer JWT (ManageSettings)
    Verwijder één eigen onderwerp. Geeft 204 bij succes of 404 als het onderwerp ontbreekt.

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.

Onderwerpkoppelingen

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)
    Lijst links tussen onderwerp en kanaal op basis van relevantie. Query ondersteunt topicId, channelId, pageNumber, pageSize, sortBy en sortOrder. pageNumber wordt genormaliseerd en pageSize wordt begrensd tot 1-100.
  • GET /api/TopicChannels/{id} – Bearer JWT (ManageSettings)
    Leest één onderwerp-kanaallink in de geauthenticeerde klantscope.
  • POST /api/TopicChannels – Bearer JWT (ManageSettings)
    Maak één standaardrelevantie-link aan tussen een onderwerp en ofwel een concreet kanaal of een speciaal kanaaltype. Dubbele combinaties geven 409 Conflict terug.
  • POST /api/TopicChannels/bulk – Bearer JWT (ManageSettings)
    Maak meerdere onderwerp-kanaallinks aan. Dubbele invoerrijen en reeds bestaande combinaties worden door de service overgeslagen.
  • DELETE /api/TopicChannels/{id} – Bearer JWT (ManageSettings)
    Verwijder één onderwerp-kanaalrelevantie-link.
  • DELETE /api/TopicChannels/bulk – Bearer JWT (ManageSettings)
    Verwijder meerdere onderwerp-kanaallinks. De request body is een array van TopicChannelID-waarden; een lege body geeft 400 terug.

Topicacties koppelen herbruikbare acties aan onderwerpen of onderwerp/kanaalcombinaties. Prioriteit behoort toe aan de link, niet aan de Action-definitie.

  • GET /api/TopicActions – Bearer JWT
    Lijst links tussen onderwerp en actie. Filters omvatten topicId, actionId, hookName, channelId, isActive, paginatie en sortering.
  • GET /api/TopicActions/{id} – Bearer JWT
    Leest één onderwerp-actielink met opgeloste onderwerp-, actie- en kanaalnamen.
  • POST /api/TopicActions – Bearer JWT
    Maak één onderwerp-actielink aan. Gebruik actionID voor de herbruikbare actiedefinitie en priority voor de uitvoeringsvolgorde.
  • POST /api/TopicActions/bulk – Bearer JWT
    Maak meerdere onderwerp-actielinks aan. Bestaande overeenkomende combinaties worden overgeslagen.
  • PUT /api/TopicActions/{id} – Bearer JWT
    Update enkel het veld priority van een bestaande link.
  • DELETE /api/TopicActions/{id} – Bearer JWT
    Verwijder één onderwerp-actielink.

Topicdocumenten koppelen promptdocumenten aan onderwerpen en kanaalscopes. De Documenten-API beheert documentdefinities; deze API beheert de koppeling.

  • GET /api/TopicDocuments – Bearer JWT
    Lijst links tussen onderwerp en document. Filters omvatten topicId, documentId, channelId, hookName, isHook, paginatie en sortering.
  • GET /api/TopicDocuments/{id} – Bearer JWT
    Leest één onderwerp-documentlink binnen de geauthenticeerde klantscope.
  • POST /api/TopicDocuments – Bearer JWT
    Maak één koppeling aan tussen een document en een onderwerp, special topic, kanaal of speciaal kanaal. Dubbele combinaties geven 409 Conflict terug.
  • POST /api/TopicDocuments/bulk – Bearer JWT
    Maak meerdere onderwerp-documentlinks aan. De huidige bulkcreate geeft een serverfout als de database dubbele combinaties weigert.
  • PUT /api/TopicDocuments/{id} – Bearer JWT
    Update document-, onderwerp/special topic- en kanaal/special channel-velden voor één link.
  • DELETE /api/TopicDocuments/{id} – Bearer JWT
    Verwijder één onderwerp-documentlink.

PageTopicMappings koppelen URL-patronen aan onderwerpen zodat webcontext onderwerpselectie of automatisering kan beïnvloeden.

  • GET /api/PageTopicMappings – Bearer JWT
    Lijst URL-naar-onderwerp mappings met de gedeelde paginatieparameters.
  • GET /api/PageTopicMappings/{id} – Bearer JWT
    Leest één pagina-onderwerp mapping binnen de geauthenticeerde klantscope.
  • POST /api/PageTopicMappings – Bearer JWT
    Maak één mapping van een URL-patroon en padscope naar een onderwerp of special topic. De server slaat maker en aanmaaktijd op.
  • PUT /api/PageTopicMappings/{id} – Bearer JWT
    Update URL-patroon, matchtype, padscope, onderwerp/special topic en kanaalscope. De server slaat laatst gewijzigde metadata op.
  • DELETE /api/PageTopicMappings/{id} – Bearer JWT
    Verwijder één pagina-onderwerp mapping.

Dit is een verwante helper voor automatiseringsregels, geen onderwerp-CRUD-endpoint.

  • POST /api/ConditionalRules/from-text – Bearer JWT
    Gerelateerde automatiseringshelper. Zet een instructie in natuurlijke taal om in JSON-voorwaardelijke regels. De geauthenticeerde klant moet een OpenAI API-sleutel hebben geconfigureerd.

Topicacties

Topicacties bepalen welke herbruikbare automatiseringsacties uitgevoerd worden voor een topic en binnen het bereik van een kanaal.

  • GET /api/TopicActions – Bearer JWT
    Lijst met topicactiekoppelingen. U kunt filteren op topicId, actionId, hookName, channelId, isActive, paginering en sortering.
  • GET /api/TopicActions/{id} – Bearer JWT
    Lees één topic-action koppeling met de opgeloste namen van het topic, de actie en het kanaal.
  • POST /api/TopicActions – Bearer JWT
    Maak één topic-action koppeling aan. Gebruik actionID voor de definitie van de herbruikbare actie en priority voor de uitvoeringsvolgorde.
  • POST /api/TopicActions/bulk – Bearer JWT
    Maak meerdere topicactiekoppelingen aan. Bestaande overeenkomende combinaties worden overgeslagen.
  • PUT /api/TopicActions/{id} – Bearer JWT
    Werk enkel het veld priority bij van een bestaande koppeling.
  • DELETE /api/TopicActions/{id} – Bearer JWT
    Verwijder één topic-action koppeling.

TopicAction-velden

  • topicActionID
    Koppelings-ID die wordt teruggegeven door read-endpoints.
  • topicID, specialTopic
    Gebruik één van deze velden. Gewone topic-automatisering gebruikt topicID; hook/event-automatisering gebruikt specialTopic en wordt behandeld op de pagina over Hooks.
  • actionID
    Vereist bij aanmaken. Verwijst naar de definitie van de herbruikbare actie uit de Actions API.
  • priority
    Vereist bij aanmaken en het enige veld dat wordt bijgewerkt door PUT /api/TopicActions/{id}. Moet nul of hoger zijn.
  • channelID, specialChannel
    Gebruik exact één kanaalbereik. Toegestane waarden voor special channel zijn Email, Chat, Phone, WhatsApp, Teams en All.
  • topicName, actionName, channelName
    Opgeloste labels teruggegeven door read-endpoints.
  • documentID
    Compatibiliteitsveld, momenteel aanwezig op TopicActionBaseDTO. Dit wordt niet opgeslagen op AP_TopicAction; gebruik actionID voor de actie-definitie.

Topicdocumenten

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 JWT
    Lijst met topic-document koppelingen. U kunt filteren op topicId, documentId, channelId, hookName, isHook, paginering en sortering.
  • GET /api/TopicDocuments/{id} – Bearer JWT
    Lees één topic-document koppeling binnen de reikwijdte van de geauthenticeerde klant.
  • POST /api/TopicDocuments – Bearer JWT
    Maak één koppeling tussen een document en een topic, speciaal topic, kanaal of speciaal kanaal aan. Dubbele combinaties retourneren 409 Conflict.
  • POST /api/TopicDocuments/bulk – Bearer JWT
    Maak meerdere topic-document koppelingen aan. Bij de huidige bulk-creatie geeft de server een fout als de database dubbele combinaties weigert.
  • PUT /api/TopicDocuments/{id} – Bearer JWT
    Werk de velden voor document, topic/speciaaltopic en kanaal/special- channel bij voor één koppeling.
  • DELETE /api/TopicDocuments/{id} – Bearer JWT
    Verwijder één topic-document koppeling.

TopicDocument-velden

  • topicDocumentID
    Koppelings-ID die wordt teruggegeven door read-endpoints.
  • topicID, specialTopic
    Het gewone prompt-context voor een topic gebruikt topicID. Prompt-context voor hooks gebruikt specialTopic en wordt behandeld op de Hooks-pagina.
  • documentID
    Vereiste positieve document-ID. Dit is de prompt/document definitie uit de Documenten-API.
  • channelID, specialChannel
    Gebruik exact één kanaalbereik. specialChannel moet zijn: Email, Chat, Phone, WhatsApp, Teams of All.
  • customerID, topicName, documentName, channelName
    Alleen-lezen gegevens voor eigenaarschap en opgeloste labels.
POST /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"
}

Paginatopic-koppelingen

PageTopicMappings koppelen URL-patronen aan topics, waardoor pagina-bewuste topicselectie mogelijk is voor web- en chatcontexten.

  • GET /api/PageTopicMappings – Bearer JWT
    Toont een lijst van URL-naar-topic-koppelingen met de gedeelde paginatieparameters.
  • GET /api/PageTopicMappings/{id} – Bearer JWT
    Leest één pagina-topic mapping binnen de gescopeerde, geauthenticeerde klant.
  • POST /api/PageTopicMappings – Bearer JWT
    Maakt een nieuwe mapping van een URL-patroon en paden-scope naar een topic of speciaal topic. De server registreert de maker en het aanmaaktijdstip.
  • PUT /api/PageTopicMappings/{id} – Bearer JWT
    Werk het URL-patroon, matchtype, paden-scope, topic/speciale topic en kanaalscope bij. De server bewaart metadata over de laatste wijziging.
  • DELETE /api/PageTopicMappings/{id} – Bearer JWT
    Verwijdert een pagina-topic mapping.

PageTopicMapping-velden

  • pageTopicMappingID
    Mapping-ID zoals geretourneerd door read-endpoints.
  • topicID, specialTopic
    Kies één topicdoel. Validatie vereist exact één van deze.
  • urlPattern
    Vereist URL-patroon, maximumlengte 2083.
  • matchType
    Vereiste match-operator: Exact, StartsWith, Contains of EndsWith.
  • pathScope
    Vereist URL-scope: Domain, Hostname, RelativePath of FullPath.
  • channelID, specialChannel
    Optionele kanaalscope. Maximaal één kan ingesteld zijn.
  • customerID, topicName, channelName
    Alleen voor response: eigendom en opgeloste labels.
  • createdByCustomerRepID, creationDate, lastModifiedByCustomerRepID, lastModifiedDate
    Auditmetadata ingesteld door de server.

Voorbeeldrequests

De onderstaande voorbeelden gebruiken de huidige DTO-velden. Verouderde topic-link velden die niet langer deel uitmaken van de DTO’s worden bewust niet weergegeven.

Velden en DTO's

Topic-velden

Topic response-velden

  • topicID
    Unieke topic-ID, geretourneerd door read-endpoints.
  • name, description
    Menselijk leesbaar topiclabel en optionele uitleg.
  • phoneSettings
    Optionele per-topic telefoonsinstellingen. Zie de telefooninstellingen hieronder.
  • customFieldRequirements
    Afgeleide vereisten voor aangepaste velden uit gelinkte documenten van toepassing op het topic en een optionele kanaalcontext.

Topic create/update-velden

  • name
    Verplicht; maximumlengte 100.
  • description
    Optionele vrije tekst.
  • phoneSettings.modelOverridesByCustomerType
    Optioneel woordenboek van eindklanttype naar call model ID. Toegestane sleutels zijn Lead, Customer en Partner. Model-ID’s moeten actief zijn en compatibel met belgebruik voor de klant of globale catalogus.
  • customFieldRequirements
    Input voor legacy compatibiliteit. Geaccepteerd door de DTO maar bewust genegeerd bij aanmaak en bijwerken; vereisten worden afgeleid uit gelinkte documenten.

Afgeleide customFieldRequirements-velden

  • customFieldDefinitionID, isRequired
    Definitie-identiteit en verplichte status afgeleid van bijdragende prompt-documenten.
  • fieldName, displayName, fieldType, description
    Opgeloste weergavemetadata uit de aangepaste klantvelddefinitie.

TopicChannel-velden

TopicChannel-velden

  • topicChannelID
    Koppelings-ID, geretourneerd door read-endpoints.
  • topicID
    Verplichte topic-ID. Het topic moet behoren tot de geauthenticeerde klant.
  • channelID, specialChannel
    Kies exact één. specialChannel wordt genormaliseerd en moet Email, Chat, Phone, WhatsApp, Teams of All zijn.
  • customerID, topicName, channelName
    Alleen voor response: eigendom en opgeloste labels.

Gerelateerde kanaal-topicbeleid-velden

  • mode
    Gebruikt door /api/Channels/{id}/topic-policy, gedocumenteerd op de Channels-pagina. Waarden zijn AllApplicableExcept en NoneExcept.
  • includeTopicIds, excludeTopicIds
    Uitdrukkelijke kanaal-topicoverrides. TopicChannels definiëren standaardrelevantie; kanaalbeleid bepaalt uiteindelijk de allowlist voor een specifiek kanaal.

TopicAction-velden

TopicAction-velden

  • topicActionID
    Koppelings-ID, geretourneerd door read-endpoints.
  • topicID, specialTopic
    Gebruik één van deze. Gewone topic-automatisatie gebruikt topicID; hook/event-automatisatie gebruikt specialTopic en wordt behandeld op de Hooks-pagina.
  • actionID
    Verplicht bij creatie. Verwijst naar de herbruikbare actiedefinitie uit de Actions API.
  • priority
    Verplicht bij creatie en het enige veld dat wordt bijgewerkt door PUT /api/TopicActions/{id}. Moet nul of hoger zijn.
  • channelID, specialChannel
    Gebruik exact één kanaalscope. Toegestane speciale kanaalwaarden zijn Email, Chat, Phone, WhatsApp, Teams en All.
  • topicName, actionName, channelName
    Opgeloste labels geretourneerd door read-endpoints.
  • documentID
    Compatibiliteitsveld momenteel aanwezig op TopicActionBaseDTO. Het wordt niet opgeslagen op AP_TopicAction; gebruik actionID voor de actiedefinitie.

PageTopicMapping-velden

PageTopicMapping-velden

  • pageTopicMappingID
    Mapping-ID zoals geretourneerd door read-endpoints.
  • topicID, specialTopic
    Kies één topicdoel. Validatie vereist exact één van deze.
  • urlPattern
    Vereist URL-patroon, maximumlengte 2083.
  • matchType
    Vereiste match-operator: Exact, StartsWith, Contains of EndsWith.
  • pathScope
    Vereist URL-scope: Domain, Hostname, RelativePath of FullPath.
  • channelID, specialChannel
    Optionele kanaalscope. Maximaal één kan ingesteld zijn.
  • customerID, topicName, channelName
    Alleen voor response: eigendom en opgeloste labels.
  • createdByCustomerRepID, creationDate, lastModifiedByCustomerRepID, lastModifiedDate
    Auditmetadata ingesteld door de server.

TopicDocument-velden

TopicDocument-velden

  • topicDocumentID
    Koppelings-ID geretourneerd door read-endpoints.
  • topicID, specialTopic
    Normale topic-promptcontext gebruikt topicID. Hook-promptcontext gebruikt specialTopic en wordt behandeld op de Hooks-pagina.
  • documentID
    Verplichte positieve document-ID. Dit is de prompt/documentdefinitie uit de Documenten-API.
  • channelID, specialChannel
    Gebruik exact één channel scope. specialChannel moet Email, Chat, Phone, WhatsApp, Teams of All zijn.
  • customerID, topicName, documentName, channelName
    Alleen-respons: eigenaarschap en opgeloste labels.

Responsenveloppen en voorbeelden

Beschermde AnswerPal API-endpoints gebruiken JWT Bearer-authenticatie. De topic-lijst-/detailroutes accepteren ook telefonische-authenticatiecontext via TicketAccessOrPhoneAuth; settings-routes vereisen ManageSettings.

  • Lijstroutes geven PaginatedResult<T> terug met items, totalCount en totalPages.
  • Succesvolle createroutes geven meestal 201 Created of 200 OK terug bij bulkcreatie. Succesvolle update- en deleteroutes geven meestal 204 No Content.
  • 400 wordt gebruikt voor validatiefouten, 403 bij verboden phone-auth-/channel-mismatches, 404 voor ontbrekende of ontoegankelijke resources, en 409 voor dubbele single-link-creaties waarbij de API conflicten afhandelt.
  • Telefonische authenticatie-topic-lezingen zijn gebonden aan het tokenkanaal. Een andere channelId opgeven resulteert in 403.

Voorbeeldpayloads

Gebruik de tab Voorbeeldrequests hierboven voor kopieerbare payloads.

FAQ

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.

Inhoudsopgave

AnswerPal: AI-gedreven oplossingen voor klantenservice die je ondersteuning en communicatie moeiteloos versterken.

Contact

Voor ondersteunings-, commerciële en partnervragen kunt u mailen naar [email protected]

AnswerPal
Bisschoppenhoflaan 380
2100 Antwerpen
België

+32.36416685

BE 0862.692.858