diegorbaquero / node-fb-messenger Goto Github PK

View Code? Open in Web Editor NEW

211.0 9.0 54.0 71 KB

:envelope: Facebook Messenger Platform Node.js API Wrapper

License: MIT License

JavaScript 100.00%

nodejs facebook messenger bot api wrapper node

node-fb-messenger's Introduction

fb-messenger

Facebook Messenger Platform NodeJS API Wrapper

Installation

Requires Node 8+

npm install fb-messenger --save

API

You must require fb-messenger and create an instance

// Constructor
const FBMessenger = require('fb-messenger')
const messenger = new FBMessenger({token, notificationType})
// token is optional, if not included, must be sent in each method, notificationType is optional, default = 'REGULAR'

messenger.setToken(token) // Sets the instance token

messenger.setNotificationType(notificationType) // Sets the instance notificationType

// Methods (notificationType and token are optional)
messenger.sendTextMessage({id, message, notificationType, token}) // Sends a text message

messenger.sendAudioMessage({id, url, notificationType, token}) // Sends an audio from URL

messenger.sendVideoMessage({id, url, notificationType, token}) // Sends an video from URL

messenger.sendImageMessage({id, url, notificationType, token}) // Sends an image from URL

messenger.sendFileMessage({id, url, notificationType, token}) // Sends an file from URL

messenger.sendQuickRepliesMessage({id, attachment, quickReplies, notificationType, token}) // Sends a Quick Replies Message

messenger.sendButtonsMessage({id, message, buttons, notificationType, token}) // Sends a buttons template message

messenger.sendGenericMessage({id, elements, notificationType, token}) // Sends a generic template message

messenger.sendListMessage({id, elements, buttons, top_element_type, notificationType, token}) // Sends a list template message

messenger.sendMediaMessage({id, elements, notificationType, token}) // Sends a media template message

messenger.sendOpenGraphMessage({id, elements, notificationType, token}) // Sends an open graph template message

messenger.sendReceiptMessage({id, payload, notificationType, token}) // Sends a receipt template message (No need for template_type in payload) 

messenger.sendAction({id, actionType, token}) // Send an action type (One of 'mark_seen', 'typing_on', 'typing_off')

messenger.sendMessage({id, data, notificationType, token}) // Send a message from custom data

messenger.getProfile({id, token}) // Gets user information

messenger.setWelcomeMessage({pageId, message, token}) // Sets Page's Welcome Message (message can be a text string or a strucuted message)

messenger.setGreetingText ({pageId, message, token}) // Sets Page's Greeting Text

messenger.setPersistentMenu ({pageId, menuItems, token}) // Set's Page's Persistent Menu

messenger.setDomainWhitelist ({pageId, domains, token}) // Set's Page's Whitelisted Domains 

messenger.sendThreadSettingsMessage ({pageId, body, token}) // Send Manually Page's Thread Settings

Notification Types:

REGULAR
SILENT_PUSH
NO_PUSH

Examples

Basic Example

const FBMessenger = require('fb-messenger')
const messenger = new FBMessenger({token: '<YOUR TOKEN>'}) // Will always use this page's token for request unless sent on each method

messenger.sendTextMessage({id: '<ID>', text: 'Hello'})

Catch errors Example

const FBMessenger = require('fb-messenger')
const messenger = new FBMessenger({token: '<YOUR TOKEN>'})

try {
  const response = await messenger.sendTextMessage({id: '<ID>', text: 'Hello'})
  console.log(response)
} catch (e) {
  console.error(e)
}

No push Example

const FBMessenger = require('fb-messenger')
const messenger = new FBMessenger({token: '<YOUR TOKEN>'})

messenger.sendTextMessage({id: '<ID>', text: 'Hello', notificationType: 'NO_PUSH'})

Default to silent push Example

const FBMessenger = require('fb-messenger')
const messenger = new FBMessenger({token: '<YOUR TOKEN>', notificationType: 'SILENT_PUSH'})

Complete Example

const FBMessenger = require('fb-messenger')
const messenger = new FBMessenger({token: '<YOUR TOKEN>', notificationType: 'NO_PUSH'})

try {
  await messenger.sendTextMessage({id: '<ID>', text: 'Hello'}) // Send a message with NO_PUSH, ignoring response
  console.log('Sent successfully')
} catch(e) {
  console.error(e)
}

// Send an image overriding default notification type with callback
try {
  const response = await messenger.sendImageMessage({id: '<ID>', url: '<IMG URL>', notificationType: 'REGULAR'})
  console.log('Sent image, response:')
  console.dir(response)
} catch(e) {
  console.error(e)
}

messenger.sendTextMessage({id: '<ID>', text: 'Hello', token: '<YOUR OTHER TOKEN>'}) // Send message on another page

License

node-fb-messenger's People

Contributors

Stargazers

Watchers

Forkers

abdulhannanali jrschumacher jhliberty obinsc aliangliang weburnit paulogr micnews suresh-shinde-engineer modestworks isyiwang ramisha hsbhathiya royalgarter ebarahona agathaftrindade kathyliz williammajanja-zz jasonmcz nicolasembleton maxpastor kigengilbert paim-comunicacao elvitucho gedeagas rajanpn kerjasekolah ttam dark5eid83 kbmanikanta damyantjain ngxson ericchanky dowzhong yotro smtomj radumpopescu muaytoma webpropopuli erkiran kneelib hitory243 halopotto rgasox wpead shaogx jyyan goupviet

node-fb-messenger's Issues

Tag support to send message outside the 24-hour window

As per title, it would be great to set the tag on sending messages.
More info https://developers.facebook.com/docs/messenger-platform/send-messages/message-tags
Thanks

Any way to access JSON sent to Facebook

I have a basic app that:

takes a message via a REST API
relays that message to Facebook Messenger using your wonderful library
returns a response via the same REST API

The problem I'm running in to is that in step 3 I'd like to return the JSON sent to Facebook Messenger, so that a QA script can hit my API and verify that the incoming message resulted in the correct outgoing message to Facebook ... but there is currently no way to access the request. It's created inside the various send* methods, then passed to sendRequest which sends it off to Facebook without exposing it in any way.

Could you please expose the request, or at least req.json? It sees to me that the simplest way to do this would be to change line 187 from:

    cb(null, body);

to:

    cb(null, body, req);

However, that only gives you the request after the response comes back. What would truly be ideal, in my opinion, is if sendRequest could simply return the req, and every send* method returned the result of sendRequest ...

sendTextMessage (id, text, notificationType, cb) {
  const messageData = {
    text: text
  }
  return this.sendMessage(id, messageData, notificationType, cb)
}

const sendRequest = (req, cb) => {
  request(req, (err, res, body) => {
    if (!cb) return
    if (err) return cb(err)
    if (body.error) return cb(body.error)
    cb(null, body)
  })
  return req;
}

Could you please consider implementing one of these ways (or some alternative way) to expose the request object?

Cannot build persistent menu

My code:

messenger.setPersistentMenu({
    pageId: app.get('page_id'),
    menuItems: [{
        type: "postback",
        title: "Talk to an agent",
        payload: "CARE_HELP"
    },
    {
        type: "postback",
        title: "Outfit suggestions",
        payload: "CURATION"
    },
    {
        type: "web_url",
        title: "Shop now",
        url: "https://3000-c5d48a10-3ffd-4635-b0e9-36c6e897295d.ws-us02.gitpod.io/",
        webview_height_ratio: "full"
    }],
    // token: app.get('admin_token')
})
    .then(console.log)
    .catch(console.log)

It throw Error

{
  error: {
    message: '(#200) User does not have sufficient administrative permission for this action on this page. If the page business requires Two Factor Authentication, the user also needs to enable Two Factor Authentication.',
    type: 'OAuthException',
    code: 200,
    fbtrace_id: 'ADYHrfkOhmngibbxuEQclAr'
  }
}

Unsupported post request. Object with ID \'me\' does not exist, cannot be loaded due to missing permissions

I use token EAAA full permission??? what happen??

When I try to get Profile receiving error "Service temporarily unavailable"

Hi,

Today I got a issue, every time when I try to get profile I receive this erro "Service temporarily unavailable"

facebook error: { message: '(#2) Service temporarily unavailable',
type: 'OAuthException',
is_transient: true,
code: 2,
fbtrace_id: 'H58BCfKkfuO' }

I don't know why.. but it happen every time

Related to token and ID

The token specified for sending msg is it Users token Right???
And ID is msg receivers id is it right?
But i got an error like this

Try Users token:

{ message: 'Unsupported post request. Object with ID 'me' does not exist, cannot be loaded due to missing permissions, or does not support this operation. Please read the Graph API documentation at https://developers.facebook.com/docs/graph-api',
type: 'GraphMethodException',
code: 100,
fbtrace_id: 'B69oYdvdIH3' }

Try page token I got this:

Error: { message: '(#100) No matching user found',
type: 'OAuthException',
code: 100,
fbtrace_id: 'HBjp0Pu1DOb' }

Why i got this error??

[IMPORTANT] No updates for 0.0.x

SemVer caret for 0.0.x releases doesn¡t allow updates at all.

I just bumped to 0.1.x to allow minor updates as SemVer treats 0.x.y as 0.major.minor from 0.1.0

Please update to 0.1.x manually or use npm i --save [email protected] to get the latest version and receive the minor updates that will come soon!

Thank you

Any luck during sending list message?

i am trying to send with exact data
.sendListMessage but no luck could you guide me or send me working one?

Whitlisting domains

When sending links in cards the link as to be on the page's whitelist for the message to be sent.
Can you add a method for that? Or validate my request if I find time to write it ?

Unsupported post request. Object with ID \'me\' does not exist, cannot be loaded due to missing permissions,

message: 'Unsupported post request. Object with ID 'me' does not exist, cannot be loaded due to missing permissions, or does not support this operation. Please read the Graph API documentation at https://developers.facebook.com/docs/graph-api',
type: 'GraphMethodException',

Add receipt template message

unsupported post request

Permission for the User's Profile Information in a Messenger Bot should be implicitly granted "When a user begins a 1:1 thread with the bot for the first time".

My bot is still in sandbox mode (not sure if that is the issue), but with my own personal messenger account where I started the conversation with my bot -> my bot does not have access to my User Profile. It gets the following error:

{u'error': {u'message': u"Unsupported post request. Object with ID 'PAGE_SCOPED_USER_ID' does not exist, cannot be loaded due to missing permissions, or does not support this operation. Please read the Graph API documentation at https://developers.facebook.com/docs/graph-api", u'code': 100, u'type': u'GraphMethodException', u'fbtrace_id': u'Ev1G0M7KVxE', u'error_subcode': 33}}
Do you know why????

Thanks!