Skip to content

A Bot that can send messages to your Plex Media Server API endpoints and return information about your media collection

Notifications You must be signed in to change notification settings

okbrown/plexserver-telegram-bot

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

34 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

#PlexBot ######Plex Media Server Telegram Bot

#####Provide your leechers with some helpful info on what content has been recently added to your Plex Media Server.

Using Telegram's Bot API, and Plex Media Server API you can bring them together to send messages to your Telegram Bot which will then make a call to your Local Plex Server's API, as a GET request, which has many different endpoints, the most useful being /recentlyAdded and newest . Please see Plex Web API Overview for more details on endpoints and what they do.

##Requirements You will obviously need the chat app (Android, iOS, Windows, and Desktop) to use Telegram and also you will need to create a bot.

Personal Note: if WhatsApp was not so 1990's when it came to messaging they would of thought about including some decent IRC, Slack, MSN style features to their app, but they didn't hence Telegram is simply the best chat app IMHO. Plus your contacts do not need to have your tel number in order for you to message you, you can use the @username option too. (BBM ¯_(ツ)_/¯ much better privacy.)

###This project At the moment this is still in testing/alpha state, and I has a few bugs to fix and features to add, and will do so as and when I get time.

In the mean time here is what you need to know:

  • Still need to add group chat and reply, just found out I didn't add it - Updated: (10/10/16) Will go through the documentation this week and see which method provides that.

  • The gulpfile-git.js that you see is to be renamed to just gulpfile.js the reason for this is because I use a different gulpfile that has a few more tasks I need to removes my plex server address and tokens from the project (rather than remember to delete it each time, i just run a gulp task) before I push it to github. If you need a copy of that task file let me know in case your interested.

  • I have tried to make it a little modular to start with so its easy to pick out what parts you need to add/replace, e.g. tokens etc.

  • Shout out to Yagop for https://www.npmjs.com/package/node-telegram-bot-api and also Gochomugo for https://www.npmjs.com/package/node-telegram-bot-api-latest for their NPM versions of node-telegram-bot-api this was very helpful in me not having to reinvent the wheel. Thanks.

##Installation

  • git clone https://github.com/okbrown/plexserver-telegram-bot target="_blank">repo
  • npm install or npm i (which ever you prefer)
  • gulp develop to start in dev mode
  • gulp prod to start normally

###Configuration

  • You will need to edit plex-config/index.js to reflect your PMS setup, e.g.your library locations and names will need to changed accordingly. See lines 11-14and 28 - 42 (view here) to see how its done. You will need to check out http://yourPMSserverAddress:32400/library/sections to get your library number root key. Simply look for the root folder library name you created and then the object key above it.

#####P.S: This is my first version https://github.com/okbrown/telegram-plexbot done in Python from my very first github account I barely used (i prefer bitbucket because the private repositories lol) might have some useful bits in there, who knows.

About

A Bot that can send messages to your Plex Media Server API endpoints and return information about your media collection

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published