sms.schema.md

SMS Channel Schema

https://ns.adobe.com/xdm/channels/sms

Short message service (SMS) are messages that are delivered to a mobile phone channel.

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	Yes	Experimental	No	Forbidden	Permitted	channels/sms.schema.json

Schema Hierarchy

• SMS Channel https://ns.adobe.com/xdm/channels/sms
  • Extensibility base schema https://ns.adobe.com/xdm/common/extensible
  • Experience Channel https://ns.adobe.com/xdm/channels/channel

SMS Channel Example

{
  "@id": "https://ns.adobe.com/xdm/channels/sms",
  "@type": "https://ns.adobe.com/xdm/channel-types/messaging"
}

SMS Channel Properties

Property	Type	Required	Defined by
@id	const	Required	SMS Channel (this schema)
@type	const	Optional	SMS Channel (this schema)
xdm:contentTypes	const	Optional	SMS Channel (this schema)
xdm:locationTypes	const	Optional	SMS Channel (this schema)
xdm:mediaAction	string	Optional	Experience Channel
xdm:mediaType	string	Optional	Experience Channel
xdm:metricTypes	const	Optional	SMS Channel (this schema)
xdm:mode	const	Optional	SMS Channel (this schema)
xdm:typeAtSource	string	Optional	Experience Channel
*	any	Additional	this schema allows additional properties

@id

The ID uniquely identifies the channel. Each specific experience channel defines a constant @id.

@id

• is required
• type: const
• defined in this schema

The value of this property must be equal to:

"https://ns.adobe.com/xdm/channels/sms"

@type

The @type property is used to provide a rough classification of channels with similar properties.

@type

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

The value of this property must be equal to:

"https://ns.adobe.com/xdm/channel-types/messaging"

@type Known Values

Value	Description
https://ns.adobe.com/xdm/channel-types/web	The world wide web, including mobile web
https://ns.adobe.com/xdm/channel-types/social	Social media platforms
https://ns.adobe.com/xdm/channel-types/mobile	Mobile apps
https://ns.adobe.com/xdm/channel-types/messaging	Instant messaging
https://ns.adobe.com/xdm/channel-types/email	Email
https://ns.adobe.com/xdm/channel-types/offline	Non-digital experience channels

xdm:contentTypes

The content types that this channel can deliver.

xdm:contentTypes

• is optional

• type: const

• defined in this schema

The value of this property must be equal to:

[]

xdm:locationTypes

The types of locations (virtual places) that this channel consists of and can deliver content to.

xdm:locationTypes

• is optional

• type: const

• defined in this schema

The value of this property must be equal to:

[]

xdm:mediaAction

The mediaAction property is used to provide a type of experiance event media action .

xdm:mediaAction

• is optional
• type: string
• defined in Experience Channel

xdm:mediaAction Type

string

xdm:mediaAction Known Values

Value	Description
opens	Opens
sends	Sends
clicks	Clicks
impressions	Impressions
bounces	Bounces
mirrorpages	Mirrorpages
nonDeliverables	NonDeliverables
notSent	NotSent
offerOpens	OfferOpens
unSubscriptions	UnSubscriptions
userComplaints	UserComplaints
subscriptions	Subscriptions

xdm:mediaType

Describes whether the media type is paid,owned or earned.

xdm:mediaType

• is optional
• type: string
• defined in Experience Channel

xdm:mediaType Type

string

xdm:mediaType Known Values

Value	Description
paid	Paid
owned	Owned
earned	Earned

xdm:metricTypes

The metrics that can be collected in this channel.

xdm:metricTypes

• is optional

• type: const

• defined in this schema

The value of this property must be equal to:

[]

xdm:mode

How experiences are delivered in this channel.

xdm:mode

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

The value of this property must be equal to:

"push"

xdm:mode Known Values

Value	Description
push	The publisher of an experience can initiate an experience by sending a message into the channel. Most push channels involve some form of subscription or opt-in.
pull	The consumer can initiate an experience by requesting a location in the channel. Most pull channels give publishers some control how the experience is then delivered.
bidirectional	Both push and pull interaction modes are supported by the channel.

xdm:typeAtSource

Customer defined custom channel name

xdm:typeAtSource

• is optional
• type: string
• defined in Experience Channel

xdm:typeAtSource Type

string