JSON-Schemas für TORM

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

• Text/HTML
• Listenauswahl
• 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.

JSON-Struktur

Das JSON für jedes auf dieser Seite beschriebene TORM-Element muss ordnungsgemäß in der folgenden Nutzlaststruktur verschachtelt sein:

{
 "prompts": [{ 
   "mediaSpecificObject": {  
	"dfoMessage": {  
	  "messageContent": {	
		[rich content JSON]	   
		}	 
	   ]	   
	  } 	  
     }	
    }	
   }  
  } 
 ]
}

Beispiel:

{
 "prompts": [{ 
   "mediaSpecificObject": {  
	"dfoMessage": {  
	  "messageContent": {	
		"type": "PLUGIN",	 
		"payload": {	
			"elements": [{	  
				"id": "bf2521f4-5e85-413f-b6ed-815d1c3905f0",
	   			"type": "FILE",	   
				"filename": "photo.jpg",	  
				"url": "https://www.nice.com/-/media/niceincontact/layout/nice-logo-web-header/nice-web-logo.ashx",	   
				"mimeType": "image/jpeg"	   
				}	 
			   ]	   
			 } 	  
			}	
		  }	
		}  
	 } 
	]
}

Text/HTML

Sie können einfachen Text oder mit HTML-Code markierten Text senden.

{
"type": "TEXT",
"fallbackText": "Text sent as fallback if external platform can't accept rich messages.",
"payload": {
  "text": "<p><b>This</b> is a successfully created outbound message.</p>"
 }
}

Listenauswahl

Ein Listenwähler ist eine Liste mit Optionen, aus denen der Kontakt auswählen 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. TORM-Listenpicker unterliegen einigen kanalbasierten Einschränkungen. Die Auswahl bleibt im Gespräch bestehen.

Kontakte können auf Apple Messages for Business Kanälen mehr als eine Option auswählen.

{
"type": "LIST_PICKER",
"fallbackText": "Text sent as fallback if external platform can't accept rich messages.",
"payload": {
	"title": {
	 "content": "Choose a color!"	
 	  },
	"text": {
	 "content": "What is your favorite color?"
	  },
	"options": {
	  "multiselect": false
	  }
	"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 as fallback if external platform can't accept rich messages.",
 "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\"}"
	}
  ]
}
}

Zeitauswahl

Mithilfe von Zeitauswahlfunktionen können Sie dem Kontakt eine Auswahl an Zeiten anbieten, beispielsweise für die Terminvereinbarung. TORM-Zeitauswahlprogramme unterliegen einigen kanalbasierten Einschränkungen.

{
"type": "TIME_PICKER",
"fallbackText": "Text sent as fallback if external platform can't accept rich messages.",
"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
   }
 }
}

Rich Link

Ein Rich Link ist eine URL mit einer Bildvorschau und einem Titel, auf die geklickt werden kann, um die URL zu öffnen. TORM Rich Links unterliegen einigen kanalbasierten Einschränkungen.

{
 "type": "RICH_LINK",
 "fallbackText": "Text sent as fallback if external platform can't accept rich messages.",
 "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"
 }
}

Adaptive Cards

Adaptive Cards sind eine von Microsoft entwickelte plattformunabhängige Methode zum Senden von Rich Media. Adaptive Cards werden nur auf digitalen Alle Kanäle, Kontakte, oder Skills, die mit Digital Experience verknüpft sind. Chat-Kanälen Verschiedene telefonische und digitale Kommunikationsmedien, die Kundeninteraktionen in einem Contact Center ermöglichen. 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"
  }]   
 }
}