Gratis setup bij jaarabonnementen
Meld je vandaag aan!
Kanalen
API-referentie: Channel-endpoints
Overzicht
Huidige endpoints
Core channel-endpoints
GET/api/Channels– Bearer JWT, rollen klantmedewerkers
Toon alle channels voor de geauthenticeerde klant.POST/api/Channels– ManageSettings
Maak een channel aan. Als autoRetrieveEmails is ingeschakeld, wordt ook de auto-retrieve status van mappen bijgewerkt en worden e-mailabonnementen gegarandeerd.GET/api/Channels/{id}– Bearer JWT, rollen klantmedewerkers
Toon één channel in eigendom van de geauthenticeerde klant.PUT/api/Channels/{id}– ManageSettings
Werk één channel bij. Het wijzigen van autoRetrieveEmails past ook mappen en abonnementen aan.DELETE/api/Channels/{id}– ManageSettings
Verwijder één channel in eigendom van de geauthenticeerde klant.GET/api/Channels/{channelToken}/translations-by-token/{lang}– Publieke callback/token-endpoint
Geef channelvertalingen terug op basis van een publiek channel-token en taal, met fallback-verwerking.
Routering en onderwerpbeleid
GET/api/Channels/{id}/routing– Bearer JWT, rollen klantmedewerkers
Geef een channel-routeringsdefinitie, topics en routeringsregels terug.GET/api/Channels/{id}/topic-policy– ManageSettings
Geef het huidige onderwerpbeleid voor een channel terug.PUT/api/Channels/{id}/topic-policy– ManageSettings
Update het onderwerpbeleid met mode, includeTopicIds en excludeTopicIds. Ondersteunde modes zijn AllApplicableExcept en NoneExcept.
E-mailimport en verbindingstests
POST/api/Channels/import-emails– ImportEmails
Plaats e-mailimport in de wachtrij voor alle channels van de geauthenticeerde klant. Optionele query: maxCount.POST/api/Channels/{channelId}/import-emails– ImportEmails
Plaats e-mailimport in de wachtrij voor één channel. Optionele query: maxCount.POST/api/Channels/test-connection– ManageSettings
Test IMAP- en SMTP-instellingen. Body gebruikt ChannelTestConnectionDTO; channelID is optioneel.
Conflictopmerking: wanneer een Microsoft Graph client secret verlopen is, geven importverzoeken 409 Conflict terug met code GraphClientSecretExpired.
Channel-folder endpoints
GET/api/ChannelFolders/byChannel/{channelId}
Geef een overzicht van mappen voor een channel in eigendom van de geauthenticeerde klant.GET/api/ChannelFolders/fromMailbox/{channelId}
Lees mappen uit de daadwerkelijke mailboxprovider voor een channel.POST/api/ChannelFolders
Maak een gekoppelde map aan.GET/api/ChannelFolders/{id}
Lees één gekoppelde map.PUT/api/ChannelFolders/{id}
Werk één gekoppelde map bij.DELETE/api/ChannelFolders/{id}
Verwijder één gekoppelde map.
Conflictopmerking: dubbele mapkoppelingen geven 409 Conflict terug met code DuplicateChannelFolder.
Channel-vertaling endpoints
GET/api/ChannelTranslations/byChannel/{channelId}
Geef een overzicht van vertalingen voor een channel.POST/api/ChannelTranslations
Maak een vertaling aan voor een channel en taal.GET/api/ChannelTranslations/{id}
Lees één vertaling.PUT/api/ChannelTranslations/{id}
Werk tekstvelden bij. channelID en lang blijven vast na creatie.DELETE/api/ChannelTranslations/{id}
Verwijder één vertaling.
Toegang en authenticatie
Beveiligde endpoints gebruiken Authorization: Bearer <token>. De API beperkt lezen en schrijven tot de geauthenticeerde klant. Sommige bewerkingen vereisen beleidsregels of rollen:
ManageSettings: aanmaken, bijwerken, verwijderen, onderwerpbeleid en verbindingstests.ImportEmails: e-mailimporttaken in de wachtrij plaatsen.- Klantmedewerker-rollen: channel-lijst, lezen en routeringsweergaven.
- Publieke token-endpoint:
/api/Channels/{channelToken}/translations-by-token/{lang}.
Channel-velden
Kernvelden van channel
channelType
Vereiste string, max 20. Channeltype, zoals Email, Chat, Phone of WhatsApp.name
Vereiste string, max 100. Weergavenaam voor het channel.connectionDetails
Optionele connectie-/configuratiedetails.isActive
Of het channel actief is.autoRetrieveEmails
Stuurt automatische e-mailophaling en het instellen van abonnementen voor e-mailchannels aan.hostnames
Toegestane hostnames voor gebruik chat/widget.isDefaultTranslationChannel
Duidt het standaard channel aan voor fallback van vertalingen.phoneNumber
Telefoonnummer gekoppeld aan telefonie-flows.
Velden e-mailprovider en overrides
emailAddress,emailProviderType
Geeft de mailbox en het type provider aan.overrideEmailSettings,overrideGraphTenantID,overrideGraphClientID,overrideGraphClientSecret,overrideGraphAuthorityURL,overrideGraphScope
Overschrijft Microsoft Graph-instellingen voor dit channel.overrideImapServer,overrideImapPort,overrideImapUsername,overrideImapPassword,overrideImapUseSsl
Overschrijft inkomende mailboxinstellingen.overrideSmtpServer,overrideSmtpPort,overrideSmtpUsername,overrideSmtpPassword,overrideSmtpUseSsl
Overschrijft uitgaande e-mailinstellingen.
Alleen-respons channelvelden
channelID
Channel-ID.customerID
Eigendom van klant, wordt door de API ingesteld.token
Publiek token gebruikt door getokeniseerde endpoints zoals vertalingen per token.
ChannelFolder-velden
ChannelFolder-velden
folderName
Verplicht, string, max. 255. Weergavenaam van de gekoppelde map.externalFolderID
Verplicht, string, max. 255. Providermapidentificatie.isActive
Geeft aan of de mapkoppeling actief is.autoRetrieveEmails
Geeft aan of e-mails automatisch uit deze map worden opgehaald.folderDirection
Richtingsinstelling, standaard Both.channelID
Verplicht bij aanmaken en wordt weergegeven bij raadplegen.folderID
Gereserveerde identificatie voor de gekoppelde map.
MailboxFolder-responsvelden
id,displayName,fullName,depth,isInbox
Worden geretourneerd door GET /api/ChannelFolders/fromMailbox/{channelId}.
ChannelTranslation-velden
ChannelTranslation-velden
channelID
Verplicht bij aanmaken en wordt weergegeven bij raadplegen.lang
Verplicht, string, max. 3. Taalcode zoals en, nl of fr.chatTitle,defaultGreeting,sendButtonText
Kernlabels en begroeting van de chatwidget.escalatePrompt,availabilityCheck,agentJoin
Escalatie- en beschikbaarheidsberichten van medewerkers.yesText,noText,youText
Korte UI-labels.validEmail,submitButtonText,succesfulSubmission
Labels voor e-mailverificatie en formulierverzending.channelTranslationID
Gereserveerde identificatie voor de vertaalregel.
Responsvelden voor routing- en onderwerpbeleid
GET /api/Channels/{id}/routing geeft ChannelRoutingReadDTO terug met channel id, naam, type, scopemodus, een routeringsdefinitie, onderwerpen en URL-/regelovereenkomsten. GET /api/Channels/{id}/topic-policy geeft ChannelTopicPolicyReadDTO terug met modus, opgenomen onderwerp-id’s, uitgesloten onderwerp-id’s en onderwerpenlijsten.
Responsvelden connectietest
POST /api/Channels/test-connection geeft een ChannelTestResult terug met providerType, imap en smtp. Elk protocolresultaat bevat applicable, success, server, port, useSsl, error en durationMs.
FAQ
Gebruik GET /api/Channels. Deze geeft de kanalen terug die gekoppeld zijn aan de geauthenticeerde klant en vereist een van de customer representative-rollen.
Gebruik POST /api/Channels/test-connection met ChannelTestConnectionDTO. De response bevat het providertype en afzonderlijke IMAP/SMTP-protocoltestresultaten.
Gebruik POST /api/Channels/import-emails voor alle kanalen of POST /api/Channels/{channelId}/import-emails voor één kanaal. Beide plannen achtergrondtaken in en accepteren optioneel een maxCount queryparameter.
Gebruik /api/ChannelTranslations voor geauthenticeerd beheer, of GET /api/Channels/{channelToken}/translations-by-token/{lang} voor publieke tokengebaseerde opvraging.
Meer hulp nodig?
Inhoudstafel
AnswerPal: AI-gedreven oplossingen voor klantenservice die je ondersteuning en communicatie moeiteloos versterken.
Snelle links
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