Carrier delivery receipt
Ingests a carrier's delivery receipt. Not for customer use: the URL is configured with each carrier out of band, and is authenticated by a per-carrier shared secret in the path, because a carrier cannot present a bearer token.
Receipts are retried by carriers and can arrive out of order, so a receipt for a message that already reached a terminal state is accepted and ignored rather than allowed to overwrite it.
For email, Woyra's sending network posts its delivery, bounce and complaint events here. Each one is signed, and its signature is checked before anything is recorded; a hard bounce or a complaint suppresses the recipient for that account. Every receipt also reaches the customer as an email.delivered, email.undelivered or email.complained webhook (message. for SMS).
Received mail arrives the same way. Woyra stores it for every account that verified the recipient's domain, links it to the email it replies to, and queues email.received. The response then says received, duplicate (the network retried), ignored (no verified domain receives that address), rejected (the virus scan failed it) or unsupported (the message could not be read).
Parameters
| Name | In | Description |
|---|---|---|
| carrierrequired | path | |
| secretrequired | path |
Example
curl -X POST https://api.woyra.io/v1/dlr/<carrier>/<secret>Response
202 Accepted. status reports what was done: applied, already_final
| Field | Type | Description |
|---|---|---|
| status | string | One of applied, already_final, ignored, received, duplicate, rejected, unsupported. |
| message_id | string | |
| email_ids | array of string | The received emails stored |
Errors
| Status | Codes |
|---|---|
| 400 | invalid_request, unsupported_version |
| 401 | authentication_required, invalid_api_key |
| 404 | not_found, product_not_offered |