-
Notifications
You must be signed in to change notification settings - Fork 320
/
messageprofile.schema.json
154 lines (154 loc) · 8.95 KB
/
messageprofile.schema.json
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
153
154
{
"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/messageprofile",
"$schema": "http://json-schema.org/draft-06/schema#",
"title": "Adobe CJM ExperienceEvent - Message Profile Details",
"description": "Message Profile details for the Adobe CJM ExperienceEvent.",
"type": "object",
"meta:extensible": true,
"meta:abstract": true,
"meta:intendedToExtend": ["https://ns.adobe.com/xdm/context/experienceevent"],
"definitions": {
"messageProfile": {
"properties": {
"https://ns.adobe.com/experience/customerJourneyManagement/messageProfile/messageProfileTrackingID": {
"title": "Message Profile Tracking ID",
"type": "string",
"description": "A unique tracking id refers to every single message sent as part of a MessageExecution activity.",
"meta:titleId": "messageprofile##https://ns.adobe.com/experience/customerJourneyManagement/messageProfile/messageProfileTrackingID##title",
"meta:descriptionId": "messageprofile##https://ns.adobe.com/experience/customerJourneyManagement/messageProfile/messageProfileTrackingID##description"
},
"https://ns.adobe.com/experience/customerJourneyManagement/messageProfile/messageProfileID": {
"title": "MessageProfile ID",
"type": "string",
"description": "A unique id refers to every single message sent as part of a MessageExecution activity.",
"meta:titleId": "messageprofile##https://ns.adobe.com/experience/customerJourneyManagement/messageProfile/messageProfileID##title##31921",
"meta:descriptionId": "messageprofile##https://ns.adobe.com/experience/customerJourneyManagement/messageProfile/messageProfileID##description##94561"
},
"https://ns.adobe.com/experience/customerJourneyManagement/messageProfile/channel": {
"title": "Experience channel",
"description": "Experience channel related to the ExperienceEvent.",
"$ref": "https://ns.adobe.com/xdm/channels/channel",
"meta:titleId": "messageprofile##https://ns.adobe.com/experience/customerJourneyManagement/messageProfile/channel##title##5131",
"meta:descriptionId": "messageprofile##https://ns.adobe.com/experience/customerJourneyManagement/messageProfile/channel##description##30511"
},
"https://ns.adobe.com/experience/customerJourneyManagement/messageProfile/variant": {
"title": "Content Variant",
"type": "string",
"description": "A message execution can have multiple variants e.g. Multilingual (translated variants for the same content) or A/B testing (different content to test what works better) but a message delivered to a recipient always contains one of them.",
"meta:titleId": "messageprofile##https://ns.adobe.com/experience/customerJourneyManagement/messageProfile/variant##title##71711",
"meta:descriptionId": "messageprofile##https://ns.adobe.com/experience/customerJourneyManagement/messageProfile/variant##description##28141"
},
"https://ns.adobe.com/experience/customerJourneyManagement/messageProfile/isSendTimeOptimized": {
"title": "isSendTimeOptimized",
"type": "boolean",
"description": "True if the message execution is send time optimized."
},
"https://ns.adobe.com/experience/customerJourneyManagement/messageProfile/isTestExecution": {
"title": "isTestExecution",
"type": "boolean",
"description": "True if the message is sent as Test Execution."
},
"https://ns.adobe.com/experience/customerJourneyManagement/emailChannelContext/address": {
"title": "Address",
"type": "string",
"format": "email",
"description": "The technical address, for example, '[email protected]' as commonly defined in RFC2822 and subsequent standards.",
"meta:titleId": "messageprofile##https://ns.adobe.com/experience/customerJourneyManagement/emailChannelContext/address##title##801",
"meta:descriptionId": "messageprofile##https://ns.adobe.com/experience/customerJourneyManagement/emailChannelContext/address##description##17861"
},
"https://ns.adobe.com/experience/customerJourneyManagement/emailChannelContext/namespace": {
"title": "Email Namespace",
"type": "string",
"description": "Email namespace associated with the email address in the consent preferences in the Profile, e.g. email or Email",
"meta:titleId": "messageprofile##https://ns.adobe.com/experience/customerJourneyManagement/emailChannelContext/namespace##title##63731",
"meta:descriptionId": "messageprofile##https://ns.adobe.com/experience/customerJourneyManagement/emailChannelContext/namespace##description##34571"
},
"https://ns.adobe.com/experience/customerJourneyManagement/emailChannelContext/outboundIP": {
"title": "IP Address",
"type": "string",
"description": "Outbound IP address of the customer used to deliver the message.",
"meta:titleId": "messageprofile##https://ns.adobe.com/experience/customerJourneyManagement/emailChannelContext/outboundIP##title##99731",
"meta:descriptionId": "messageprofile##https://ns.adobe.com/experience/customerJourneyManagement/emailChannelContext/outboundIP##description##75691"
},
"https://ns.adobe.com/experience/customerJourneyManagement/emailChannelContext/domain": {
"title": "Domain",
"type": "string",
"description": "Domain of the recipient's email address."
},
"https://ns.adobe.com/experience/customerJourneyManagement/pushChannelContext/platform": {
"title": "Push Platform",
"type": "string",
"description": "Push provider service, e.g. apns or fcm",
"meta:enum": {
"apns": "Apple Push Notification service",
"fcm": "Firebase cloud messaging service"
},
"meta:titleId": "messageprofile##https://ns.adobe.com/experience/customerJourneyManagement/pushChannelContext/platform##title##73351",
"meta:descriptionId": "messageprofile##https://ns.adobe.com/experience/customerJourneyManagement/pushChannelContext/platform##description##33451"
},
"https://ns.adobe.com/experience/customerJourneyManagement/smsChannelContext/smsProvider": {
"title": "SMS Provider",
"type": "string",
"description": "SMS provider , e.g. sinch or twilio",
"meta:enum": {
"sinch": "Sinch sms provider",
"infobip": "Twilio sms provider",
"twilio": "Twilio sms provider",
"vibes": "Vibes sms Provider "
}
},
"https://ns.adobe.com/experience/customerJourneyManagement/smsChannelContext/messageType": {
"title": "SMS messageType",
"type": "string",
"description": "SMS provider, e.g. inbound, inboundReply or send"
},
"https://ns.adobe.com/experience/customerJourneyManagement/smsChannelContext/inboundMessage": {
"title": "SMS inbound Message",
"type": "string",
"description": "SMS inbound reply, e.g. stop, start, subscribe, etc."
},
"https://ns.adobe.com/experience/customerJourneyManagement/smsChannelContext/inboundNumber": {
"title": "SMS inbound Number",
"type": "string",
"description": "SMS inbound Number : Sender Id where the MO being received"
},
"https://ns.adobe.com/experience/customerJourneyManagement/smsChannelContext/channelType": {
"title": "Channel Type",
"type": "string",
"description": "ChannelType will contain like : SMS, MMS , RCS etc."
},
"https://ns.adobe.com/experience/customerJourneyManagement/smsChannelContext/profileNumber": {
"title": "Profile Phone Number",
"type": "string",
"description": "Phone Number from whihc we recevied the Inbound message"
},
"https://ns.adobe.com/experience/customerJourneyManagement/smsChannelContext/origTimestamp": {
"title": "Original Timestamp ",
"type": "string",
"format": "date-time",
"description": "Timestamp from Provider"
}
}
}
},
"required": [
"https://ns.adobe.com/experience/customerJourneyManagement/messageProfile/channel"
],
"allOf": [
{
"$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context"
},
{
"$ref": "#/definitions/messageProfile"
}
],
"meta:status": "stable",
"meta:titleId": "messageprofile##title##66431",
"meta:descriptionId": "messageprofile##description##41271"
}