Call Button Reference

The Call Button can be used to initiate a phone call. This button can be used with the Button and Generic Templates.

For more information on using the call button, see Call Button.

Call Button Overview

Call Button Reference

The Call Button can be used to initiate a phone call. This button can be used with the Button and Generic Templates.

For more information on using the call button, see Call Button.

Call Button Syntax

{
  "type":"phone_number",
  "title":"<BUTTON_TEXT>",
  "payload":"<PHONE_NUMBER>"
}

Call Example Usage

curl -X POST -H "Content-Type: application/json" -d '{
  "recipient":{
    "id":"<PSID>"
  },
  "message":{
    "attachment":{
      "type":"template",
      "payload":{
        "template_type":"button",
        "text":"Need further assistance? Talk to a representative",
        "buttons":[
          {
            "type":"phone_number",
            "title":"Call Representative",
            "payload":"+15105551234"
          }
        ]
      }
    }
  }
}' "https://graph.facebook.com/me/messages?access_token=<PAGE_ACCESS_TOKEN>"

Call Example Response

{
  "recipient_id": "1254477777772919",
  "message_id": "AG5Hz2Uq7tuwNEhXfYYKj8mJEM_QPpz5jdCK48PnKAjSdjfipqxqMvK8ma6AC8fplwlqLP_5cgXIbu7I3rBN0P"
}  

Call Properties

Property Type Description

type

String

Type of button. Must be phone_number.

title

String

Button title, 20 character limit.

payload

String

Format must have "+" prefix followed by the country code, area code and local number. For example, +16505551234.