Facebook Messenger Connector Setup Guide

Facebook Messenger Connector Setup Guide

by ‎03-29-2018 10:01 AM - edited ‎04-03-2018 04:15 PM (374 Views)

Many types of unstructured content can be sent with the Facebook Messenger platform, including text, audio, images, video, and files. There are also a number of pre-defined message templates available that allow you to send structured messages for a richer experience. This article describes how to set up the Facebook Messenger Connector service in your Universal Data Hub profile.

Table of Contents Placeholder

Requirements

Supported Actions

Action Name Trigger on Audience Trigger on Streams
Send Text Only Message
Send Media Message
Send Sender Action
Send Template Message (Advanced)

Configure Settings

Go to the Connector Marketplace and add a new Facebook Messenger Connector. Read the Connector Overview article for general instructions on how to add a Connector.

To configure your vendor, follow these steps:

  1. In the Configure tab, provide a title for the Connector instance.

  2. Enter the page access token from your Facebook account.

  3. Provide additional notes about your implementation.

Action Settings - Parameters and Options

Click Next or go to the Actions tab. It's where you'll set up Actions and trigger them.

This section describes how to set up Parameters and Options for each Action.

Action - Send Text Only Message

Parameters

  1. Messaging Type (REQUIRED): The Messaging Type property identifies the messaging type of the message being sent, and is a more explicit way to ensure bots are complying with policies for specific messaging types and respecting people's preferences. See Facebooks's Messaging Types documentation for more info.
  2. Recipient Identifiers (REQUIRED): Identifies the recipient to send a message to. The ID, Phone Number, or User Ref must be set. If using a Phone Number to identify a recipient, your bot must be approved for Customer Matching. When using a Phone Number, it is also possible to set a First Name and Last Name.
  3. Message Text (REQUIRED): The content of the message to send to the user. This field is limited to 2000 characters. This field also supports the Tealium templating engine.
  4. Message Text Template Variables (Optional): If using the templating engine, template variables will be used. These fields map Attributes to variable names that are used in the Message Text. (see Template Variables Guide for the Templating Engine)
  5. Quick Replies (Optional): Quick replies provide a way to present a set of up to 11 buttons in-conversation that contain a title and optional image, and appear prominently above the composer. You can also use quick replies to request a person's location, email address, and phone number. Only array attributes are supported. Each array must be the same length. For more about Quick Replies, see the Quick Reply documentation.
  6. Metadata (Optional): Metadata to send to the facebook webhook message_echoes. This field is limited to 1000 characters. This field also supports the Tealium templating engine.
  7. Metadata Template Variables (Optional): If using the templating engine, template variables will be used. These fields map Attributes to variable names that are used in the Metadata. (see Template Variables Guide for the Templating Engine)
  8. Notification Type (Optional): Push notification type. If not set, will default to REGULAR, which is sound and vibration. SILENT_PUSH will only show an onscreen notification with no vibration. NO_PUSH will display no notification.
  9. Message Tag (Optional): If using the MESSAGE_TAG Messaging Type, this field must be set. For a complete list of all message tags, refer to the Message Tag documentation.

Action - Send Media Message

Parameters

  1. Messaging Type (REQUIRED): The Messaging Type property identifies the messaging type of the message being sent, and is a more explicit way to ensure bots are complying with policies for specific messaging types and respecting people's preferences. See Facebooks's Messaging Types documentation for more info.
  2. Recipient Identifiers (REQUIRED): Identifies the recipient to send a message to. The ID, Phone Number, or User Ref must be set. If using a Phone Number to identify a recipient, your bot must be approved for Customer Matching. When using a Phone Number, it is also possible to set a First Name and Last Name.
  3. Media Type (REQUIRED): The type of media message to send. May be Image, Audio, Video, or a File.
  4. Media URL (Optional): The url of the media to send.
  5. Is Reusable (Optional): Set if the content may be sent to other recipients.
  6. Quick Replies (Optional): Quick replies provide a way to present a set of up to 11 buttons in-conversation that contain a title and optional image, and appear prominently above the composer. You can also use quick replies to request a person's location, email address, and phone number. Only array attributes are supported. Each array must be the same length. For more about Quick Replies, see the Quick Reply documentation.
  7. Metadata (Optional): Metadata to send to the facebook webhook message_echoes. This field is limited to 1000 characters. This field also supports the Tealium templating engine.
  8. Metadata Template Variables (Optional): If using the templating engine, template variables will be used. These fields map Attributes to variable names that are used in the Metadata. (see Template Variables Guide for the Templating Engine)
  9. Notification Type (Optional): Push notification type. If not set, will default to REGULAR, which is sound and vibration. SILENT_PUSH will only show an onscreen notification with no vibration. NO_PUSH will display no notification.
  10. Message Tag (Optional): If using the MESSAGE_TAG Messaging Type, this field must be set. For a complete list of all message tags, refer to the Message Tag documentation.

Action - Send Sender Action

Parameters

  1. Messaging Type (REQUIRED): The Messaging Type property identifies the messaging type of the message being sent, and is a more explicit way to ensure bots are complying with policies for specific messaging types and respecting people's preferences. See Facebooks's Messaging Types documentation for more info.
  2. Recipient Identifiers (REQUIRED): Identifies the recipient to send a message to. The ID, Phone Number, or User Ref must be set. If using a Phone Number to identify a recipient, your bot must be approved for Customer Matching. When using a Phone Number, it is also possible to set a First Name and Last Name.
  3. Sender Action (REQUIRED): The sender action to display to the recipient. May be typing_on, typing_off, or mark_seen.
  4. Message Tag (Optional): If using the MESSAGE_TAG Messaging Type, this field must be set. For a complete list of all message tags, refer to the Message Tag documentation.

Action - Send Template Message (Advanced)

Parameters

  1. Messaging Type (REQUIRED): The Messaging Type property identifies the messaging type of the message being sent, and is a more explicit way to ensure bots are complying with policies for specific messaging types and respecting people's preferences. See Facebooks's Messaging Types documentation for more info.
  2. Recipient Identifiers (REQUIRED): Identifies the recipient to send a message to. The ID, Phone Number, or User Ref must be set. If using a Phone Number to identify a recipient, your bot must be approved for Customer Matching. When using a Phone Number, it is also possible to set a First Name and Last Name.
  3. Template Payload (REQUIRED): Template payload data to send to the recipient. Should be formatted as JSON: { "template_type": "<TEMPLATE_TYPE>", ... } (see Message Template documentation for specific payload contents)
  4. Template Variables (Optional): If using the templating engine, template variables will be used. These fields map Attributes to variable names that are used in the Template Payload. (see Template Variables Guide for the Templating Engine)
  5. Quick Replies (Optional): Quick replies provide a way to present a set of up to 11 buttons in-conversation that contain a title and optional image, and appear prominently above the composer. You can also use quick replies to request a person's location, email address, and phone number. Only array attributes are supported. Each array must be the same length. For more about Quick Replies, see the Quick Reply documentation.
  6. Metadata (Optional): Metadata to send to the facebook webhook message_echoes. This field is limited to 1000 characters. This field also supports the Tealium templating engine.
  7. Metadata Template Variables (Optional): If using the templating engine, template variables will be used. These fields map Attributes to variable names that are used in the Metadata. (see Template Variables Guide for the Templating Engine)
  8. Notification Type (Optional): Push notification type. If not set, will default to REGULAR, which is sound and vibration. SILENT_PUSH will only show an onscreen notification with no vibration. NO_PUSH will display no notification.
  9. Message Tag (Optional): If using the MESSAGE_TAG Messaging Type, this field must be set. For a complete list of all message tags, refer to the Message Tag documentation.

Vendor Documentation

APIs