Skip to content

Latest commit

 

History

History
303 lines (161 loc) · 10.8 KB

message-delivery-feedback.schema.md

File metadata and controls

303 lines (161 loc) · 10.8 KB

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/category": "sync"
  },
  "https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryfeedback/retryCount": 1,
  "https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryfeedback/offers": {
    "xdm:offerID": "1234",
    "xdm:placementID": "12345",
    "xdm:propositionID": "9898",
    "xdm:offerCount": 5
  }
}

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/offers Adobe ExperienceEvent - Offer details 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

Feedback Status

Provide status of a delivery attempt across different channels(Email,Push,SMS etc.), Not all enums are used for all the channels, so follow the detailed documentation.

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.

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
delivered Message Delivered

Message Exclusion

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

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

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
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

string

Exclude Reason

Provide exclusion subcode, like exact typology rule-id.

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

  • is optional
  • type: string

string

Message Failure

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

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

object with following properties:

Property Type Required
https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryfeedback/category string Optional
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
Failure Category

Classifies whether it is a sync bounce or async bounce.

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

  • is optional
  • type: string

string

Value Description
sync The delivery failed synchronously.
async The delivery failed asynchronously.
Failure Code

Failure code for a failed delivery attempt.

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

  • is optional
  • type: string

string

Failure Reason

Failure reason for a failed delivery attempt.

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

  • is optional
  • type: string

string

Failure Type

Classifies whether it is a soft bounce or hard bounce.

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

  • is optional
  • type: string

string

Value Description
soft The reason for failed delivery is temporary.
hard The reason for failed delivery is permanent.

Offer details

Describes offer(s) involved in a message feedback.

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

  • is optional
  • type: Adobe ExperienceEvent - Offer details
  • defined in this schema

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

integer