Skip to content

Latest commit

 

History

History
246 lines (128 loc) · 8.6 KB

message-delivery-feedback.schema.md

File metadata and controls

246 lines (128 loc) · 8.6 KB
Raw

Adobe CJM ExperienceEvent - Message Delivery Feedback Details Schema

https://ns.adobe.com/experience/customerJourneyManagement/message-delivery-feedback

Provide details for the delivery feedback for a single message in the Message Execution.

Abstract Extensible Status Identifiable Custom Properties Additional Properties Defined In
Can be instantiated Yes Stable No Forbidden Permitted adobe/experience/customerJourneyManagement/message-delivery-feedback.schema.json

Schema Hierarchy

  • Adobe CJM ExperienceEvent - Message Delivery Feedback Details https://ns.adobe.com/experience/customerJourneyManagement/message-delivery-feedback

Adobe CJM ExperienceEvent - Message Delivery Feedback Details Example

{
  "https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryfeedback/feedbackStatus": "bounce",
  "https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryfeedback/messageFailure": {
    "https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryfeedback/reason": "Messagebox is Full",
    "https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryfeedback/code": "FR-123",
    "https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryfeedback/type": "Soft"
  },
  "https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryfeedback/retryCount": 1
}

Adobe CJM ExperienceEvent - Message Delivery Feedback Details Properties

Property Type Required Defined by
https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryfeedback/feedbackStatus enum Optional Adobe CJM ExperienceEvent - Message Delivery Feedback Details (this schema)
https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryfeedback/messageExclusion object Optional Adobe CJM ExperienceEvent - Message Delivery Feedback Details (this schema)
https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryfeedback/messageFailure object Optional Adobe CJM ExperienceEvent - Message Delivery Feedback Details (this schema)
https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryfeedback/retryCount integer Optional Adobe CJM ExperienceEvent - Message Delivery Feedback Details (this schema)
* any Additional this schema allows additional properties

https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryfeedback/feedbackStatus

Feedback Status

Provide status of a delivery attempt.

https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryfeedback/feedbackStatus

  • is optional
  • type: enum
  • defined in this schema

The value of this property must be equal to one of the known values below.

https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryfeedback/feedbackStatus Known Values

Value Description
error Message processing failed
exclude Message profile filtered out
sent Message sent
bounce Message bounced
delay Message delayed
duplicate Duplicate message skipped
denylist Invalid destination skipped

https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryfeedback/messageExclusion

Message Exclusion

https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryfeedback/messageExclusion

  • is optional
  • type: object
  • defined in this schema

https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryfeedback/messageExclusion Type

object with following properties:

Property Type Required
https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryfeedback/code string Optional
https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryfeedback/reason string Optional

https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryfeedback/code

Exclude Code

Provide top level exclusion reason, like typology rule, mandatory parameter missing.

https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryfeedback/code

  • is optional
  • type: string
https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryfeedback/code Type

string

https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryfeedback/reason

Exclude Reason

Provide exclusion subcode, like exact typology rule-id.

https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryfeedback/reason

  • is optional
  • type: string
https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryfeedback/reason Type

string

https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryfeedback/messageFailure

Message Failure

https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryfeedback/messageFailure

  • is optional
  • type: object
  • defined in this schema

https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryfeedback/messageFailure Type

object with following properties:

Property Type Required
https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryfeedback/code string Optional
https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryfeedback/reason string Optional
https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryfeedback/type string Optional

https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryfeedback/code

Failure Code

Failure code for a failed delivery attempt.

https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryfeedback/code

  • is optional
  • type: string
https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryfeedback/code Type

string

https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryfeedback/reason

Failure Reason

Failure reason for a failed delivery attempt.

https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryfeedback/reason

  • is optional
  • type: string
https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryfeedback/reason Type

string

https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryfeedback/type

Failure Type

Classifies whether it is a soft bounce or hard bounce.

https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryfeedback/type

  • is optional
  • type: string
https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryfeedback/type Type

string

https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryfeedback/type Known Values
Value Description
soft The reason for failed delivery is temporary.
hard The reason for failed delivery is permanent.

https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryfeedback/retryCount

Retry Count

Number of failed attempts before the current event. The retryCount starts with '0', for message which is sent in first attempt will have 'retryCount' as 0.

https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryfeedback/retryCount

  • is optional
  • type: integer
  • defined in this schema

https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryfeedback/retryCount Type

integer