Skip to content

Latest commit

 

History

History
299 lines (163 loc) · 11.5 KB

messageprofile.schema.md

File metadata and controls

299 lines (163 loc) · 11.5 KB
Raw

Adobe CJM ExperienceEvent - Message Profile Details Schema

https://ns.adobe.com/experience/customerJourneyManagement/messageprofile

Message Profile details for the Adobe CJM ExperienceEvent.

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

Schema Hierarchy

  • Adobe CJM ExperienceEvent - Message Profile Details https://ns.adobe.com/experience/customerJourneyManagement/messageprofile

Adobe CJM ExperienceEvent - Message Profile Details Example

{
  "https://ns.adobe.com/experience/customerJourneyManagement/messageProfile/messageProfileID": "4218b775-bef3-46b2-aee2-7caae052cf94",
  "https://ns.adobe.com/experience/customerJourneyManagement/messageProfile/channel": {
    "@id": "https://ns.adobe.com/xdm/channels/email"
  },
  "https://ns.adobe.com/experience/customerJourneyManagement/messageProfile/variant": "A",
  "https://ns.adobe.com/experience/customerJourneyManagement/messageProfile/isSendTimeOptimized": true,
  "https://ns.adobe.com/experience/customerJourneyManagement/messageProfile/isTestExecution": false,
  "https://ns.adobe.com/experience/customerJourneyManagement/emailChannelContext/address": "[email protected]",
  "https://ns.adobe.com/experience/customerJourneyManagement/emailChannelContext/namespace": "Email",
  "https://ns.adobe.com/experience/customerJourneyManagement/emailChannelContext/outboundIP": "52.247.77.92"
}

Adobe CJM ExperienceEvent - Message Profile Details Properties

Property Type Required Defined by
https://ns.adobe.com/experience/customerJourneyManagement/emailChannelContext/address string Optional Adobe CJM ExperienceEvent - Message Profile Details (this schema)
https://ns.adobe.com/experience/customerJourneyManagement/emailChannelContext/namespace string Optional Adobe CJM ExperienceEvent - Message Profile Details (this schema)
https://ns.adobe.com/experience/customerJourneyManagement/emailChannelContext/outboundIP string Optional Adobe CJM ExperienceEvent - Message Profile Details (this schema)
https://ns.adobe.com/experience/customerJourneyManagement/messageProfile/channel Experience Channel Required Adobe CJM ExperienceEvent - Message Profile Details (this schema)
https://ns.adobe.com/experience/customerJourneyManagement/messageProfile/isSendTimeOptimized boolean Optional Adobe CJM ExperienceEvent - Message Profile Details (this schema)
https://ns.adobe.com/experience/customerJourneyManagement/messageProfile/isTestExecution boolean Optional Adobe CJM ExperienceEvent - Message Profile Details (this schema)
https://ns.adobe.com/experience/customerJourneyManagement/messageProfile/messageProfileID string Optional Adobe CJM ExperienceEvent - Message Profile Details (this schema)
https://ns.adobe.com/experience/customerJourneyManagement/messageProfile/variant string Optional Adobe CJM ExperienceEvent - Message Profile Details (this schema)
https://ns.adobe.com/experience/customerJourneyManagement/pushChannelContext/platform string Optional Adobe CJM ExperienceEvent - Message Profile Details (this schema)
https://ns.adobe.com/experience/customerJourneyManagement/smsChannelContext/smsProvider string Optional Adobe CJM ExperienceEvent - Message Profile Details (this schema)
https://ns.adobe.com/experience/customerJourneyManagement/smsChannelContext/messageType string Optional Adobe CJM ExperienceEvent - Message Profile Details (this schema)
* any Additional this schema allows additional properties

https://ns.adobe.com/experience/customerJourneyManagement/emailChannelContext/address

Address

The technical address, for example, '[email protected]' as commonly defined in RFC2822 and subsequent standards.

https://ns.adobe.com/experience/customerJourneyManagement/emailChannelContext/address

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

https://ns.adobe.com/experience/customerJourneyManagement/emailChannelContext/address Type

string

https://ns.adobe.com/experience/customerJourneyManagement/emailChannelContext/namespace

Email Namespace

Email namespace associated with the email address in the consent preferences in the Profile, e.g. email or Email

https://ns.adobe.com/experience/customerJourneyManagement/emailChannelContext/namespace

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

https://ns.adobe.com/experience/customerJourneyManagement/emailChannelContext/namespace Type

string

https://ns.adobe.com/experience/customerJourneyManagement/emailChannelContext/outboundIP

IP Address

Outbound IP address of the customer used to deliver the message.

https://ns.adobe.com/experience/customerJourneyManagement/emailChannelContext/outboundIP

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

https://ns.adobe.com/experience/customerJourneyManagement/emailChannelContext/outboundIP Type

string

https://ns.adobe.com/experience/customerJourneyManagement/messageProfile/channel

Experience channel

Experience channel related to the ExperienceEvent.

https://ns.adobe.com/experience/customerJourneyManagement/messageProfile/channel

  • is required
  • type: Experience Channel
  • defined in this schema

https://ns.adobe.com/experience/customerJourneyManagement/messageProfile/channel Type

https://ns.adobe.com/experience/customerJourneyManagement/messageProfile/isSendTimeOptimized

isSendTimeOptimized

True if the message execution is send time optimized.

https://ns.adobe.com/experience/customerJourneyManagement/messageProfile/isSendTimeOptimized

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

https://ns.adobe.com/experience/customerJourneyManagement/messageProfile/isSendTimeOptimized Type

boolean

https://ns.adobe.com/experience/customerJourneyManagement/messageProfile/isTestExecution

isTestExecution

True if the message is sent as Test Execution.

https://ns.adobe.com/experience/customerJourneyManagement/messageProfile/isTestExecution

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

https://ns.adobe.com/experience/customerJourneyManagement/messageProfile/isTestExecution Type

boolean

https://ns.adobe.com/experience/customerJourneyManagement/messageProfile/messageProfileID

MessageProfile ID

A unique id refers to every single message sent as part of a MessageExecution activity.

https://ns.adobe.com/experience/customerJourneyManagement/messageProfile/messageProfileID

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

https://ns.adobe.com/experience/customerJourneyManagement/messageProfile/messageProfileID Type

string

https://ns.adobe.com/experience/customerJourneyManagement/messageProfile/variant

Content Variant

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.

https://ns.adobe.com/experience/customerJourneyManagement/messageProfile/variant

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

https://ns.adobe.com/experience/customerJourneyManagement/messageProfile/variant Type

string

https://ns.adobe.com/experience/customerJourneyManagement/pushChannelContext/platform

Push Platform

Push provider service, e.g. apns or fcm

https://ns.adobe.com/experience/customerJourneyManagement/pushChannelContext/platform

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

https://ns.adobe.com/experience/customerJourneyManagement/pushChannelContext/platform Type

string

https://ns.adobe.com/experience/customerJourneyManagement/pushChannelContext/platform Known Values

Value Description
apns Apple Push Notification service
fcm Firebase cloud messaging service

https://ns.adobe.com/experience/customerJourneyManagement/smsChannelContext/smsProvider

SMS Provider

SMS provider , e.g. sinch, infobip or twilio

https://ns.adobe.com/experience/customerJourneyManagement/smsChannelContext/smsProvider

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

https://ns.adobe.com/experience/customerJourneyManagement/smsChannelContext/smsProvider Type

string

https://ns.adobe.com/experience/customerJourneyManagement/smsChannelContext/messageType Known Values

Value Description
inbound Inbound received for the profile
inboundReply Replied with custom message for inbound
send sms send

https://ns.adobe.com/experience/customerJourneyManagement/smsChannelContext/messageType

SMS messageType

SMS provider, e.g. inbound, inboundReply or send

https://ns.adobe.com/experience/customerJourneyManagement/smsChannelContext/messageType

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

https://ns.adobe.com/experience/customerJourneyManagement/smsChannelContext/messageType Type

string

https://ns.adobe.com/experience/customerJourneyManagement/smsChannelContext/inboundMessage Known Values

https://ns.adobe.com/experience/customerJourneyManagement/smsChannelContext/inboundMessage

SMS inbound Message

SMS inbound reply, e.g. stop, start, subscribe, etc.

https://ns.adobe.com/experience/customerJourneyManagement/smsChannelContext/inboundMessage

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

https://ns.adobe.com/experience/customerJourneyManagement/smsChannelContext/inboundMessage Type

string