2.3.2 • Published 3 years ago

@sava.team/broid-messenger v2.3.2

Weekly downloads
-
License
AGPL-3.0+
Repository
github
Last release
3 years ago

npm node deps tests nsp-checked

Build

Broid Messenger Integration

Broid Integrations is an open source project providing a suite of Activity Streams 2 libraries for unified communications among a vast number of communication platforms.

Connect your App to Multiple Messaging Channels with One OpenSource Language.

gitter site

Message types supported

SimpleImageVideoButtonsDocumentLocation
ActivityPhone numberCollection

Phone number is platform limitation.

Getting started

Install

npm install --save @sava.team/broid-messenger

Connect to Messenger

const BroidMessenger = require('@sava.team/broid-messenger');

const messenger = new broidMessenger({
  token: "<oauth_token>",
  tokenSecret: "<verify_token>",
  http: {
    port: 8080,
    host: "0.0.0.0"
  }
});

messenger.connect()
  .subscribe({
    next: data => console.log(data),
    error: err => console.error(`Something went wrong: ${err.message}`),
    complete: () => console.log('complete'),
  });

Options available

nameTypedefaultDescription
serviceIDstringrandomArbitrary identifier of the running instance
logLevelstringinfoCan be : fatal, error, warn, info, debug, trace
tokenstringYour application token
tokenSecretstringYour auth verify token (hub.verify_token)
consumerSecretstringYou App Secret to validate all requests
httpobjectWebServer options (host, port)

Receive a message

messenger.listen()
  .subscribe({
    next: data => console.log(`Received message: ${data}`),
    error: err => console.error(`Something went wrong: ${err.message}`),
    complete: () => console.log('complete'),
  });

Buttons supported

mediaTypeAction typesContent of value property
text/htmlweb_urlURL to be opened in the built-in browser.
application/vnd.geo+jsonlocationAsk for the user location.
audio/telephone-eventphone_numberDestination for a call in following format: "tel:123123123123".
postbackText of message which client will sent back as ordinary chat message.

Quick replies

To send quick replies, button need to contains mediaType value "text/plain"

Example:

{
  "@context": "https://www.w3.org/ns/activitystreams",
  "type": "Create",
  "generator": {
    "id": "f6e92eb6-f69e-4eae-8158-06613461cf3a",
    "type": "Service",
    "name": "messenger"
  },
  "object": {
    "type": "Note",
    "content": "Simple example with quickreplies",
    "attachment": [
      {
        "content": "Broid",
        "mediaType": "text/plain",
        "name": "broid",
        "type": "Button",
        "url": "broid_payload"
      }      
    ]
  },
  "to": {
    "type": "Person",
    "id": "1396343657196792"
  }
}

Sender Actions or Activity

contentAction types
typing/ontyping_onTurn typing indicators on
typing/offtyping_offTurn typing indicators off
typing/offmark_seenMark last message as read

Example of turning typing indicators on with

{
  "@context": "https://www.w3.org/ns/activitystreams",
  "type": "Create",
  "generator": {
    "id": "f6e92eb6-f69e-4eae-8158-06613461cf3a",
    "type": "Service",
    "name": "messenger"
  },
  "object": {
    "type": "Activity",
    "content": "typing/on"
  },
  "to": {
    "type": "Person",
    "id": "1396343657196792"
  }
}

Not supported yet

Action typesContent of value property
element_shareOpen a share dialog in Messenger.
paymentOpens a checkout dialog to enables purchases.
account_linkSync the user account.
account_unlinkUn sync the user account.

Post a message

To send a message, the format should use the broid-schemas.

const formatted_message = {
  "@context": "https://www.w3.org/ns/activitystreams",
  "type": "Create",
  "generator": {
    "id": "f6e92eb6-f69e-4eae-8158-06613461cf3a",
    "type": "Service",
    "name": "messenger"
  },
  "object": {
    "type": "Note",
    "content": "hello world"
  },
  "to": {
    "type": "Person",
    "id": "1396343657196792"
  }
};

messenger.send(formatted_message)
  .then(() => console.log("ok"))
  .catch(err => console.error(err));

Examples of messages

You can find examples of sent and received messages at Broid-Schemas.

Contributing to Broid

See CONTRIBUTE.md

Copyright & License

Copyright (c) 2020 SaVa.Team

This project is licensed under the AGPL 3, which can be found here.