Nyaraka za API

API ya Bounce

API ya kusindika na kuuliza bounces za barua pepe.

Ruhusa inayohitajika: subscribers

Aina za bounce

Type Description Action
hard Kushindikana kwa utoaji wa kudumu (barua pepe isiyopo) Kujitoa mara moja
soft Kushindikana kwa utoaji kwa muda (sanduku limejaa, n.k.) Kujitoa baada ya kurudiwa mara 3
complaint Ripoti ya barua taka Kukataliwa mara moja
GET /api/v1/bounces

Inapata orodha ya bounces.

Query Parameters

Parameter Type Description
limit integer Idadi ya matokeo (chaguomsingi: 20, upeo: 100)
offset integer Offset ya kurasa

Response

{
  "success": true,
  "data": {
    "bounces": [
      {
        "id": 1,
        "email": "invalid@example.com",
        "bounce_type": "hard",
        "bounce_subtype": "NoEmail",
        "source": "ses",
        "campaign_name": "January Newsletter",
        "subscriber_name": "John Doe",
        "created_at": "2026-01-10T12:00:00Z"
      }
    ],
    "total": 50,
    "limit": 20,
    "offset": 0
  }
}
POST /api/v1/bounces

Inasajili bounce kwa mkono.

Request Body

{
  "email": "invalid@example.com",
  "bounce_type": "hard",            // hard, soft, complaint
  "bounce_subtype": "NoEmail",      // optional
  "diagnostic_code": "550 5.1.1..." // optional
}

Response

{
  "success": true,
  "data": {
    "bounce_id": 123
  }
}

Webhooks za watoa huduma wa barua pepe

Unaweza kupokea kiotomatiki arifa za bounce kutoka kwa watoa huduma wa barua pepe kama AWS SES, Mailgun, SendGrid, n.k.

URL za webhook

Provider Webhook URL
AWS SES (SNS) https://dev.mailpass.im/api/v1/webhooks/ses
Mailgun https://dev.mailpass.im/api/v1/webhooks/mailgun
SendGrid https://dev.mailpass.im/api/v1/webhooks/sendgrid

Usanidi wa AWS SES

  1. Unda Topic mpya katika AWS SNS.
  2. Ongeza usajili wa HTTPS kwa Topic:
    https://dev.mailpass.im/api/v1/webhooks/ses
  3. Unda Configuration Set katika AWS SES.
  4. Ongeza Event Destination kwa Configuration Set na uchague SNS Topic.
  5. Chagua matukio ya Bounce na Complaint.

Sera ya usindikaji wa bounce

  • • Hard Bounce inapotokea, msajiliwa anabadilishwa mara moja kuwa hali ya 'bounced'.
  • • Soft Bounce inapotokea mfululizo mara 3, inachukuliwa kama Hard Bounce.
  • • Ripoti ya barua taka inapotolewa, msajiliwa anabadilishwa kuwa hali ya 'unsubscribed'.
  • • Barua pepe hazitatumwa kwa anwani zilizodunda.

Mazoea bora

  • • Dumisha kiwango cha bounce chini ya 5%. Kiwango cha juu cha bounce kinaathiri vibaya sifa ya mtumaji.
  • • Kagua mara kwa mara orodha ya bounces na usafishe barua pepe zisizo halali.
  • • Tumia Double Opt-in kukusanya barua pepe halali pekee.
  • • Fikiria uthibitishaji wa wakati halisi wakati wa kukusanya anwani za barua pepe.

Tunatumia kuki

Tunatumia kuki kuboresha uzoefu wako. Unaweza kuchagua ni kategoria gani za kuki kuruhusu. Pata maelezo zaidi