NotifyBC
Home
Docs
Help
GitHub
Home
Docs
Help
GitHub
  • Getting Started

    • Welcome
    • Overview
    • Quick Start
    • Installation
    • Web Console
    • What's New
  • Configuration

    • Configuration Overview
    • Database
    • Admin IP List
    • Reverse Proxy IP Lists
    • HTTP Host
    • Internal HTTP Host
    • Email
    • SMS
    • Subscription
    • Notification
    • Node Roles
    • Cron Jobs
    • RSA Keys
    • Worker Process Count
    • Middleware
    • OIDC
    • TLS Certificates
    • Queue
    • Logging
  • API

    • API Overview
    • Subscription
    • Notification
    • Configuration
    • Administrator
    • Bounce
  • Miscellaneous

    • Health Check
    • Disaster Recovery
    • Memory Dump
    • Benchmarks
    • Bulk Import
    • Developer Notes
    • Upgrade Guide
  • Meta

    • Code of Conduct
    • Security Reporting
    • Acknowledgments

Bounce

Bounce handling involves recording bounce messages into bounce records, which are implemented using this bounce API and model. Administrator can view bounce records in web console or through API explorer. Bounce record is for internal use and should be read-only under normal circumstances.

Model Schema

The API operates on following data model fields:

NameAttributes

channel

name of the delivery channel. Valid values: email, sms.

typestring
requiredtrue

userChannelId

user's delivery channel id, for example, email address.
typestring
requiredtrue

hardBounceCount

number of hard bounces recorded so far

typeinteger
requiredtrue

state

bounce record state. Valid values: active, deleted.

typestring
requiredtrue

bounceMessages

array of recorded bounce messages. Each element is an object containing the date bounce message was received and the message itself.

typearray
requiredfalse

latestNotificationStarted

latest notification started date.

typedate
requiredfalse

latestNotificationEnded

latest notification ended date.

typedate
requiredfalse

created

date and time bounce record was created

typedate
auto-generatedtrue

updated

date and time of bounce record was last updated

typedate
auto-generatedtrue

id

config id

typestring, format depends on db
auto-generatedtrue
Prev
Administrator
Next
Health Check