Skip to content
This repository has been archived by the owner on Aug 12, 2022. It is now read-only.

Message payload

Jasmine Anteunis edited this page Jun 3, 2017 · 4 revisions

This page references all the messages formats you can send with the Connect API.

Buttons can either be:

  • postback: the basic type, once the button is tapped, the value is sent as a payload incoming message.
  • web_url: when this button is tapped, the Url in the value field is loaded.
  • phone_number: when this button is tapped, the phone number in the value field is called

You can find more information here.

Text message:

{
  type: 'text',
  content: 'MY_TEXT',
}

Quick Replies:

{
  type: 'quickReplies',
  content: {
    title: 'TITLE',
    buttons: [
      {
        title: 'BUTTON_TITLE',
        value: 'BUTTON_VALUE',
      },
    ]
  }
}

Cards:

{
  type: 'card',
  content: {
    title: 'CARD_TITLE',
    subtitle: 'CARD_SUBTITLE',
    imageUrl: 'IMAGE_URL',
    buttons: [
      {
        title: 'BUTTON_TITLE',
        type: 'BUTTON_TYPE', // 'postback', 'web_url' or 'phone_number'
        value: 'BUTTON_VALUE',
      }
    ],
  },
}

Pictures:

{
  type: 'picture',
  content: 'IMAGE_URL',
}

Videos:

{
  type: 'video',
  content: 'VIDEO_URL',
}
Clone this wiki locally