m.me Links

This document shows you how to create m.me links for your Messenger experience.

m.me is a URL service provided by Meta that redirects people to a person, page, or conversation in Messenger. You can use them on your website, email newsletters, and more.

How It Works

The format for an m.me link is as follows where PAGE-NAME is the Facebook Page linked to your messaging app.

When a person click an m.me link, they will be redirected to either a new conversation with your business or an exist conversation if the person has messaged your business in the past. A default message will appear in the conversation stating: "You have entered this conversation by following a link. We've let PAGE-NAME know you're here."

You can add the text parameter to include a customized message as well.

Businesses can share links that redirect to websites or other threads, some of which may include prefilled text.

When a person clicks the Get Started button to start a conversation with your business, a messaging_postbacks webhook notification will be sent to your webhooks server. As part of this webhook notification the postback object will contain a referral object with the ref parameter.

When a person clicks an m.me link and a conversation already exists between your business and the person, the link will take them to the existing conversation. This action will reset the 24-hour standard messaging window, allowing your messaging app to reply to the person and a messaging_referrals webhook notification will be sent to your webhooks server. As part of this webhook notification a ref parameter from the m.me link will be included.

Referral Parameters

An m.me link can contain a ref parameter that, when a person clicks on the link, provides your business with more context about the conversation such as a link on your website versus a link in a store. These types of links can also direct the person to specific content or features available within your Messenger experience.

QR Codes

m.me links with ref parameters can be embedded into QR Codes. QR compatible codes can be scanned with a phone's native camera. When scanned they will open the Messenger app and the message conversation with your business.

QR Code Example The example QR code has http://m.me/OriginalCoastClothing?ref=summer_coupon encoded that will trigger an example flow about a discount coupon on Messenger.

Webhook Notification

When you receive a webhook notification it will contain information from a person who is starting a conversation with your business or from a person who has an existing conversation with your business.

Start a Conversation

When a person clicks the Get Started button to start a conversation with your business, we will deliver the ref param as part of the messaging_postbacks webhook notification.

{
  "sender":{
    "id":"PSID"
  },
  "recipient":{
    "id":"PAGE-ID"
  },
  "timestamp":1458692752478,
  "postback":{
    "payload":"POSTBACK-PAYLOAD-YOU-CONFIGURED",
    "referral": {
      "ref": "REF-PARAMETER-INFORMATION",
      "source": "SHORTLINK",
      "type": "OPEN_THREAD",
    }
  }
}

Continue in an Existing Conversation

If a conversation already exists between your business and the person who clicked the m.me link, the link the messaging_referrals webhook notification will be sent.

{
  "sender":{
    "id":"PSID"
  },
  "recipient":{
    "id":"PAGE-ID"
  },
  "timestamp":1458692752478,
  "referral": {
    "ref": "REF-PARAMETER-INFORMATION",
    "source": "SHORTLINK",
    "type": "OPEN_THREAD",
  }
}

Before You Start

You will need:

• Advanced Access for the app that is linked to your business' Facebook Page
• A Get Started Button for your Messenger experience for new conversations
• The app linked to your business' Facebook Page must be subscribed to the messaging_postbacks and messaging_referrals webhooks fields

Limitations

• Apps with Standard Access can only get information from people who have a developer, tester, or admin role on your messaging app

Marketing Messages Opt In Requests

The m.me/rn URL allows you to create a recurring notification opt in request with an m.me link. The format for an m.me/rn link must include the topic for the recurring notification. You can set the cadence for the recurring notification otherwise it will default to daily.

Limitations

• iOS version 383 is required for m.me/rn links to work properly. The person who clicked on your link will be redirect to your base m.me URL, http://m.me/PAGE-NAME URL

Marketing Messages Example Link

Register Your Topic

Before you can use your m.me/rn URL with a new topic, you must first register the new topic.

If you are using a topic you have used in a previous m.me/rn URL and people have opted in to receive recurring notifications, you do not need to register the topic again.

You can register a new topic by following these steps:

Step 1. Send yourself a recurring notification opt in request with the topic to a person who has a role on your app. We recommend adding the payload to indicate this is to register your topic.

curl -X POST -H "Content-Type: application/json" -d '{
  "recipient":{
    "id":"PSID"
  },
  "message":{
    "attachment":{
      "type":"template", 
      "payload":{
         "template_type":"notification_messages", 
          "title":"TITLE",
          "payload": "Registering a new topic: TOPIC-NAME",
          "notification_messages_frequency": MESSAGE-FREQUENCY,
      }
    }
  }
}' "https://graph.facebook.com/LATEST-API-VERSION/PAGE-ID/messages?access_token=PAGE-ACCESS-TOKEN"

On success, your app receives the following JSON response:

{ 
        "recipient": {
          "id":"PSID",
          "message_id":"MESSAGE-ID",
}

Step 2. Make sure to click the opt in button in the conversation. We will send you an optin webhook notification. Your topic is now registered and ready for public use.

Sample Request

curl -X POST "https://graph.facebook.com/LATEST-API-VERSION/PAGE-ID/notification_messages_dev_support
    ?recipient={
        "notification_messages_token": "NOTIFICATION-MESSAGES-TOKEN"
    }
    &developer_action=ENABLE_FOLLOWUP_MESSAGE
    &access_token=PAGE-ACCESS-TOKEN"

On success, your app will receive the following JSON response:

{ "success": true }

messaging_optins Webhook Notification

When you receive a webhook notification it will contain information from a person who is starting a conversation with your business or from a person who has an existing conversation with your business.

{
  "sender": {
    "id": "PSID",
  },
  "recipient": {
    "id": "PAGE-ID",
  },
  "timestamp": "TIMESTAMP",
  "optin": {
    "type": "notification_messages", 
    "title": "TITLE-FOR-NOTIFICATION-MESSAGE",
    "ref": "REF-PARAMETER-INFORMATION",
    "payload": "",
    "source":"SHORTLINK"
    "notification_messages_token": "NOTIFICATION-MESSAGES-TOKEN", 
    "notification_messages_topic": "RECURRING-NOTIFICATION-TOPIC", 
    "notification_messages_frequency": "MESSAGE-FREQUENCY",
    "notification_messages_timezone": "TIMEZONE-ID",
    "token_expiry_timestamp": "TIMESTAMP",
    "user_token_status": "TOKEN-STATUS"
    }
}

m.me Reference

Next Steps

• Send a Reply
• Send a Recurring Notification

See Also

• See the Referral Parameters page on Original Coast Clothing Sample Guide
• Visit the messaging_optins reference
• Visit the messaging_postbacks reference for more information about this webhook's fields
• Visit the messaging_referrals reference for more information about this webhook's fields