Skip to main content

How to send Mobile Landing Pages via API

  • Updated

Mobile landing pages are a mobile-first business messaging solution, with rich content and detailed analytics. You can extend your SMS journeys to a personalised mobile landing page for enhanced user interactivity and measurable engagement. The mobile landing pages API provides the facilities to create mobile landing pages and send them to recipients.

The process of creating a mobile landing page campaign involves;

  1. Configuring a mobile landing page template.
  2. Schedule and send to recipients.

Prerequisites:

Part One: Configuring Your Template

In this developer guide, you will send out a campaign using mobile landing pages. It will include custom trackable links, rich visual content with a special offer or voucher, and interactive buttons. MessageMedia offers various templates for customisation, and this guide will be using the Fermont template. Each template requires a number of customisable elements which will be demonstrated, so you understand how to use each available parameter.  

2022-10-18_092945.jpg

 

In Postman, open up the Create New Campaign request. You'll need to edit the body of the request to include values for all of the parameters for this template. To get started, go to a stock image site like Unsplash and get a nice image for your voucher. You'll need to get a publicly accessible image URL, by uploading it to an image-sharing service such as imgbb. The full body of the request with the required parameters, should look like this:

{
 "template_id": "c9d7ce1d-20c4-4228-9ba1-6da2a3b4e5e0",
 "parameters": {
    "headline": "Refresh your wardrobe with $30 off!",
    "pageText": "Come in this weekend and check out our new summer range. VIPs who present this voucher are entitled to a $30 reward. We'll have sparkling on arrival and live music from 2 - 5pm all weekend.",
    "imageHeaderUrl": "https://developers.messagemedia.com/wp-content/themes/devportal/dist/images/fakeshopimage.jpg",
    "primaryButtonText": "SHOP NOW",
    "primaryButtonLink": "http://examplestore.com",
 "secondaryButtonLink": "https://example.com/store-finder",
 "secondaryButtonText": "FIND A STORE",
 "logoLink":"http://examplestore.com",
 "imageLogoURL":"https://developers.messagemedia.com/wp-content/themes/devportal/dist/images/fakelogo.png",
 "barcodeValue": "0123456578901234565789"
 },
 "message": {
 "content": "Hello ${firstName}, will we see you at our summer sales party this weekend? xoxo the Summer Shop team",
 "metadata": {
 "sign-up": "cashier"
 }
 }
 }

 

Different templates require different parameters, and you can find the mapping of the required parameters for each template in the documentation. In the above API call body, we've set image values for the images and links to the places that we want our customers to be linked to. We have also set a barcode value, which will correspond to a voucher code in our store’s POS system. 

In the Message body, we've used a template parameter which will be filled in later when we set the value for ${firstName} at send time. Finally, we take the opportunity to set some metadata, which corresponds to the way that the customer signed up, from our CRM system. Campaign and Recipient messages can contain template parameters. These parameters are used to customise the generated landing page and the message to be sent to each user. Note that both Campaign and Recipient parameters are merged to form a complete set when processing a recipient. Thus, when resolving parameter sets, Recipient parameters override Campaign parameters with the same name. 

For further information about the concepts associated with campaigns, and advanced configuration options, see the documentation. In the above call, we have also set the link preview details. For more information about this feature, check out our Developer Portal. If your credentials are in the Postman variables correctly, when you post, you will get this back:

{
 "id": "a733f81e-f6b5-40d2-8c21-41fa719a58bb",
 "message": {
    "content": "Hello ${firstName}, will we see you at our summer sales party this weekend? xoxo the Summer Shop team",
    "metadata": {
       "sign-up": "cashier"
    },
    "rich_link": {
       "title": "Refresh your wardrobe with $30 off!",
       "image": "https://developers.messagemedia.com/wp-content/themes/devportal/dist/images/fakeshopimage.jpg",
       "description": "Click through to your voucher..."
    }
 },
 "parameters": {
    "headline": "Refresh your wardrobe with $30 off!",
    "pageText": "Come in this weekend and check out our new summer range. VIPs who present this voucher are entitled to a $30 reward. We'll have sparkling on arrival and live music from 2 - 5pm all weekend.",
    "imageUrl": "https://developers.messagemedia.com/wp-content/themes/devportal/dist/images/fakeshopimage.jpg",
    "primaryButtonText": "SHOP NOW",
    "primaryButtonLink": "http://examplestore.com",
    "secondaryButtonLink": "https://example.com/store-finder",
    "secondaryButtonText": "FIND A STORE",
    "logoLink": "http://examplestore.com",
    "imageLogoURL": "https://developers.messagemedia.com/wp-content/themes/devportal/dist/images/fakelogo.png",
    "barcodeValue": "0123456578901234565789"
 },
 "template_id": "c9d7ce1d-20c4-4228-9ba1-6da2a3b4e5e0"
 }

You will need to use the campaign id in the subsequent call.

 

Part Two: Sending the Campaign

Now we are going to send this campaign to recipients. Open up the Send Campaign to Recipients request and add the campaign id to the parameters section in Postman:

 

Now in the body, add an object for each recipient. You will need to set any template parameters from the body of the text message or the content of the landing page. For example, in this request body, we have indicated that there is a template parameter called “firstName” (which we set up when we created the campaign) and that its value should be “Bec”:

{
 "recipients": [
    {
       "id": "ae599880-8d37-4956-af7b-1fcf8693773b",
       "number": "+61466412529",
       "parameters": {
       "firstName": "Bec"
       }
     }
   ]
 }

Hit Send in Postman, and then you’re done!

 

Conclusion

Mobile landing pages are a powerful feature to increase engagement with your messages. There are a number of available templates that can be easily customised to create visually beautiful landing pages. Integrating this into your software can provide a mechanism for a number of interactive use cases, such as retail vouchers, appointment and booking confirmations and more.  

Related articles