ice_breakers Reference

Ice Breakers provide a way for users to start a conversation with a business with a list of frequently asked questions. This setting is part of the Messenger Profile API Reference.

Contents

Client Requirements

  • Messenger for Android +v240
  • Messenger for iOS +v240

Page Profile Priority

Some of the profile elements like Ice Breakers and Get Started button are incompatible with each other. So when both are set one will take precedence over the other. Here is the priority from highest to lowest:

Editing Custom Questions from the Page Inbox UI is disabled when Ice Breakers are set via API. This is to prevent breaking the experience set by the installed app.

POST request

This sets an Ice Breaker configuration

curl -X POST -H "Content-Type: application/json" -d '{
  "ice_breakers":[
     {
        "question": "<QUESTION>",
        "payload": "<PAYLOAD>",
     },
     {
        "question": "<QUESTION>",
        "payload": "<PAYLOAD>",
     },
     ...
      
  ]
}' "https://graph.facebook.com/v5.0/me/messenger_profile?access_token=<PAGE_ACCESS_TOKEN>"

GET request

curl -X GET "https://graph.facebook.com/v5.0/me/messenger_profile?fields=ice_breakers&access_token=<PAGE_ACCESS_TOKEN>"

Response

{
   "data": [
        {
          "ice_breakers": [
            {
                "question": "<QUESTION>",
                "payload": "<PAYLOAD>",
            },
            {
                "question": "<QUESTION>",
                "payload": "<PAYLOAD>",
            },
            ...
        ]
      }
   ]
}

DELETE Request

curl -X DELETE -H "Content-Type: application/json" -d '{
  "fields": [
    "ice_breakers",
  ]
}' "https://graph.facebook.com/v5.0/me/messenger_profile?access_token=<PAGE_ACCESS_TOKEN>"

Response

{
   "success": "true"
}

Properties

Property Type Description

question

String

Text that will be posted on the thread as the user asking the question.

payload

String

Payload the will be returned as a postback webhook event

Example API Call

API POST call to set up Ice Breakers

curl -X POST -H "Content-Type: application/json" -d '{
  "ice_breakers":[
     {
        "question": "Where are you located?",
        "payload": "LOCATION_POSTBACK_PAYLOAD",
     },
     {
        "question": "What are your hours?",
        "payload": "HOURS_POSTBACK_PAYLOAD",
     },
     {
        "question": "What are your hours?",
        "payload": "HOURS_POSTBACK_PAYLOAD",
     },
     {
        "question": "Can you tell me more about your business?",
        "payload": "MORE_POSTBACK_PAYLOAD",
     },
     {
        "question": "What services do you offer?",
        "payload": "SERVICES_POSTBACK_PAYLOAD",
     }
      
  ]
}' "https://graph.facebook.com/v5.0/me/messenger_profile?access_token=<PAGE_ACCESS_TOKEN>"

Rate Limit

Calls to the Messenger Profile API are limited to 10 API calls per 10 minute interval. This rate limit is enforced per Page.