Web.FBMessenger.API.Bot.Requests

This module contains types and helpers to build requests to the Messenger Platform API to use with SendAPI.

Types

data Button

Button object for structured messages payloads

Constructors

Button

Fields

btn_type :: ButtonType

Value is "web_url" or "postback"

btn_title :: Text

Button title

btn_url :: Maybe Text

For web_url buttons, this URL is opened in a mobile browser when the button is tapped. Required if type is "web_url"

btn_payload :: Maybe Text

For postback buttons, this data will be sent back to you via webhook. Required if type is "postback"

Instances

Eq Button

Show Button

Generic Button

ToJSON Button

FromJSON Button

type Rep Button

data BubbleElement

Bubble element object for structured messages payloads

Constructors

BubbleElement

Fields

elm_title :: Text

Bubble title

elm_item_url :: Maybe Text

URL that is opened when bubble is tapped

elm_image_url :: Maybe Text

Bubble image

elm_subtitle :: Maybe Text

Bubble subtitle

elm_buttons :: Maybe [Button]

Set of buttons that appear as call-to-actions

Instances

Eq BubbleElement

Show BubbleElement

Generic BubbleElement

ToJSON BubbleElement

FromJSON BubbleElement

type Rep BubbleElement

data FileUpload

This object represents data (image, video, ...) with mime type to upload.

Constructors

FileUpload

Fields

fileUpload_type :: Maybe MimeType

Mime type of the upload.

fileUpload_content :: FileUploadContent

The payload/source to upload.

data FileUploadContent

This object represents data (image, video, ...) to upload.

Constructors

FileUploadFile FilePath

FileUploadBS ByteString

FileUploadLBS ByteString

data NotificationType

Push notification type for the message

Constructors

Regular

will emit a sound/vibration and a phone notification (default)

SilentPush

will emit a phone notification

NoPush

will not emit either

Instances

Eq NotificationType

Show NotificationType

ToJSON NotificationType

FromJSON NotificationType

data PaymentSummary

Payment summary object for Receipt Template messages

Constructors

PaymentSummary

Fields

ps_subtotal :: Maybe Double

Subtotal

ps_shipping_cost :: Maybe Double

Shipping Cost

ps_total_tax :: Maybe Double

Total Tax

ps_total_cost :: Double

Total Cost

Instances

Eq PaymentSummary

Show PaymentSummary

Generic PaymentSummary

ToJSON PaymentSummary

FromJSON PaymentSummary

type Rep PaymentSummary

data PaymentAdjustment

Constructors

PaymentAdjustment

Fields

pa_name :: Maybe Text

Name of adjustment

pa_amount :: Maybe Double

Adjusted amount

Instances

Eq PaymentAdjustment

Show PaymentAdjustment

Generic PaymentAdjustment

ToJSON PaymentAdjustment

FromJSON PaymentAdjustment

type Rep PaymentAdjustment

data Recipient

Informations about the recipient of the message

Constructors

Recipient

Fields

recipient_id :: Maybe Text

ID of recipient

recipient_phone_number :: Maybe Text

Phone number of the recipient with the format [phone]

Instances

Eq Recipient

Show Recipient

Generic Recipient

ToJSON Recipient

FromJSON Recipient

type Rep Recipient

data ReceiptItem

Constructors

ReceiptItem

Fields

re_title :: Text

Title of item

re_subtitle :: Maybe Text

Subtitle of item

re_quantity :: Maybe Int

Quantity of item

re_price :: Maybe Int

Item price

re_currency :: Maybe Text

Currency of price

re_image_url :: Maybe Text

Image URL of item

Instances

Eq ReceiptItem

Show ReceiptItem

Generic ReceiptItem

ToJSON ReceiptItem

FromJSON ReceiptItem

type Rep ReceiptItem

data ShippingAddress

Shipping address object for Receipt Template messages

Constructors

ShippingAddress

Fields

sa_street_1 :: Text

Street Address, line 1

sa_street_2 :: Maybe Text

Street Address, line 2

sa_city :: Text

City

sa_postal_code :: Text

Postal Code

sa_state :: Text

State abbrevation

sa_country :: Text

Two-letter country abbreviation

Instances

Eq ShippingAddress

Show ShippingAddress

Generic ShippingAddress

ToJSON ShippingAddress

FromJSON ShippingAddress

type Rep ShippingAddress

data SendTextMessageRequest

This object represents a text message request The message text must be UTF-8, with 320 character limit

Constructors

SendTextMessageRequest

Fields

mRecipient :: Recipient

mText :: Text

mNotificationType :: Maybe NotificationType

Instances

Eq SendTextMessageRequest

Show SendTextMessageRequest

Generic SendTextMessageRequest

ToJSON SendTextMessageRequest

FromJSON SendTextMessageRequest

type Rep SendTextMessageRequest

data SendStructuredMessageRequest

This object represents a structured message request

Constructors

SendStructuredMessageRequest

Fields

smRecipient :: Recipient

smAttachment :: AttachmentWrapper

smNotificationType :: Maybe NotificationType

Instances

Eq SendStructuredMessageRequest

Show SendStructuredMessageRequest

ToJSON SendStructuredMessageRequest

FromJSON SendStructuredMessageRequest

data UploadImageMessageRequest payload

This object represents request for sendImage

Constructors

UploadImageMessageRequest

Fields

uiRecipient :: Recipient

Recipient user

uiFileData :: payload

Photo to send. Formats supported: jpg and png.

Instances

Eq payload => Eq (UploadImageMessageRequest payload)

Show payload => Show (UploadImageMessageRequest payload)

ToJSON (UploadImageMessageRequest Text)

FromJSON (UploadImageMessageRequest Text)

data WelcomeMessageRequest

This object represents a Welcome Message (FromJSON is disabled for it)

Constructors

WelcomeTextMessage

Fields

wtmMessage :: Text

WelcomeStructuredMessage

Fields

wsmMessage :: AttachmentWrapper

WelcomeEmptyMessage

Instances

Eq WelcomeMessageRequest

Show WelcomeMessageRequest

Generic WelcomeMessageRequest

ToJSON WelcomeMessageRequest

type Rep WelcomeMessageRequest

Functions

bubbleElement :: Text -> BubbleElement

Take the bubble element title. The buttons will appear as call-to-action in Messenger. Return a bubble Element

localFileUpload :: FilePath -> FileUpload

Return a FileUpload from a given FilePath. At the moment, only png and jpg images are supported by the API.

paymentSummary :: Double -> PaymentSummary

postbackButton :: Text -> Text -> Button

Take the button title and the button payload (this data will be sent back to you via webhook) and return a "postback" button

receiptItem :: Text -> ReceiptItem

recipient :: Maybe Text -> Maybe Text -> Maybe Recipient

Take reciptient id (optional) or phone_number (optional) and return a 'Maybe Recipient' object. Return Nothing when values are either both (Just _) or both Nothing.

shippingAddress :: Text -> Text -> Text -> Text -> Text -> ShippingAddress

sendButtonTemplateMessageRequest :: Maybe NotificationType -> Recipient -> Text -> [Button] -> SendStructuredMessageRequest

Take a notification type (optional), a recipient, the text of the message and a list of buttons (they will appear as call-to-actions). Return a SendStructuredMessageRequest for a structured message with button template

sendGenericTemplateMessageRequest :: Maybe NotificationType -> Recipient -> [BubbleElement] -> SendStructuredMessageRequest

Take a notification type (optional), a recipient, a list of ButtonElement. Return a SendStructuredMessageRequest for a structured message with generic template

sendImageMessageRequest :: Maybe NotificationType -> Recipient -> Text -> SendStructuredMessageRequest

Take a notification type (optional), a recipient, an image url. Return a SendStructuredMessageRequest for a structured message with image attachment

sendReceiptTemplateMessageRequest :: Maybe NotificationType -> Recipient -> Text -> Text -> Text -> Text -> Maybe Text -> Maybe Text -> [ReceiptItem] -> Maybe ShippingAddress -> PaymentSummary -> Maybe [PaymentAdjustment] -> SendStructuredMessageRequest

Take a notification type (optional), a recipient and all the informations needed to construct a ReceiptTemplate object. Namely: the recipient name, the order number (must be unique), the currency, the payment method, the timestamp (optional), the order url (optional), a list with the receipt items, the shipping address (optional), the payment summary and, finally, a list of payment adjustments (optional). Return a SendStructuredMessageRequest for a structured message with receipt template

sendTextMessageRequest :: Maybe NotificationType -> Recipient -> Text -> SendTextMessageRequest

Take a notification type (optional), a recipient and a text. Return a SendTextMessageRequest. Raise an error if the text is longer than 320 characters.

setWelcomeButtonTemplateMessageRequest :: Text -> [Button] -> WelcomeMessageRequest

Take the text of the message and a list of buttons (they will appear as call-to-actions). Return a WelcomeMessageRequest for a structured message with button template

setWelcomeGenericTemplateMessageRequest :: [BubbleElement] -> WelcomeMessageRequest

Take a list of ButtonElement. Return a WelcomeMessageRequest for a structured message with generic template

setWelcomeImageMessageRequest :: Text -> WelcomeMessageRequest

Take an image url. Return a WelcomeMessageRequest for a structured message with image attachment

setWelcomeTextMessageRequest :: Text -> WelcomeMessageRequest

Take a text. Return a WelcomeMessageRequest

uploadImageMessageRequest :: Recipient -> FileUpload -> UploadImageMessageRequest FileUpload

Take a Recipient and FileUpload (relative to a jpg or png). Return a ('UploadImageMessageRequest FileUpload') for a structured message contatining and image uploaded using multipart form data.

webUrlButton :: Text -> Text -> Button

Take the button title and the button url (this URL is opened in a mobile browser when the button is tapped) and return a "web_url" button