broid-telegram v1.1.4
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
Connect to Telegram
import broidTelegram from 'broid-telegram'
const telegram = new broidTelegram({
token: "<api_key>",
http: {
webhookURL: "http://127.0.0.1/"
}
})
telegram.connect()
.subscribe({
next: data => console.log(data),
error: err => console.error(`Something went wrong: ${err.message}`),
complete: () => console.log('complete'),
})
Options availables
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 message_formated = '...'
telegram.send(message_formated)
.then(() => console.log("ok"))
.catch(err => console.error(err))
Examples of messages
Message received
- A private message received from Sally
{
"@context": "https://www.w3.org/ns/activitystreams",
"published": 1483677146,
"type": "Create",
"generator": {
"id": "67c9cb10-8a74-42c8-ba55-294d0447cdf9",
"type": "Service",
"name": "telegram"
},
"actor": {
"id": "43418006",
"type": "Person",
"name": "sally2"
},
"target": {
"id": "43418006",
"type": "Person",
"name": "sally2"
},
"object": {
"type": "Note",
"id": "80",
"content": "Hello world"
}
}
- A message received from Sally
{
"@context": "https://www.w3.org/ns/activitystreams",
"published": 1483677146,
"type": "Create",
"generator": {
"id": "67c9cb10-8a74-42c8-ba55-294d0447cdf9",
"type": "Service",
"name": "telegram"
},
"actor": {
"id": "43418006",
"type": "Person",
"name": "sally2"
},
"target": {
"id": "-199586965",
"name": "test",
"type": "Group"
},
"object": {
"type": "Note",
"id": "80",
"content": "Hello world"
}
}
- A video/image received from Sally
{
"@context": "https://www.w3.org/ns/activitystreams",
"published": 1483677146,
"type": "Create",
"generator": {
"id": "67c9cb10-8a74-42c8-ba55-294d0447cdf9",
"type": "Service",
"name": "telegram"
},
"actor": {
"id": "43418006",
"type": "Person",
"name": "sally2"
},
"target": {
"id": "-199586965",
"name": "test",
"type": "Group"
},
"object": {
"id": "81",
"mediaType": "image/jpeg",
"name": "african-elephant-standing_9033_600x450.jpg",
"type": "Image",
"url": "http://images.nationalgeographic.com/wpf/media-live/photos/000/090/cache/african-elephant-standing_9033_600x450.jpg"
}
}
- A quick reply callback received.
{
"@context": "https://www.w3.org/ns/activitystreams",
"generator": {
"id": "939863d7-cdf5-4b46-adad-cb430c5bd133",
"name": "telegram",
"type": "Service"
},
"published": 1483920,
"type": "Create",
"actor": {
"id": "43418006",
"type": "Person",
"name": "sally2"
},
"target": {
"id": "-199636965",
"name": "test",
"type": "Group"
},
"object": {
"content": "DEVELOPER_DEFINED_PAYLOAD_FOR_PICKING_GREEN",
"id": "186478908178746874",
"type": "Note",
"context": {
"content": "6557728837267605745",
"name": "chat_instance",
"type": "Object"
}
}
}
Send a message
- Send a simple 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"
}
}
- Send a message with quick reply buttons
{
"@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",
"attachment": [
{
"type": "Button",
"name": "Green",
"url": "PAYLOAD_GREEN",
},
{
"type": "Button",
"mediaType": "text/html",
"name": "Go to Broid website",
"url": "https://www.broid.ai",
}
]
},
"to": {
"type": "Person",
"id": "43418004"
}
}
- Send a image
{
"@context": "https://www.w3.org/ns/activitystreams",
"type": "Create",
"generator": {
"id": "f6e92eb6-f69e-4eae-8158-06613461cf3a",
"type": "Service",
"name": "telegram"
},
"object": {
"type": "Image",
"content": "hello world",
"url": "https://www.broid.ai/images/fake.png"
},
"to": {
"type": "Person",
"id": "43418004"
}
}
Contributing to Broid
Broid is an open source project. Broid wouldn't be where it is now without contributions by the community. Please consider forking Broid to improve, enhance or fix issues. If you feel like the community will benefit from your fork, please open a pull request.
And because we want to do the better for you. Help us improving Broid by sharing your feedback on our Integrations GitHub Repo and let's build Broid together!
Code of Conduct
Make sure that you're read and understand the Code of Conduct.
Copyright & License
Copyright (c) 2016-2017 Broid.ai
This project is licensed under the AGPL 3, which can be found here.