Web.FBMessenger.API.Bot.SendAPI

Functions

getUserProfileInfo :: Maybe Token -> Text -> Manager -> IO (Either ServantError UserProfileResponse)

Get the profile informations of a user. In addition to the token, you need to provide the user_id. Return a record containing the profile informations.

removeWelcomeMessage :: Maybe Token -> Text -> Manager -> IO (Either ServantError WelcomeMessageResponse)

Remove the welcome message. In addition to the token, you need to provide the facebook page_id. Return a simple object containing a string indicating if the welcome message is correctly removed.

sendTextMessage :: Maybe Token -> SendTextMessageRequest -> Manager -> IO (Either ServantError MessageResponse)

Send text messages. On success, minor informations on the sent message are returned.

sendStructuredMessage :: Maybe Token -> SendStructuredMessageRequest -> Manager -> IO (Either ServantError MessageResponse)

Send a structured messages. This can be an image message (containing an image url) or any template message (generic, button, receipt). On success, minor informations on the sent message are returned.

setWelcomeMessage :: Maybe Token -> Text -> WelcomeMessageRequest -> Manager -> IO (Either ServantError WelcomeMessageResponse)

Set a welcome message, this can be an image message (containing an image url) or any template message (generic, button, receipt). In addition to the token and the message request, you need to provide the facebook page_id. Return a simple object containing a string indicating if the welcome message is correctly registered.

subscribedApps :: Maybe Token -> Manager -> IO (Either ServantError SubscriptionResponse)

Test if your bot's auth token is enabled. Requires no parameters. Return a simple object containing a boolean value indicating if the token is correctly registered.

uploadImageMessage :: Maybe Token -> UploadImageMessageRequest FileUpload -> Manager -> IO (Either ServantError MessageResponse)

Upload an image and send a structured messages containing it. On success, minor informations on the sent message are returned.

API

api :: Proxy FBMessengerSendAPI

Proxy for Messenger Platform Bot Send

type FBMessengerSendAPI = (GraphAPIAccessToken :> ("messages" :> (ReqBody '[JSON] SendTextMessageRequest :> Post '[JSON] MessageResponse))) :<|> ((GraphAPIAccessToken :> ("messages" :> (MultipartFormDataReqBody (UploadImageMessageRequest FileUpload) :> Post '[JSON] MessageResponse))) :<|> ((GraphAPIAccessToken :> ("messages" :> (ReqBody '[JSON] SendStructuredMessageRequest :> Post '[JSON] MessageResponse))) :<|> ((GraphAPIAccessToken :> ("subscribed_apps" :> Post '[JSON] SubscriptionResponse)) :<|> ((GraphAPIAccessToken :> (Capture "page_id" Text :> ("thread_settings" :> (ReqBody '[JSON] WelcomeMessageRequest :> Post '[JSON] WelcomeMessageResponse)))) :<|> ((GraphAPIAccessToken :> (Capture "page_id" Text :> ("thread_settings" :> (ReqBody '[JSON] WelcomeMessageRequest :> Delete '[JSON] WelcomeMessageResponse)))) :<|> (GraphAPIAccessToken :> (QueryParam "fields" Text :> (Capture "user_id" Text :> Get '[JSON] UserProfileResponse))))))))

Messenger Platform Send API

Types

newtype Token

Messenger Platform PAGE_ACCESS_TOKEN

Constructors

Token Text

Instances

Eq Token

Methods

(==) :: Token -> Token -> Bool

(/=) :: Token -> Token -> Bool

Ord Token

Methods

compare :: Token -> Token -> Ordering

(<) :: Token -> Token -> Bool

(<=) :: Token -> Token -> Bool

(>) :: Token -> Token -> Bool

(>=) :: Token -> Token -> Bool

max :: Token -> Token -> Token

min :: Token -> Token -> Token

Show Token

Methods

showsPrec :: Int -> Token -> ShowS

show :: Token -> String

showList :: [Token] -> ShowS

ToHttpApiData Token

Methods

toUrlPiece :: Token -> Text

toHeader :: Token -> ByteString

toQueryParam :: Token -> Text

FromHttpApiData Token

Methods

parseUrlPiece :: Text -> Either Text Token

parseHeader :: ByteString -> Either Text Token

parseQueryParam :: Text -> Either Text Token