License	BSD3
Maintainer	Marcello Seri <marcello.seri@gmail.com>
Stability	experimental
Portability	unknown
Safe Haskell	None
Language	Haskell2010

Web.FBMessenger.API.Bot.Responses

Contents

Types
Functions

Description

This module contains types and helpers to parse the responses from the Messenger Platform API. See also SendAPI.

Synopsis

Types

data MessageResponse Source

This object contais the response after a message has been succesfully sent

Constructors

MessageResponse
Fields message_response_recipient_id :: Text message_response_message_id :: Text

Instances

Eq MessageResponse Source
Show MessageResponse Source
Generic MessageResponse Source
ToJSON MessageResponse Source
FromJSON MessageResponse Source
type Rep MessageResponse Source

data SendErrorCode Source

Send API Error Codes (see: https://developers.facebook.com/docs/messenger-platform/send-api-reference#errors)

Code Description 2 Send message failure. Internal server error. 10 Application does not have permission to use the Send API 100 No matching user found 613 Calls to this api have exceeded the rate limit.

Constructors

InternalServerError
UnauthorizedApplication
NoMatchingUserFound
RateLimitError

Instances

Eq SendErrorCode Source
Show SendErrorCode Source
ToJSON SendErrorCode Source
FromJSON SendErrorCode Source

data SendErrorObject Source

Send API Error response object (see: https://developers.facebook.com/docs/messenger-platform/send-api-reference#errors)

{ "error":{ "message":"Invalid parameter", "type":FacebookApiException, "code":100, "error_data":"No matching user found.", "fbtrace_id":D2kxCybrKVw }

Constructors

SendErrorObject
Fields eoMessage :: Text eoType :: Text eoCode :: SendErrorCode eoErrorData :: Text eoFbtraceId :: Text

Instances

Eq SendErrorObject Source
Show SendErrorObject Source
Generic SendErrorObject Source
ToJSON SendErrorObject Source
FromJSON SendErrorObject Source
type Rep SendErrorObject Source

data SubscriptionResponse Source

This object represents the subscribed_apps success response

Constructors

SubscriptionResponse
Fields subscription_success :: Bool

Instances

Eq SubscriptionResponse Source
Show SubscriptionResponse Source
Generic SubscriptionResponse Source
ToJSON SubscriptionResponse Source
FromJSON SubscriptionResponse Source
type Rep SubscriptionResponse Source

data UserProfileResponse Source

This objects contains the User Profile informations

Constructors

UserProfileResponse
Fields usr_first_name :: Text usr_last_name :: Text usr_profile_pic :: Text usr_locale :: Text usr_timezone :: Int usr_gender :: Text

Instances

Eq UserProfileResponse Source
Show UserProfileResponse Source
Generic UserProfileResponse Source
ToJSON UserProfileResponse Source
FromJSON UserProfileResponse Source
type Rep UserProfileResponse Source

data WelcomeMessageResponse Source

This objects contains informations on the succesful setup of a welcome message

Constructors

WelcomeMessageResponse
Fields wmr_result :: Text

Instances

Eq WelcomeMessageResponse Source
Show WelcomeMessageResponse Source
Generic WelcomeMessageResponse Source
ToJSON WelcomeMessageResponse Source
FromJSON WelcomeMessageResponse Source
type Rep WelcomeMessageResponse Source

Functions

errorInfo :: SendErrorObject -> (SendErrorCode, Text) Source

Take a Send API error object and return a tuple containing the error code and the error_data (seems to always be the description)

extractSendError :: ServantError -> Maybe SendErrorObject Source

Extracts a Send API Error object from the ServantError (when possible).