JavaScript SDK: 알림 참조
서명이 포함된 알림을 보내고 관리하는 모든 방법입니다.
6분 읽기·레벨 참조·2026. 10. 12.에 개정됨
이 영어 텍스트는 프랑스어 원본에서 자동으로 생성되었으며 아직 검토되지 않았습니다.
이 페이지는 자동으로 번역되었습니다. 영어 버전은 권위가 있습니다.
#
수업
알림서비스
| 재산 | 설명 |
|---|---|
readonly admin: NotificationsAdminService | 관리 하위 클라이언트: 통계, 대기열, 스크랩(DLQ), 공급업체 로그, 이벤트, 규칙 및 설정. |
| 방법 | 설명 |
|---|---|
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>> | 보낼 알림을 대기열에 넣습니다(Modern Object API). |
sendBatch(items: Array<SendNotificationRequest | SendNotificationItem>): Promise<AuraResponse<BatchSendResponse>> | 일괄 알림(POST /send/batch)을 보냅니다. |
sendEmail(recipient: string, subject: string, body: string, options?: SendEmailOptions): Promise<AuraResponse<Notification>> | 거래 이메일(channel: 'email')을 보냅니다. |
sendSms(recipient: string, body: string, options?: SendSmsOptions): Promise<AuraResponse<Notification>> | 트랜잭션 SMS(channel: 'sms')를 보냅니다. |
sendPush(recipient: string, title: string, body: string, options?: SendPushOptions): Promise<AuraResponse<Notification>> | 모바일 푸시 알림(channel: 'push', FCM 또는 APN)을 보냅니다. |
sendWebhook(targetUrl: string, event: string, payload: string | Record<string, unknown>, options?: SendWebhookOptions): Promise<AuraResponse<Notification>> | 나가는 HTTP POST 웹훅(channel: 'webhook')을 발행합니다. |
retry(id: string): Promise<AuraResponse<Notification>> | 실패한 알림(status: 'failed' 또는 '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[]>> | channel, status 및 search로 필터링할 수 있고 created_at, updated_at 또는 status로 정렬하고 limit / offset 페이지 매김을 사용하여 프로젝트의 알림 기록을 나열합니다. |
get(id: string): Promise<AuraResponse<Notification>> | 식별자로 알림을 읽습니다. |
listTemplates(): Promise<AuraResponse<NotificationTemplate[]>> | 프로젝트 메시지 템플릿을 나열합니다. |
getTemplate(id: string): Promise<AuraResponse<NotificationTemplate>> | 식별자로 메시지 템플릿을 읽습니다. |
createTemplate(template: Omit<NotificationTemplate, 'id' | 'project_id' | 'created_at' | 'updated_at'>): Promise<AuraResponse<NotificationTemplate>> | 템플릿 — name, channel, subject, body만 생성합니다. |
updateTemplate(id: string, updates: Partial<Pick<NotificationTemplate, 'name' | 'subject' | 'body'>>): Promise<AuraResponse<NotificationTemplate>> | 템플릿을 업데이트합니다: name, subject 및/또는 body. |
deleteTemplate(id: string): Promise<AuraResponse<null>> | 메시지 템플릿을 삭제합니다. |
#
수업
알림관리 서비스
| 방법 | 설명 |
|---|---|
getSettings(): Promise<AuraResponse<NotificationSettingsPublic>> | 프로젝트의 공개 공급자 및 할당량 설정(GET /settings)을 검색합니다. |
updateSettings(settings: NotificationSettingsPatch | Partial<NotificationSettings>): Promise<AuraResponse<NotificationSettingsPublic>> | 프로젝트의 공급업체 또는 할당량 설정(PATCH /settings)을 업데이트합니다. |
getStats(options?: { window?: NotificationStatsWindow; channel?: NotificationChannel; }): Promise<AuraResponse<NotificationStats>> | 집계된 전송 통계(GET /stats). |
getQueue(): Promise<AuraResponse<NotificationQueueStats>> | 전송 대기열의 상태(보류 중인 알림의 깊이 및 배포)를 읽습니다. |
listAttempts(notificationId: string): Promise<AuraResponse<NotificationAttempt[]>> | 알림 전송 시도와 각각에 대한 공급자의 응답을 나열합니다. |
listDeadLetters(options?: { channel?: NotificationChannel; search?: string; limit?: number; offset?: number; }): Promise<AuraResponse<NotificationDeadLetter[]>> | channel 및 search로 필터링할 수 있는 가비지 큐(DLQ)에 배치된 알림을 나열합니다. |
retryDeadLetter(id: string): Promise<AuraResponse<Notification>> | 스크랩 대기열(DLQ)에서 특정 알림을 다시 보냅니다. |
listEvents(options?: { status?: 'received' | 'matched' | 'ignored' | 'failed' | 'enqueued'; limit?: number; offset?: number; }): Promise<AuraResponse<NotificationEvent[]>> | status로 필터링할 수 있는 규칙 엔진에서 수신한 이벤트를 나열합니다. |
listProviderLogs(options?: { channel?: NotificationChannel; status?: NotificationAttemptStatus; limit?: number; offset?: number; }): Promise<AuraResponse<NotificationProviderLog[]>> | 타사 공급업체 실행 로그(GET /providers/logs). |
previewTemplate(id: string, variables: Record<string, unknown>): Promise<AuraResponse<NotificationTemplatePreview>> | 메시지를 보내지 않고 미리보기를 위해 지정된 variables를 사용하여 모델을 렌더링합니다. |
listRules(): Promise<AuraResponse<NotificationRule[]>> | 프로젝트 알림 규칙을 나열합니다(전송 자동 트리거). |
createRule(rule: CreateNotificationRuleRequest): Promise<AuraResponse<NotificationRule>> | 알림 규칙을 만듭니다. condition를 확인하는 trigger_type 유형의 각 이벤트에 대해 메시지는 선택적 지연을 포함하여 channel에서 recipient_expr가 지정한 수신자에게 전송됩니다. |
getRule(id: string): Promise<AuraResponse<NotificationRule>> | 식별자별로 알림 규칙을 읽습니다. |
updateRule(id: string, updates: UpdateNotificationRuleRequest): Promise<AuraResponse<NotificationRule>> | 알림 규칙을 업데이트합니다. 제공된 필드만 변경됩니다(예: enabled). |
deleteRule(id: string): Promise<AuraResponse<null>> | 알림 규칙을 삭제합니다. |
생성된 페이지
이 페이지는 SDK의 유형 선언 및 주석에서 생성되므로 게시된 코드에서 표류할 수 없습니다. 실제 사례를 보려면 가이드를 읽어보세요.
마지막 업데이트 · 2026. 10. 12.