JavaScript SDK: справочник по уведомлениям
Каждый метод отправки и администрирования уведомлений со своей сигнатурой.
6 мин читать·Уровень ссылка·Пересмотрено 12 окт. 2026 г.
Этот текст на английском языке был создан автоматически на основе французского оригинала и еще не проверялся.
Эта страница была переведена автоматически. Английская версия является авторитетной.
#
Сорт
УведомленияСервис
| Свойство | Описание |
|---|---|
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>> | Отправляет мобильное push-уведомление (channel: 'push', FCM или APNs). |
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[]>> | Перечисляет уведомления, помещенные в очередь мусора (DLQ), фильтруемые по channel и search. |
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>> | Создает правило уведомления: для каждого события типа trigger_type, которое проверяет condition, сообщение отправляется 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, поэтому она не может отличаться от опубликованного кода. Рабочие примеры можно найти в руководствах.
Последнее обновление · 12 окт. 2026 г.