Send Message v2

{
	"appid":"<channel asset specific App ID available in Assets page>", //This is required only for Push, In-App, Messenger, WhatsApp, Twitter DMs, WeChat, and Apple Messages for Business
  "channel":"<channel name - v2 API currently supports sms, email and rcs",
	"from":"<from address for the message, for SMS this will be a senderID, for email the sender address and for all OTT channels it will be appId available on the UI>",
	"to":[
		{
			"msisdn/email":[
				"single/multiple destination objects of the same type"
			],
      	],
		   "gtrId":["rcsgtrid"]
      //"gtrids must match the number of destination objects "
			"correlationId":"<correlationId for this array of destination objects>",
			"substitutions":{
				"parameter1":"<substitutions for this array of destination objects> ",
				"parametern":"<substitutions for this array of destination objects> "
			}
		},
		// Pass multiple objects in a single destination array for bulk messaging
 
                // Pass one object in each destination array for personalized messaging		
                 {
			"msisdn/email":[
				"single/multiple destination objects of the same type"
			],
			"correlationId":"<correlationId for this array of destination objects>",
			"substitutions":{
				"parameter1":"<substitutions for this array of destination objects> ",
				"parametern":"<substitutions for this array of destination objects> "
			}
		}
	],
	// Global substitutions
   "substitutions":{
		"parameterx":"<global replaceable parameters, destination level parameters take precendence",

	},
	// Message scheduling
   "sendAt":"<ISO8601 date/time>",
//max 7 days from current time
   // Only 1 of these 2 can be used. If both come then it's a 400 Bad request
 "expireAt":"<ISO8601 date/time>",
 "validity":"time period in seconds",
// Channel specific message options
    "options":{
		object(smsOptions)||object(emailOptions)||Object(rcsOptions)
	},
	// Call-backs
 "callbackData":"<notify data>",
"notifyUrl":"https://notify.example.com",
"requestedReceipts":[
		"DELIVERED",
		"READ"
	],
 // Union field message can be only one of content or template
   "content":{
    object(smsMessage)||object(emailMessage)||object(rcsMessage)
   },
	"template":{
		"id":"<unique template ID fom the UI"
	}
   //Optional array if you want to use Contact Policy 
  "contact policy": [
        {
             “contactPolicyGroup” : GroupID, //the GroupID to be applied. Required if any of the following options are included and set to true

             “channelCheckConsent” : true, //optional, assumed false, set to true to require opt-in before sending the message

             “channelRequirePreference” : true, //optional, assumed false, set to true to require channel preference before sending the message

            “channelApplyFrequencyCap” : true //optional, assumed false, set to true to enforce group frequency cap for that channel
        }
      ],     
}

{
   "channel":"sms",
   "from":"CNNECT",
 
   
   "to":[
      {
         "msisdn":[
          
            +1647XXXXXXX",  //E.164 format required/recommended. Older tenants might still accept other formats.
         ]
    
       
      }
     
   ],

    "smartlinks":[
   {
     "smartlinkId": 5,
     "validity": 30
   }
   ],

   "substitutions":{
      "name":"abc",
      "value":"123"
   },
 
   "options":{
      "trackClicks":"true",
      "shortenLinks":"true",
      "domain":"https://domainname",
      "extras":{
          "dlt_templateid":"123456789"
          
          
          
      }
      
      
   },
   
 
   "callbackData":"CallBackdata",
   "notifyUrl":"https://requestinspector.com/inspect/01evrfdrr7jc662279wjskfbk6",
   
   
   "requestedReceipts": [
       "SENT",
        "DELIVERED","Clicked"
        
    ],
   "content":{
      "type":"text",
      "text":"Hi user, there is an outage in your area $(area) for the next $(value)"
}

{
	"channel":"email",
	"from":"[email protected]",
	"to":[
		{
			"email":[
				"[email protected]",
				"[email protected]"
			],
			"correlationId":"na1b2b1i1",
			"substitutions":{
				"area":"EC1M 4BH",
				"accountNumber":"38S189"
			}
		},
		{
			"email":[
				"[email protected]"
			],
			"correlationId":"na1b2b1i1",
			"substitutions":{
				"area":"NW10 2QD",
				"accountNumber":"SA129"
			}
		}
	],
	"substitutions":{
		"offerName":"Big OFFER",
		"value":"123"
	},
	"cc":[
		"[email protected]"
	],
	"bcc":[

	],
	"callbackData":"<notify data>",
	"notifyUrl":"https://webhook.site/d50dd211-8c06-440f-ba49-36f88e5eb6e4",
	"options":{
		"trackClicks":true,
		"trackOpens":true,
		"fromName":"Brand Name"
	},
	"content":{
		"type":"html",
		"subject":"Food",
		"replyTo":"[email protected]",
		"attachments":[
			{
				"mimeType":"image/png",
				"name":"wings",
				"mediaUrl":"https://i.imgur.com/y5GjuE8.jpg"
			}
		],
		"text":"This is a new email",
		"html":"<a no-track-connect href=\"http://example.com\">link text</a><footer><a data-mce-href='$(unsubscribe)' href='$(unsubscribe)' target='_blank' rel='noopener'><span st-unsubscribe='' style='text-decoration: none; color: #0088cc;' data-mce-style='text-decoration: none; color: #0088cc;'>unsubscribe</span></a></footer>"
	}
}

{ 
	"channel":"rcs",
	"from":"a_156887855308557980",
	"to":[
		{
			"msisdn":[
				"+916304451252"
			],
			"correlationId":"na1b2b1i1",
			"substitutions":{
				"name":"John",
				"company":"IMI"
			}
		}
	],
	"substitutions":{				//Please note that substitutions apply only to text field.
		"company":"Mobile"
	},
	"callbackData":"abc",
	},
	"notifyUrl":"https://requestinspector.com/inspect/01dp3d028s11zeetkqbvp562st",
	"requestedReceipts":[
		"DELIVERED"
	],
	"content":{
		"type":"standalone",
		"richCard":{
			"title":"The Card Title",
			"description":"The description",
			"orientation":"VERTICAL/HORIZONTAL",
			"thumbnailAlignment":"LEFT",
			"media":{
				"height":"SHORT/MEDIUM/TALL",
				"url":"https://bit.ly/2J5i2x0",
        "fileSize":1212 //in Bytes
			},
			"suggestions":[
				{
					"type":"reply",
					"displayText":"Yes",
					"postbackData":"usr_msg_yes"
				},
				{
					"type":"viewLocation",
					"address":"+14165551234",
					"displayText":"Mobile Office",
					"latitude":43.649269,
					"longitude":-79.378423,
					"postbackData":"e460dd65-e69b-4f86-a5af-458683248f2d_url_google"
				}
			]
		},
		"suggestions":[
			{
				"type":"reply",
				"displayText":"Yes",
				"postbackData":"usr_msg_yes"
			},
			{
				"type":"viewLocation",
				"address":"+14165551234",
				"displayText":"Mobile Office",
				"latitude":43.649269,
				"longitude":-79.378423,
				"postbackData":"e460dd65-e69b-4f86-a5af-458683248f2d_url_google"
			}
		]
	}
}

header
{
  "alg": HS256,
}
claims
{
  "iss": <Service ID>,
  "iat": <issued at unix-timestamp (in seconds)>
}

{
	"shortenLinks":true, //shortens any https links found in the body of the request
	"domain":"https://me.co.uk", //domain for the shorternedLink  must be preconfigured.Please reach out to the support team.
        "trackClicks":true //when shorten links is true, clicks can be tracked

}

{
	"type":"text or unicode",
	"text":"Hi $(name), this is a text message ${field2}" //body of the message with variables represented as $(variable)
}

{
    "channel": "email",
    "from": "{{fromEmailAddress}}",

    "to": [
        {
            "email": [
                "{{toEmailAddress}}"
            ],
            "correlationId": "{{correlationId}}",
            "substitutions": {
                "{{param1}}": "{{param1Value}}",
                "{{param2}}": "{{param2Value}}"
            }
        }
    ],
    "substitutions": {
        "{{param3}}": "{{param3Value}}",
        "{{param4}}": "{{param4Value}}"
    },
    "cc": [],
    "bcc": [],
    "options": {
        "fromName": "{{emailSendername}}",
        "trackClicks": true,
        "trackOpens": true
    },
    "content": {
        "type": "text",
        "encoding": "utf-8",
        "subject": "{{subject}}",
        "replyTo": "{{replyToEmailAddress}}",
        "text": "Simple text content"
    },
      "requestedReceipts": ["submitted", "delivered", "not verified", "invalid", "bounce", "complaint", "read", "failed"],
        
      "correlationid": "",
    "callbackData": "",
    "notifyurl": ""
}

{
    "channel": "email",
    "from": "{{fromEmailAddress}}",
    "to": [
        {
            "email": [
                "{{toEmailAddress}}"
            ],
            "correlationId": "{{correlationId}}",
            "substitutions": {
                "{{param1}}": "{{param1Value}}",
                "{{param2}}": "{{param2Value}}"
            }
        }
    ],
    "substitutions": {
        "{{param3}}": "{{param3Value}}",
        "{{param4}}": "{{param4Value}}"
    },
    "cc": [],
    "bcc": [],
    "options": {
        "fromName": "{{emailSendername}}",
        "trackClicks": true,
        "trackOpens": true
    },
    "content": {
        "type": "html",
        "encoding": "utf-8",
        "subject": "{{subject}}",
        "replyTo": "{{replyToEmailAddress}}",
        "text": "Fallback text in the event the email client does not support HTML emails",
        "html": "<a track_enable href=\"http://example.com\">link text</a><footer><a data-mce-href='$(unsubscribe)' href='$(unsubscribe)' target='_blank' rel='noopener'><span st-unsubscribe='' style='text-decoration: none; color: #0088cc;' data-mce-style='text-decoration: none; color: #0088cc;'>unsubscribe</span></a></footer>"
    },
        "requestedReceipts": ["submitted", "delivered", "not verified", "invalid", "bounce", "complaint", "read", "failed"],
        
      "correlationid": "",
    "callbackData": "",
    "notifyurl": ""
}

{
    "channel": "email",
    "from": "[email protected]",
    "notifyUrl": "https://webhook.site/f023c932-6d17-4a45-9a43-822e8c6e6f97",
    "multipleToRecipients": true,
    "requestedReceipts": [],
    "to": [
        {
            "email": [
                "[email protected]",
                "[email protected]"
            ],
            "correlationId": "",
            "substitutions": {
                "area": "",
                "accountNumber": ""
            }
        }
    ],
    "substitutions": {
        "offerName": "",
        "value": ""
    },
    "cc": [
        ""
    ],
    "bcc": [
        ""
    ],
    "options": {
        "fromName": "apiv2",
        "trackClicks": true,
        "trackOpens": true,
        "bypassSuppression": false
    },
    "content": {
        "type": "html",
        "encoding": "utf-8",
        "subject": "We are reaching you through web 465 because",
        "replyTo": "",
        "text": "We are reaching you for next SSL genre if",
        "html": ""
    }
}

{
	"trackClicks":true, //to track clicks in the email
	"trackOpens":true, //to track email opens
	"fromName":"IMI UK", //from name that appears in the email inbox
}

{
	 "carrierId":"12"
}

{
    "type": "text",
    "text": "This is the message.  Reply Yes or No.",
    "suggestions": [
        {
            "type": "reply",
            "displayText": "Yes",
            "postbackData": "usr_msg_yes"
        },
        {
            "type": "viewLocation",
            "address": "+14165551234",
            "displayText": "Mobile Office",
            "latitude": 43.649269,
            "longitude": -79.378423,
            "postbackData":"e460dd65-e69b-4f86-a5af-458683248f2d_url_google"
        },
        {
            "type": "shareLocation",
            "displayText": "Office",
            "postbackData":"e460dd65-e69b-4f86-a5af-458683248f2d_url_google"
        },
        {
            "type": "openUrl",
            "displayText": "Mobile",
            "url": "http://www.imimobile.com",
            "postbackData":"e460dd65-e69b-4f86-a5af-458683248f2d_url_google"
        },
        {
            "type": "calendarEvent",
            "displayText": "Mobile",
            "startTime": "2017-03-14T00:00:00Z",
            "endTime": "2017-03-14T00:00:00Z",
            "meetingTitle": "http://www.imimobile.com",
            "meetingDescription": "http://www.imimobile.com",
            "postbackData":"e460dd65-e69b-4f86-a5af-458683248f2d_url_google"
        },
        {
            "type": "dialPhone",
            "displayText": "Call Us!",
            "phone": "+14163688400",
            "postbackData":"e460dd65-e69b-4f86-a5af-458683248f2d_url_google"
        }
    ]
}

{
    "type": "media",
    "mediaContentUrl":"https://asset.com/asset.jpg",
    "fileSize":1148279
    "suggestions": [
        {
            "type": "reply",
            "displayText": "Yes",
            "postbackData": "usr_msg_yes"
        },
        {
            "type": "viewLocation",
            "address": "+14165551234",
            "displayText": "Mobile Office",
            "latitude": 43.649269,
            "longitude": -79.378423,
            "postbackData":"e460dd65-e69b-4f86-a5af-458683248f2d_url_google"
        },
        {
            "type": "shareLocation",
            "displayText": "Office",
            "postbackData":"e460dd65-e69b-4f86-a5af-458683248f2d_url_google"
        },
        {
            "type": "openUrl",
            "displayText": "Mobile",
            "url": "http://www.imimobile.com",
            "postbackData":"e460dd65-e69b-4f86-a5af-458683248f2d_url_google"
        },
        {
            "type": "calendarEvent",
            "displayText": "Mobile",
            "startTime": "2017-03-14T00:00:00Z",
            "endTime": "2017-03-14T00:00:00Z",
            "meetingTitle": "http://www.imimobile.com",
            "meetingDescription": "http://www.imimobile.com",
            "postbackData":"e460dd65-e69b-4f86-a5af-458683248f2d_url_google"
        },
        {
            "type": "dialPhone",
            "displayText": "Call Us!",
            "phone": "+14163688400",
            "postbackData":"e460dd65-e69b-4f86-a5af-458683248f2d_url_google"
        }
    ]
}

{
	"type":"standalone",
	"richCard":{
		"title":"The Card Title",
		"description":"The description",
		"orientation":"VERTICAL/HORIZONTAL",
		"thumbnailAlignment":"LEFT",
		"media":{
			"height":"SHORT/MEDIUM/TALL",
			"url":"https://bit.ly/2J5i2x0",
      "fileSize":1148279 //in Bytes
		},
		"suggestions":[
			{
				"type":"reply",
				"displayText":"Yes",
				"postbackData":"usr_msg_yes"
			},
			{
				"type":"viewLocation",
				"address":"+14165551234",
				"displayText":"Mobile Office",
				"latitude":43.649269,
				"longitude":-79.378423,
				"postbackData":"e460dd65-e69b-4f86-a5af-458683248f2d_url_google"
			}
		]
	},
	"suggestions":[
		{
			"type":"reply",
			"displayText":"Yes",
			"postbackData":"usr_msg_yes"
		},
		{
			"type":"viewLocation",
			"address":"+14165551234",
			"displayText":"Mobile Office",
			"latitude":43.649269,
			"longitude":-79.378423,
			"postbackData":"e460dd65-e69b-4f86-a5af-458683248f2d_url_google"
		}
	]
}

{
    "type": "carousel",
    "suggestions": [
        {
            "type": "reply",
            "displayText": "Yes",
            "postbackData": "usr_msg_yes"
        },
        {
            "type": "viewLocation",
            "address": "+14165551234",
            "displayText": "Mobile Office",
            "latitude": 43.649269,
            "longitude": -79.378423,
            "postbackData":"e460dd65-e69b-4f86-a5af-458683248f2d_url_google"
        },
        {
            "type": "shareLocation",
            "displayText": "Office",
            "postbackData":"e460dd65-e69b-4f86-a5af-458683248f2d_url_google"
        },
        {
            "type": "openUrl",
            "displayText": "Mobile",
            "url": "http://www.imimobile.com",
            "postbackData":"e460dd65-e69b-4f86-a5af-458683248f2d_url_google"
        },
        {
            "type": "calendarEvent",
            "displayText": "Mobile",
            "startTime": "2017-03-14T00:00:00Z",
            "endTime": "2017-03-14T00:00:00Z",
            "meetingTitle": "http://www.imimobile.com",
            "meetingDescription": "http://www.imimobile.com",
            "postbackData":"e460dd65-e69b-4f86-a5af-458683248f2d_url_google"
        },
        {
            "type": "dialPhone",
            "displayText": "Call Us!",
            "phone": "+14163688400",
            "postbackData":"e460dd65-e69b-4f86-a5af-458683248f2d_url_google"
        }
    ],
    "width": "SMALL/MEDIUM",
    "cards": [
    {
        "title": "The first card",
        "description": "The first card description",
        "media": {
             "height": "SHORT/MEDIUM/TALL",
             "url": "https://bit.ly/2J5i2x0",
             "fileSize":1148279
        },
 "suggestions": [
        {
            "type": "reply",
            "displayText": "Yes",
            "postbackData": "usr_msg_yes"
        },
        {
            "type": "viewLocation",
            "address": "+14165551234",
            "displayText": "Mobile Office",
            "latitude": 43.649269,
            "longitude": -79.378423,
            "postbackData":"e460dd65-e69b-4f86-a5af-458683248f2d_url_google"
        }
    ],
    },
    {
        "title": "The second card",
        "description": "The second card description",
        "media": {
            "height": "SHORT/MEDIUM/TALL",
            "url": "https://bit.ly/2P5Q9dK",
            "fileSize":1148279
        },
 "suggestions": [
        {
            "type": "reply",
            "displayText": "Yes",
            "postbackData": "usr_msg_yes"
        },
        {
            "type": "viewLocation",
            "address": "+14165551234",
            "displayText": "Mobile Office",
            "latitude": 43.649269,
            "longitude": -79.378423,
            "postbackData":"e460dd65-e69b-4f86-a5af-458683248f2d_url_google"
        }
    ]
    } ]
}

{
    "type": "agentEvent",
    "event": "IS_TYPING"
}

{
    "type": "agentEvent",
    "event": "READ",
    "messageId": "3682cb0f-5dae-42fe-9a75-2aea271efeff
}