Hookconfiguratie is klantgericht. Een hook-actie koppelt een herbruikbare actiedefinitie aan een hook-naam en optioneel kanaaldoel. Een hook-document koppelt een document aan dezelfde hook-naam zodat prompts gebeurtenisspecifieke instructies kunnen bevatten. Tijdens runtime kunnen TicketMessages-endpoints hook promptdocumenten ophalen of de geconfigureerde actie-keten voor een bericht uitvoeren.
GET /api/HookActions – Bearer JWTPOST /api/HookActions – Bearer JWTPOST /api/HookActions/bulk – Bearer JWTGET /api/HookActions/{id} – Bearer JWTPUT /api/HookActions/{id} – Bearer JWTDELETE /api/HookActions/{id} – Bearer JWTGET /api/HookActions/wait-seconds – Bearer JWTGET /api/HookDocuments/promptDocuments – TicketAccessOrPhoneAuthPOST /api/HookDocuments – Bearer JWTGET /api/TicketMessages/{id}/promptDocuments – TicketAccessOrPhoneAuthPOST /api/TicketMessages/{id}/execute-hook – TicketAccessOrPhoneAuthGET /api/TicketMessages/{id}/execute-single-action – TicketAccessHuidige HookName enumwaarden:
PreSpam, PostSpam, PostTopicDetectionOnEscalate, PostEscalate, OnEscalateFailedOnClose, UserTriggeredOnEndUserAdd, OnEndUserUpdate, OnEndUserDeleteOnPhonePickup, OnPhonePickupSayGET /api/HookDocuments/promptDocuments, GET /api/TicketMessages/{id}/promptDocuments en POST /api/TicketMessages/{id}/execute-hook ondersteunen telefoon-authenticatie context waar geconfigureerd. Telefoon-auth-calls worden met 403 afgewezen wanneer het gevraagde of berichtkanaal afwijkt van het tokenkanaal.GET /api/HookActions vereist hookName of actionId. Ticket-bericht-promptdocumenten kunnen ook 400 opleveren als historische data wordt opgevraagd zonder dat er een OpenAI API-sleutel voor de klant aanwezig is.hookActionIDhookNameactionID, actionNamechannelID, channelNamespecialChannelprioritypageNumber, pageSize, sortBy, sortOrderitems, totalCount, totalPagestotalWaitSeconds/api/HookActions/wait-seconds.topicDocumentID, customerIDtopicID, specialTopicdocumentID, documentNamechannelID, channelName, specialChanneldocumentID, name, content, contentTypeincludeInRealtimeInstructions, imageUrlspromptDocumentsendUsers, ticketsonlyPromptDocumentsmessagefinishedstageGET /api/HookActions?hookName=PreSpam&pageNumber=1&pageSize=10&sortBy=Priority&sortOrder=asc
Authorization: Bearer <token>POST /api/HookActions
Authorization: Bearer <token>
Content-Type: application/json
{
"hookName": "OnEscalate",
"actionID": 123,
"channelID": 5,
"specialChannel": null,
"priority": 10
}POST /api/HookDocuments
Authorization: Bearer <token>
Content-Type: application/json
{
"topicID": null,
"specialTopic": "OnPhonePickup",
"documentID": 501,
"channelID": 5,
"specialChannel": null
}GET /api/TicketMessages/987/promptDocuments?hookName=OnPhonePickup&onlyPromptDocuments=true
Authorization: Bearer <token>
POST /api/TicketMessages/987/execute-hook?hookName=OnPhonePickup
Authorization: Bearer <token>GET /api/HookActions/wait-seconds?channelId=5&hookName=OnPhonePickup
Authorization: Bearer <token>HookName-enumwaarden exact. Bedenk geen hook-namen buiten de enum.channelID voor een specifiek kanaal en specialChannel voor brede targeting zoals All of een kanaaltype. Vermijd beide tegelijk in te stellen, tenzij de gewenste prioriteit duidelijk is.PostTopicDetection combineert de runtime-actiezoekopdracht hook-acties met acties gekoppeld aan gedetecteerde berichtonderwerpen./api/HookActions/wait-seconds vóór telefoon-opname/say-flows wanneer de UI of telefonie de totale wachttijd nodig heeft.GET /api/HookActions vereist hookName of actionId. De endpoint geeft alleen hook-records met actieve acties terug, en sluit specialTopic=All uit.
POST /api/HookActions en POST /api/HookActions/bulk koppelen hookName aan de hook special topic en stellen de klanten-scope server-side in.
PUT /api/HookActions/{id} werkt enkel de priority bij. GET /api/HookActions/wait-seconds telt actieve Wait-acties op na kanaal- en hook-matching.
GET /api/HookDocuments/promptDocuments geeft hookpromptdocumenten terug. POST /api/HookDocuments maakt een hook-documentlink aan op basis van het TopicDocumentCreateDTO-formaat.
Gebruik /api/TicketMessages/{id}/promptDocuments en /api/TicketMessages/{id}/execute-hook wanneer een specifiek bericht de runtime-context voor de hook is.
Huidige HookName-enumwaarden:
PreSpam, PostSpam, PostTopicDetectionOnEscalate, PostEscalate, OnEscalateFailedOnClose, UserTriggeredOnEndUserAdd, OnEndUserUpdate, OnEndUserDeleteOnPhonePickup, OnPhonePickupSayEen hook is een benoemd workflowevenement zoals PreSpam, PostTopicDetection, OnEscalate of OnPhonePickup. Hook-acties en hook-documenten koppelen automatisatie en promptcontext aan dat evenement.
De herbruikbare actiedefinitie bevindt zich in /api/Actions. /api/HookActions koppelt die actie aan een hook-naam, kanaaldoel en prioriteit.
Ze gebruiken hetzelfde topic-documentlinkformaat, maar voor hooks is topicID null en bevat specialTopic de hook-naam.
Ja, voor endpoints die TicketAccessOrPhoneAuth toelaten, maar het tokenkanaal moet overeenkomen met het gevraagde of berichtkanaal. Mismatches geven 403 Forbidden terug.
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