The fbmessenger-api package

[ Tags: bsd3, library, program, web ] [ Propose Tags ]

Please see README.md


[Skip to Readme]

Properties

Versions 0.1.0.0, 0.1.0.1, 0.1.0.2, 0.1.0.3, 0.1.1.0, 0.1.1.1, 0.1.2.0, 0.1.2.1 (info)
Dependencies aeson, base (>=4.7 && <5), bytestring, case-insensitive, fbmessenger-api, http-client, http-client-tls, http-media, http-types, mime-types, monad-logger, servant (>=0.7.0), servant-client (>=0.7.0), servant-server (>=0.7.0), stm, string-conversions, text, transformers, unordered-containers, wai, wai-logger, warp [details]
License BSD3
Copyright 2016 Marcello Seri
Author Marcello Seri
Maintainer marcello.seri@gmail.com
Category Web
Home page https://github.com/mseri/fbmessenger-api-hs#fbmessenger-api
Source repository head: git clone https://github.com/mseri/fbmessenger-api-hs
Uploaded Sat Nov 12 10:53:08 UTC 2016 by mseri
Distributions NixOS:0.1.2.1
Executables example
Downloads 630 total (265 in the last 30 days)
Rating (no votes yet) [estimated by rule of succession]
Your Rating
  • λ
  • λ
  • λ
Status Docs not available [build log]
All reported builds failed as of 2016-11-17 [all 3 reports]
Hackage Matrix CI

Modules

  • Web
    • FBMessenger
      • API
        • Web.FBMessenger.API.Bot
          • Web.FBMessenger.API.Bot.Requests
          • Web.FBMessenger.API.Bot.Responses
          • Web.FBMessenger.API.Bot.SendAPI
          • Web.FBMessenger.API.Bot.WebhookAPI

Downloads

Maintainer's Corner

For package maintainers and hackage trustees


Readme for fbmessenger-api-0.1.2.1

[back to package description]

FBMessenger API

Build Status Hackage Hackage Dependencies Haskell Programming Language BSD3 License

High-level bindings to the Messenger Platform API based on servant library. We try to maintain the overall structure compatible with telegram-api.

There was an incongruence between the spec and the actual serialization of the webhook requests that became apparent when testing an actual messenger bot. For this reason you should use only versions of the library that are >= 0.1.1!

This library is alpha software and the API design could change to improve composability, ergonomicity and ease of use. We recommend using stack for dealing with this library (you will need to add it to the extra-deps in stack.yaml).

NOTE (1.6.2016): the WelcomeMessageSendAPI recently changed. The Platform no-longer accepts any welcome message api-wise (only a custom payload is now allowed). The library will be updated to reflect this change as soon as I can (otherwise you are welcome to submit a PR). To setup/modify the Welcome Message you have to use the online interface.

Usage

Before being able to test and use the bot, you will need to verify your key. The example app in example-app/example.hs contains a servant server that implements the verification and a trivial echo-server. You can run it with

VERIFY_TOKEN="your_token_goes_here" stack exec example

and pass it some data (here assuming you have httpie installed)

http get 'localhost:3000/webhook/?hub.verify_token=your_token_goes_here&hub.challenge=test'
http post :3000/webhook < test-files/wsTextMessageRequest.json

Otherwise run stack ghci then copy and paste the following

:m +Network.HTTP.Client
:m +Network.HTTP.Client.TLS
:m +Data.Text

let token = Token $ Data.Text.pack "your_token_goes_here"
let manager = newManager tlsManagerSettings
manager >>= \m -> subscribedApps $ Just token m

You should get a positive response or (in case of inactive token):

Left (FailureResponse {responseStatus = Status {statusCode = 400, statusMessage = "Bad Request"}, responseContentType = application/json, responseBody = "{\"error\":{\"message\":\"Invalid OAuth access token.\",\"type\":\"OAuthException\",\"code\":190,\"fbtrace_id\":\"ESxHmUos2B+\"}}"})

Contribution

  1. Fork repository
  2. Do some changes
  3. Create pull request
  4. Wait for CI build and review

You can use stack to build the project

stack build

To run tests

stack test

TODO