[npm]: https://img.shields.io/badge/npm-broid-green.svg?style=flat
[npm-url]: https://www.npmjs.com/org/broid

[node]: https://img.shields.io/node/v/@broid/telegram.svg
[node-url]: https://nodejs.org

[deps]: https://img.shields.io/badge/dependencies-checked-green.svg?style=flat
[deps-url]: #integrations

[tests]: https://img.shields.io/travis/broidHQ/integrations/master.svg
[tests-url]: https://travis-ci.org/broidHQ/integrations

[bithound]: https://img.shields.io/bithound/code/github/broidHQ/integrations.svg
[bithound-url]: https://www.bithound.io/github/broidHQ/integrations

[bithoundscore]: https://www.bithound.io/github/broidHQ/integrations/badges/score.svg
[bithoundscore-url]: https://www.bithound.io/github/broidHQ/integrations

[nsp-checked]: https://img.shields.io/badge/nsp-checked-green.svg?style=flat
[nsp-checked-url]: https://nodesecurity.io

[![npm][npm]][npm-url]
[![node][node]][node-url]
[![deps][deps]][deps-url]
[![tests][tests]][tests-url]
[![bithound][bithound]][bithound-url]
[![bithoundscore][bithoundscore]][bithoundscore-url]
[![nsp-checked][nsp-checked]][nsp-checked-url]

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.


Message types supported

| Simple | Image | Video | Buttons | Location | Phone number |
|:------:|:-----:|:-----:|:-------:|:--------:|:------------:|
| ✅ | ✅ | ✅ | ✅ | | |

_Location, Phone number are platform limitations._

Getting started

$3

``bash
npm install --save @broid/telegram
`

$3

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

const telegram = new BroidTelegram({
token: "",
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.

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

const telegram = new BroidTelegram({
token: "",
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) |

$3

`javascript
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. |

$3

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

`javascript
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.