Message status

In this section, you can find more details about the message statuses that apply to the the email channel in the Channels API

Przykład kodu

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "channelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "sender": {
    "connector": {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "identifierValue": "string",
      "annotations": {
        "name": "string"
      }
    }
  },
  "body": {
    "type": "text"
  },
  "reference": "string",
  "parts": [
    {
      "platformReference": "string"
    }
  ],
  "status": "accepted",
  "reason": "string",
  "direction": "incoming",
  "template": {
    "projectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "version": "string",
    "locale": "string",
    "variables": {
      "default": "string",
      "additionalProp1": "string",
      "additionalProp2": "string",
      "additionalProp3": "string"
    }
  },
  "lastStatusAt": "2023-06-23T15:51:19.660Z",
  "createdAt": "2023-06-23T15:51:19.660Z",
  "updatedAt": "2023-06-23T15:51:19.660Z",
  "details": "string"
}

Email supports the following message statuses

Status	Description
accepted	An outgoing message has been accepted by the Channels API
sent	Channels API has attempted to send an outgoing message to a platform e.g Email
sending_failed	An outgoing message has failed to be sent to a platform
delivery_failed	An outgoing message has been sent successfully to a platform but the message has failed to be delivered to a recipient
delivered	An outgoing message has been successfully delivered to a recipient or an incoming message has been delivered to the channels API. Use the direction field to determine if a message is outgoing or incoming

Additional information for sending or delivery failure can be found in the details and where applicable a reason will be set to provide more troubleshooting information:

Status	details	Description
sending_failed	generationRejection	Message generation failed due to policy
sending_failed	generationFailure	Message generation failed for an intended recipient
sending_failed	policyRejection	Message rejected due to policy
delivery_failed	bounceHard	The recipient is invalid or could not be determined
delivery_failed	bounceSoft	The message has been temporarily delayed or failed for unspecified reasons
delivery_failed	bounceBlock	The message has been blocked by the receiver
delivery_failed	bounceAdmin	The message was failed by an configured policy
delivery_failed	bounceUndetermined	The response text could not be determined
delivery_failed	delay	Remote MTA has temporarily rejected the message
delivery_failed	out_of_band	Remote MTA initially reported acceptance of the message, but it has since reported that the message was not delivered