Messenger from Meta

Preview

This product or feature is subject to the "Pre-GA Offerings Terms" in the General Service Terms section of the Service Specific Terms. Pre-GA products and features are available "as is" and might have limited support. For more information, see the launch stage descriptions.

Using the Meta Messenger integration, you can create a Meta Messenger bot to interact with your end-users.

Note: When using a third party integration, requests and end-user data are sent to both Google and the third party. The terms of service, SLA, pricing, and quotas for your agent edition are applicable for Google's handling of these requests. The third party's terms of service, SLA, pricing, and quotas are applicable for the third party's handling of these requests.

How it works

Note: This integration does not support Workplace from Meta.

This is how the integration works:

• You create a Meta app that uses the Meta Messenger Platform.
• You configure the Conversational Agents (Dialogflow CX) integration and Meta app, so that they communicate with each other.
• The Conversational Agents (Dialogflow CX) integration sends messages to the end-user by using the Meta Messenger API.
• The Conversational Agents (Dialogflow CX) integration receives messages from the end-user by acting as the Meta Webhooks for Messenger Platform.

Setup

Note: Make sure billing is enabled on your project before testing the integration.

To set up the integration:

1. Follow the steps to create a Meta app: Meta App Development.

2. Set up the Meta app to use the Meta Messenger Platform. Follow the steps in the Meta Webhooks for Messenger Platform documentation to accomplish the following:

   • Add the Messenger Platform to your Meta app.
   • Subscribe your app to a Meta page. Make sure messages and messaging_postbacks are enabled in the page subscription.
   • You are provided with an access token at this step. Copy this value. This token is used to configure the integration from the Conversational Agents (Dialogflow CX) console.
   • Do not configure the webhook or test your integration yet.

3. Configure the integration from the Conversational Agents (Dialogflow CX) console:

   1. Go to the Dialogflow CX console.
   2. Click the Manage tab on the left panel.
   3. Click Integrations in the left sidebar menu.
   4. Click the Connect button on the Meta Messenger tile.

   5. A configuration dialog opens:

      • App secret: Enter the app secret from App Dashboard Basic Settings.

      • Verify token: You can enter any private token you desire. Copy this value. This is used to configure the Meta Messenger Webhook.

      • Page access token: Enter the access token you copied during the Meta app setup above.

      • Enable get started button: Please see Get started button section.

      • Webhook URL: Copy this value. This is used to configure the Meta Messenger Webhook.

      • Start: Click to start this integration service for your agent.

4. Finish setup of the Meta app and test it. Follow steps in the Meta Webhooks for Messenger Platform documentation to accomplish the following:

   • Configure the Meta webhook for your app. Use the Webhook URL and Verify token values you copied above. Be sure to enable messages and messaging_postbacks in the page subscription.
   • Test your app.

Events

The following events are invoked by this integration. You can create custom event handlers to define what to do when the events are triggered.

Event	Description
FACEBOOK_WELCOME	Triggered when an end-user clicks the Meta Messenger Get Started Button.
FACEBOOK_MEDIA	Triggered when the message from an end-user contains attachments (E.g., audio, image, video, etc).

Get started button

To set up Meta Messenger Get Started Button:

1. Toggle Enable get started button when enabling this integration service.

   • This integration service enables the button for you by calling Messenger Profile API.

     curl -X POST \
     -H "Content-Type: application/json" \
     -d '{"get_started": {"payload": "FACEBOOK_WELCOME"}}' \
     "https://graph.facebook.com/v10.0/me/messenger_profile?access_token=${PAGE_ACCESS_TOKEN}"
     

2. Create a custom event handler for FACEBOOK_WELCOME event.

To test it:

1. Delete the previous conversation with your Meta page (if applicable).

   • The Get Started button only shows up on new conversations.

2. Start a new conversation with your Meta page.

3. Click the Get Started button, and verify the response from the custom event handler.

You can always call Messenger Profile API to manage the Get Started button. This might be helpful for testing.

For example, the following request checks the status of Get Started button:

curl -X GET \
"https://graph.facebook.com/v10.0/me/messenger_profile?fields=get_started&access_token=${PAGE_ACCESS_TOKEN}"

The following request disables the Get Started button:

curl -X DELETE \
-H "Content-Type: application/json" \
-d '{"fields": ["get_started"]}' \
"https://graph.facebook.com/v10.0/me/messenger_profile?access_token=${PAGE_ACCESS_TOKEN}"

Rich response messages

The rich response messages are supported via Custom Payload in Fulfillment. Please see Send API Parameters Message Object for the message format.

For example, the following custom payload provides a simple text message:

{
  "text": "Hello, world"
}

The following custom payload provides an image message:

{
  "attachment": {
    "type": "image",
    "payload": {
      "url": "https://example.com/test.jpg"
    }
  }
}

Channel specific responses

After you configure the channel-specific responses, the channel DF_CX_FB_MESSENGER is automatically used when the agent responds to Meta Messenger messages.