xdm/docs/reference/adobe/experience/customerJourneyManagement/message-delivery-feedback.schema.json at master · RussStringham/xdm · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
{
    "meta:license": [
        "Copyright 2020 Adobe Systems Incorporated. All rights reserved.",
        "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license",
        "you may not use this file except in compliance with the License. You may obtain a copy",
        "of the License at https://creativecommons.org/licenses/by/4.0/"
    ],
    "$id": "https://ns.adobe.com/experience/customerJourneyManagement/message-delivery-feedback",
    "$schema": "http://json-schema.org/draft-06/schema#",
    "title": "Adobe CJM ExperienceEvent - Message Delivery Feedback Details",
    "description": "Provide details for the delivery feedback for a single message in the Message Execution.",
    "type": "object",
    "meta:extensible": true,
    "meta:abstract": true,
    "meta:intendedToExtend": [
        "https://ns.adobe.com/xdm/context/experienceevent"
    ],
    "definitions": {
        "messageDeliveryfeedback": {
            "properties": {
                "https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryfeedback/feedbackStatus": {
                    "title": "Feedback Status",
                    "type": "string",
                    "description": "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.",
                    "enum": [
                        "error",
                        "exclude",
                        "sent",
                        "bounce",
                        "delay",
                        "duplicate",
                        "denylist",
                        "delivered"
                    ],
                    "meta:enum": {
                        "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"
                    },
                    "meta:titleId": "message-delivery-feedback##https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryfeedback/feedbackStatus##title##21101",
                    "meta:descriptionId": "message-delivery-feedback##https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryfeedback/feedbackStatus##description##54571"
                },
                "https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryfeedback/messageExclusion": {
                    "title": "Message Exclusion",
                    "type": "object",
                    "properties": {
                        "https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryfeedback/code": {
                            "title": "Exclude Code",
                            "type": "string",
                            "description": "Provide top level exclusion reason, like typology rule, mandatory parameter missing.",
                            "meta:titleId": "message-delivery-feedback##https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryfeedback/code##title##57901",
                            "meta:descriptionId": "message-delivery-feedback##https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryfeedback/code##description##92321"
                        },
                        "https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryfeedback/reason": {
                            "title": "Exclude Reason",
                            "type": "string",
                            "description": "Provide exclusion subcode, like exact typology rule-id.",
                            "meta:titleId": "message-delivery-feedback##https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryfeedback/reason##title##95631",
                            "meta:descriptionId": "message-delivery-feedback##https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryfeedback/reason##description##90041"
                        }
                    },
                    "meta:titleId": "message-delivery-feedback##https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryfeedback/messageExclusion##title##32491"
                },
                "https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryfeedback/messageFailure": {
                    "title": "Message Failure",
                    "type": "object",
                    "properties": {
                        "https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryfeedback/reason": {
                            "title": "Failure Reason",
                            "type": "string",
                            "description": "Failure reason for a failed delivery attempt.",
                            "meta:titleId": "message-delivery-feedback##https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryfeedback/reason##title##70551",
                            "meta:descriptionId": "message-delivery-feedback##https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryfeedback/reason##description##51271"
                        },
                        "https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryfeedback/code": {
                            "title": "Failure Code",
                            "type": "string",
                            "description": "Failure code for a failed delivery attempt.",
                            "meta:titleId": "message-delivery-feedback##https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryfeedback/code##title##64991",
                            "meta:descriptionId": "message-delivery-feedback##https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryfeedback/code##description##80161"
                        },
                        "https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryfeedback/type": {
                            "title": "Failure Type",
                            "type": "string",
                            "description": "Classifies whether it is a soft bounce or hard bounce.",
                            "meta:enum": {
                                "soft": "The reason for failed delivery is temporary.",
                                "hard": "The reason for failed delivery is permanent."
                            }
                        },
                        "https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryfeedback/category": {
                            "title": "Failure Category",
                            "type": "string",
                            "description": "Classifies whether it is a sync bounce or async bounce.",
                            "meta:enum": {
                                "sync": "The delivery failed synchronously.",
                                "async": "The delivery failed asynchronously."
                            }
                        }
                    },
                    "meta:titleId": "message-delivery-feedback##https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryfeedback/messageFailure##title##88741"
                },
                "https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryfeedback/retryCount": {
                    "title": "Retry Count",
                    "type": "integer",
                    "description": "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.",
                    "meta:titleId": "message-delivery-feedback##https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryfeedback/retryCount##title##33621",
                    "meta:descriptionId": "message-delivery-feedback##https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryfeedback/retryCount##description##65331"
                },
                "https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryfeedback/offers": {
                    "title": "Offer details",
                    "$ref": "https://ns.adobe.com/experience/customerJourneyManagement/offers",
                    "description": "Describes offer(s) involved in a message feedback."
                }
            }
        }
    },
    "allOf": [
        {
            "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context"
        },
        {
            "$ref": "#/definitions/messageDeliveryfeedback"
        }
    ],
    "meta:status": "stable",
    "meta:titleId": "message-delivery-feedback##title##79791",
    "meta:descriptionId": "message-delivery-feedback##description##18731",
    "examples": [
        {
            "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
            }
        }
    ]
}