JavaScript SDK: referentie voor meldingen
Elke methode voor het verzenden en beheren van meldingen, met zijn handtekening.
6 min lezen·Niveau referentie·Herzien op 12 okt 2026
Deze Engelse tekst is automatisch gegenereerd op basis van het Franse origineel en is nog niet beoordeeld.
Deze pagina is automatisch vertaald. De Engelse versie is gezaghebbend.
#
Klasse
MeldingenService
| Eigendom | Beschrijving |
|---|---|
readonly admin: NotificationsAdminService | Beheer subclient: statistieken, wachtrij, afval (DLQ), leverancierslogboeken, gebeurtenissen, regels en instellingen. |
| Methode | Beschrijving |
|---|---|
send(options: SendNotificationOptions): Promise<AuraResponse<Notification>>send(channel: NotificationChannel, recipient: string, body: string, options?: { subject?: string; templateId?: string; variables?: Record<string, unknown>; metadata?: Record<string, unknown>; idempotencyKey?: string; }): Promise<AuraResponse<Notification>> | Zet een melding in de wachtrij voor verzending (Modern Object API). |
sendBatch(items: Array<SendNotificationRequest | SendNotificationItem>): Promise<AuraResponse<BatchSendResponse>> | Verzendt een batch meldingen (POST /send/batch). |
sendEmail(recipient: string, subject: string, body: string, options?: SendEmailOptions): Promise<AuraResponse<Notification>> | Stuurt een transactionele e-mail (channel: 'email'). |
sendSms(recipient: string, body: string, options?: SendSmsOptions): Promise<AuraResponse<Notification>> | Verzendt een transactionele sms (channel: 'sms'). |
sendPush(recipient: string, title: string, body: string, options?: SendPushOptions): Promise<AuraResponse<Notification>> | Verzendt een mobiele pushmelding (channel: 'push', FCM of APNs). |
sendWebhook(targetUrl: string, event: string, payload: string | Record<string, unknown>, options?: SendWebhookOptions): Promise<AuraResponse<Notification>> | Geeft een uitgaande HTTP POST-webhook uit (channel: 'webhook'). |
retry(id: string): Promise<AuraResponse<Notification>> | Probeer een mislukte melding opnieuw (status: 'failed' of 'dead_lettered'). |
list(options?: { channel?: NotificationChannel; status?: NotificationStatus; search?: string; sort?: 'created_at' | 'updated_at' | 'status'; order?: 'asc' | 'desc'; limit?: number; offset?: number; }): Promise<AuraResponse<Notification[]>> | Geeft de meldingsgeschiedenis van het project weer, filterbaar op channel, status en search, gesorteerd op created_at, updated_at of status, met limit / offset paginering. |
get(id: string): Promise<AuraResponse<Notification>> | Leest een melding op basis van zijn ID. |
listTemplates(): Promise<AuraResponse<NotificationTemplate[]>> | Geeft een overzicht van de projectberichtsjablonen. |
getTemplate(id: string): Promise<AuraResponse<NotificationTemplate>> | Leest een berichtsjabloon op basis van zijn ID. |
createTemplate(template: Omit<NotificationTemplate, 'id' | 'project_id' | 'created_at' | 'updated_at'>): Promise<AuraResponse<NotificationTemplate>> | Creëert een sjabloon — name, channel, subject, body en niets anders. |
updateTemplate(id: string, updates: Partial<Pick<NotificationTemplate, 'name' | 'subject' | 'body'>>): Promise<AuraResponse<NotificationTemplate>> | Werkt een sjabloon bij: name, subject en/of body. |
deleteTemplate(id: string): Promise<AuraResponse<null>> | Verwijdert een berichtsjabloon. |
#
Klasse
MeldingenAdminService
| Methode | Beschrijving |
|---|---|
getSettings(): Promise<AuraResponse<NotificationSettingsPublic>> | Haalt de openbare leveranciers- en quota-instellingen van het project op (GET /settings). |
updateSettings(settings: NotificationSettingsPatch | Partial<NotificationSettings>): Promise<AuraResponse<NotificationSettingsPublic>> | Werkt de leveranciers- of quota-instellingen van het project bij (PATCH /settings). |
getStats(options?: { window?: NotificationStatsWindow; channel?: NotificationChannel; }): Promise<AuraResponse<NotificationStats>> | Geaggregeerde verzendstatistieken (GET /stats). |
getQueue(): Promise<AuraResponse<NotificationQueueStats>> | Leest de status van de verzendwachtrij: diepte en distributie van openstaande meldingen. |
listAttempts(notificationId: string): Promise<AuraResponse<NotificationAttempt[]>> | Geeft een overzicht van pogingen om een melding te verzenden, met op elke melding het antwoord van de provider. |
listDeadLetters(options?: { channel?: NotificationChannel; search?: string; limit?: number; offset?: number; }): Promise<AuraResponse<NotificationDeadLetter[]>> | Geeft meldingen weer die in de afvalwachtrij (DLQ) zijn geplaatst, filterbaar op channel en search. |
retryDeadLetter(id: string): Promise<AuraResponse<Notification>> | Verzendt een specifieke melding opnieuw vanuit de afvalwachtrij (DLQ). |
listEvents(options?: { status?: 'received' | 'matched' | 'ignored' | 'failed' | 'enqueued'; limit?: number; offset?: number; }): Promise<AuraResponse<NotificationEvent[]>> | Geeft een overzicht van gebeurtenissen die zijn ontvangen door de regelengine, filterbaar op status. |
listProviderLogs(options?: { channel?: NotificationChannel; status?: NotificationAttemptStatus; limit?: number; offset?: number; }): Promise<AuraResponse<NotificationProviderLog[]>> | Uitvoeringslogboeken van externe leveranciers (GET /providers/logs). |
previewTemplate(id: string, variables: Record<string, unknown>): Promise<AuraResponse<NotificationTemplatePreview>> | Rendert een model met de opgegeven variables als voorbeeld, zonder een bericht te verzenden. |
listRules(): Promise<AuraResponse<NotificationRule[]>> | Geeft een overzicht van de projectmeldingsregels (automatische activering van een verzending). |
createRule(rule: CreateNotificationRuleRequest): Promise<AuraResponse<NotificationRule>> | Creëert een notificatieregel: voor elke gebeurtenis van het type trigger_type die condition controleert, wordt er een bericht verzonden op channel naar de ontvanger opgegeven door recipient_expr, met een optionele vertraging. |
getRule(id: string): Promise<AuraResponse<NotificationRule>> | Leest een meldingsregel op basis van zijn ID. |
updateRule(id: string, updates: UpdateNotificationRuleRequest): Promise<AuraResponse<NotificationRule>> | Werkt een meldingsregel bij: alleen de opgegeven velden veranderen (bijvoorbeeld enabled). |
deleteRule(id: string): Promise<AuraResponse<null>> | Verwijdert een meldingsregel. |
Gegenereerde pagina
Deze pagina wordt gegenereerd op basis van de typedeclaraties en opmerkingen van de SDK, zodat deze niet kan afwijken van de gepubliceerde code. Lees de handleidingen voor uitgewerkte voorbeelden.
Laatst bijgewerkt · 12 okt 2026