Airline Check-in Reminder Template Reference

Airline Template will no longer be supported starting Graph API v11.0. Deprecation for the prior versions of the Graph API will occur 6 months after the announcement of this change on December 6th, 2021. We recommend airlines send ‘Boarding Pass’ and ‘Check-in’ templates as images which is consistent with how they typically send these notifications in other channels.

The airline check-in reminder template allows you to send a structured message that contains a check-in reminder with flight information. For complete implementation details, see Airline Check-in Reminder Template.

Request URI

https://graph.facebook.com/v11.0/me/messages?access_token=<PAGE_ACCESS_TOKEN>

Example Request

curl -X POST -H "Content-Type: application/json" -d '{
  "recipient": {
    "id": "<PSID>"
  },
  "message": {
    "attachment": {
      "type": "template",
      "payload": {
        "template_type": "airline_checkin",
        "intro_message": "Check-in is available now.",
        "locale": "en_US",        
        "pnr_number": "ABCDEF",
        "checkin_url": "https:\/\/www.airline.com\/check-in",  
        "flight_info": [
          {
            "flight_number": "f001",
            "departure_airport": {
              "airport_code": "SFO",
              "city": "San Francisco",
              "terminal": "T4",
              "gate": "G8"
            },
            "arrival_airport": {
              "airport_code": "SEA",
              "city": "Seattle",
              "terminal": "T4",
              "gate": "G8"
            },
            "flight_schedule": {
              "boarding_time": "2016-01-05T15:05",
              "departure_time": "2016-01-05T15:45",
              "arrival_time": "2016-01-05T17:30"
            }
          }
        ]
      }
    }
  }
}' 'https://graph.facebook.com/v2.6/me/messages?access_token=<PAGE_ACCESS_TOKEN>'

Example Response

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

Properties

`recipient`

Description of the message recipient. All requests must include one of the following properties to identify the recipient.

Property	Type	Description
`recipient.id`	String	Page Scoped User ID (PSID) of the message recipient. The user needs to have interacted with any of the Messenger entry points in order to opt-in into messaging with the Page. Note that Facebook Login integrations return user IDs are app-scoped and will not work with the Messenger platform.
`recipient.user_ref`	String	Used for the checkbox plugin and customer chat plugin.
`recipient.post_id`	String	Used for Private Replies to reference the visitor post to reply to.
`recipient.comment_id`	String	Used for Private Replies to reference the post comment to reply to.

`message`

Description of the message to be sent.

Property	Type	Description
`message.attachment`	Object	An object describing attachments to the message.

`message.attachment`

Property	Type	Description
`type`	String	Value must be `template`
`payload`	Object	`payload` of the template.

`message.attachment.payload`

Property Name	Type	Description
`template_type`	String	Value must be `airline_checkin`
`intro_message`	String	Introduction message
`locale`	String	Two-letter language region code. Must be a two-letter ISO 639-1 language code and a ISO 3166-1 alpha-2 region code separated by an underscore character. Used to translate field labels (e.g. en_US). See this document for more information about Facebook's locale support.
`pnr_number`	String	*Optional.* The Passenger Name Record number (Booking Number).
`checkin_url`	String	The URL where the customer can check in for their flight.
`flight_info`	Array	The flight number, departure airport, arrival airport, and schedule information for the flight.

`message.attachment.payload.flight_info`

Property Name	Type	Required
`flight_number`	String	Flight number
`departure_airport`	Object	Departure airport. See departure_airport
`arrival_airport`	Object	Arrival airport. See arrival_airport.
`flight_schedule`	Object	Schedule for the flight. See flight_schedule.

`message.attachment.payload.flight_info.flight_schedule`

Property Name	Type	Description
`boarding_time`	String	*Optional.* Boarding time in departure airport timezone. Must be in the ISO 8601-based format YYYY-MM-DDThh:mm (e.g. 2015-09-26T10:30).
`departure_time`	String	Departure time in departure airport timezone. Must be in the ISO 8601-based format YYYY-MM-DDThh:mm (e.g. 2015-09-26T10:30).
`arrival_time`	String	*Optional.* Arrival time in arrival airport timezone. Must be in the ISO 8601-based format YYYY-MM-DDThh:mm (e.g. 2015-09-26T10:30).

`message.attachment.payload.flight_info.departure_airport`

Property	Type	Description
`airport_code`	String	Airport code of the departure airport.
`city`	String	Departure city of the flight.
`terminal`	String	Terminal of the departing flight.
`gate`	String	Gate for the departing flight.

`message.attachment.payload.flight_info.arrival_airport`

Property	Type	Description
`airport_code`	String	Airport code of the arrival airport.
`city`	String	Arrival city of the flight.
`terminal`	String	Terminal of the departing flight.
`gate`	String	Gate for the departing flight.

Airline Check-in Reminder Template Reference

Contents

Request URI

Example Request

Example Response

Properties

recipient

message

message.attachment

message.attachment.payload

message.attachment.payload.flight_info

message.attachment.payload.flight_info.flight_schedule

message.attachment.payload.flight_info.departure_airport

message.attachment.payload.flight_info.arrival_airport