Find file History
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
..
Failed to load latest commit information.
lib fix observable errors Sep 11, 2017
src fix observable errors Sep 11, 2017
.npmignore re-org the repo (#52) Feb 7, 2017
LICENCE.md re-org the repo (#52) Feb 7, 2017
README.md
package.json bump minor versions Sep 11, 2017
yarn.lock refactor(all): replace node-uuid with uuid Jul 15, 2017

README.md

npm node deps tests bithound bithoundscore nsp-checked

Broid Telegram 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 slackin

Message types supported

Simple Image Video Buttons Location Phone number

Location, Phone number are platform limitations.

Getting started

Install

npm install --save @broid/telegram

Connect to Telegram

const BroidTelegram = require('@broid/telegram');

const telegram = new BroidTelegram({
  token: "<api_key>",
  webhookURL: "http://127.0.0.1",
  http: {
    host: "127.0.0.1",
    port: 8080
  }
});

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

Telegram can also be used with your existing express setup.

const BroidTelegram = require('@broid/telegram');
const express = require("express");

const telegram = new BroidTelegram({
  token: "<api_key>",
  webhookURL: "http://127.0.0.1"
});

const app = express();
app.use("/telegram", telegram.getRouter());

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

app.listen(8080);

Options available

name Type default Description
serviceID string random Arbitrary identifier of the running instance
logLevel string info Can be : fatal, error, warn, info, debug, trace
token string Your API Key
http object { "port": 8080, "http": "0.0.0.0", "webhookURL": "127.0.0.1" } WebServer options (host, port, webhookURL)

Receive a message

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

Buttons supported

mediaType Action types Content of value property
text/html redirect URL to be opened in the built-in browser.
postback Text of message which client will sent back as ordinary chat message.

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": "telegram"
  },
  "object": {
    "type": "Note",
    "content": "hello world"
  },
  "to": {
    "type": "Person",
    "id": "43418004"
  }
};

telegram.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) 2016-2017 Broid.ai

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