JSON-Schemas für TORM

Auf dieser Seite werden die JSON-Schemas für die folgenden TORM-Rich-Media-Elemente bereitgestellt:

  • Listenwähler
  • Schnellantworten
  • Zeitauswahl
  • Rich-Links
  • Adaptive Karten

Hierbei handelt es sich um die TORM-Elemente, die in Skripten verwendet werden können. Sie können in einer SNIPPET-Aktion erstellt werden, die an Kontakte gesendet wird. Stellen Sie vor der Verwendung eines Elements sicher, dass der von Ihnen verwendete digitale Kanal das jeweilige Element unterstützt.

Sie können diese Elemente direkt mit der API für Digitales Engagement senden. Die TORM-Beispiele auf dieser Seite zeigen das Schema, das für den messageContent-Parameter der API zu befolgen ist.

Ein Rich-Link ist eine URL mit einer Bildvorschau und einem Titel. Der Benutzer kann darauf klicken, um die URL zu öffnen. Für TORM-Rich-Links gelten einige kanalbasierte Einschränkungen.

{
 "type": "RICH_LINK",
 "fallbackText": "Text sent if rich message is not available on external platform",
 "payload": {
 	"media": {
	  "fileName": "place-kitten.jpg",
	  "url": "https://placekitten.com/200/300",
	  "mimeType": "image/jpeg"
    	},
  "title": {
    "content": "Check our new gadget!"
   },
  "url": "https://www.google.com"
 }
}

Listenauswahl

Eine Auswahlliste ist eine Liste mit Optionen, in der der Kontakt eine Auswahl treffen kann. Die Optionen werden normalerweise in einer Anordnung mit besonderen Formatierungsmöglichkeiten angezeigt, wie Symbole, Titel und Untertitel. Auswahllisten bieten meist mehr Optionen als Schnellantworten. Kontakte können mehr als eine Option auswählen, die während der Konversation beibehalten werden. Für TORM-Steuerelemente für die Listenauswahl gelten einige kanalbasierte Einschränkungen.

{
"type": "LIST_PICKER",
"fallbackText": "Text sent if rich message is not available on external platform",
"payload": {
	"title": {
	 "content": "Choose a color!"	
 	  },
	"text": {
	 "content": "What is your favourite color?"
	  },
	"actions": [
	  {
	   "type": "REPLY_BUTTON",
	   "icon": {
		 "fileName": "place-kitten.jpg",
		 "url": "https://placekitten.com/200/300",
		 "mimeType": "image/jpeg"
		 },
	   "text": "red",
	   "description": "Like a tomato",
	   "postback": "/red"
	   },
      {
      "type": "REPLY_BUTTON",
      "icon": {
      "fileName": "place-kitten.jpg",
      "url": "https://placekitten.com/200/300",
      "mimeType": "image/jpeg"
       },
    "text": "Green",
    "description": "Like an apple",
    "postback": "/green"
     }
   ]
}

Schnellantworten

Eine Schnellantwort ist eine Textnachricht mit Schaltflächen. Der Kontakt kann auf eine der Schaltflächen klicken. Nach dem Klicken wird der Inhalt als ausgehende Nachricht gesendet. Nach dem Senden einer Antwort ist es normalerweise nicht möglich, auf andere Schaltflächen zu klicken. Für TORM-Schnellantworten gelten einige kanalbasierte Einschränkungen.

{
 "type": "QUICK_REPLIES",
 "fallbackText": "Text sent if rich message is not available on external platform",
 "payload": {
    "text": {
	"content": "Hello, we will deliver the package between 12:00 and 16:00. Please specify which day."
  },
 "actions": [
    {
	  "type": "REPLY_BUTTON",
	  "text": "Today",
	  "postback": "{\"id\":\"1\"}"
	},
	{
	  "type": "REPLY_BUTTON",
	  "text": "Tomorrow",
	  "postback": "{\"id\":\"2\"}"
	}
  ]
}
}

Zeitwähler

Zeitwähler bieten Ihnen die Möglichkeit, dem Kontakt eine Auswahl an Zeiten anzubieten, beispielsweise zum Vereinbaren von Terminen. Für TORM-Steuerelemente für die Zeitauswahl gelten einige kanalbasierte Einschränkungen.

{
"type": "TIME_PICKER",
"fallbackText": "Text sent if rich message is not available on external platform",
"payload": {
  "title": {
  "content": "Check our new gadget!"
  },
"timeSlots": [
  {
    "id": "unique-id",
	"duration": 3600,
	"startTime": "2017-05-26T08:27:55+00:00"
  }
],
"location": {
  "title": {
    "content": "Check our new gadget!"
   },
  "latitude": 44.44,
  "longitude": 55.55,
  "radius": 33.3
   }
 }
}

Adaptive Karte

Ermöglicht das Senden einer adaptiven Karte. Adaptive Karten werden nur in digitalenClosed Alle Kanäle, Kontakte, oder Skills, die mit Digital Experience verknüpft sind. Chat-KanälenClosed Eine Möglichkeit für Kontakte, mit Agenten oder Bots zu interagieren. Kanäle sind zum Beispiel Sprache, E-Mail, Chat, Social Media usw. unterstützt.

{
"type": "ADAPTIVE_CARD",
"fallbackText": "Url sent: https://placekitten.com",
"payload": {
  "$schema": "http://adaptivecards.io/schemas/adaptive-card.json",
  "type": "AdaptiveCard",
  "version": "1.5",
  "body": [{
    "type": "Image",
    "url": "https://placekitten.com/200/300",
	"spacing": "none",
	"size": "stretch"
  }],
  "actions": [{
    "type": "Action.OpenUrl",
	"title": "Show me the cats!",
	"url": "https://placekitten.com"
  }]   
 }
}