TORM JSON-schema's

Deze pagina bevat de JSON-schema's voor de volgende TORM-rijke-media-elementen:

  • Lijstkiezers
  • Snelle antwoorden
  • Tijdkiezers
  • Rijke links
  • Adaptieve kaarten

Dit zijn de TORM-elementen die beschikbaar zijn voor gebruik in scripts. U kunt ze bouwen in een SNIPPET-actie om naar contacten te verzenden . Controleer voordat u een element gebruikt of het digitale kanaal waarmee u werkt, ondersteuning biedt voor dat element.

U kunt deze elementen rechtstreeks verzenden met de Outbound API. De TORM-voorbeelden op deze pagina tonen het schema dat moet worden gevolgd voor de parameter messageContent van de Outbound API.

Een rich link is een URL met een voorbeeld van een afbeelding en een titel. U kunt erop klikken om de URL te openen. TORM-rijke links hebben enkele kanaalgebaseerde beperkingen.

{
 "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"
 }
}

Lijstkiezer

Een lijstkiezer is een lijst met opties waaruit de contactpersoon kan kiezen. De opties worden doorgaans weergegeven in een overlay met rijkere opmaakmogelijkheden, zoals pictogrammen, titels en ondertitels. Lijstkiezers hebben doorgaans meer opties dan snelle antwoorden. Contacten kunnen meer dan een optie selecteren en de opties zijn persistent in de conversatie. TORM-lijstkiezers hebben enkele kanaalgebaseerde beperkingen.

{
"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"
     }
   ]
}

Snelle antwoorden

Een snel antwoord is een tekstbericht met knoppen. Het contact kan op een van de knoppen klikken. Na een klik wordt de inhoud verzonden als outbound. Wanneer een antwoord wordt verzonden, is het doorgaans niet mogelijk om op andere knoppen te klikken. TORM-snelle antwoorden hebben enkele kanaalgebaseerde beperkingen.

{
 "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\"}"
	}
  ]
}
}

Tijdkiezer

Met tijdkiezers kunt u de contactpersoon een keuze bieden uit tijdstippen, bijvoorbeeld voor het plannen van afspraken. TORM-tijdkiezers hebben enkele kanaalgebaseerde beperkingen.

{
"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 Card

Adaptive Cards zijn een platformonafhankelijke methode voor het verzenden van rijke media, ontwikkeld door Microsoft. Adaptive Cards worden alleen ondersteund op digitaleClosed Kanaal, contact of skill verbonden met Digital Experience. chatkanalenClosed Een manier waarop contacten kunnen communiceren met agents of bots, zoals spraak (telefoon), e-mail, chat, social media enzovoort..

{
"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"
  }]   
 }
}