beep-notifications 0.2.1

Email notifications are a thing of the past, send notifications to messengers

Beep

This library will help you integrate notifications and authorization via Telegram through our Beep platform.

Preparation

First, you must log into the developer panel on the official Beep website and create your project.

After that, you must copy the ID of your project. It serves as a token, so be careful and keep it secret.

Library usage

Install

Install this library using

pip install beep-notifications

Connecting to the project

Using your project_id create BeepNotify instance.

from beep_notifications import BeepNotify

beep = BeepNotify('some_project_id')

Creating link code

Use get_link_code() method to get link code for your project.

link_code = beep.get_link_code()

Checking link code status

Use check_link_code(code) method to check link code status. It returns accepted, beep_code, username.

accepted, beep_code, username = beep.check_link_code("12345")

Checking is user a subscriber

Use check_subscription(user_iden) method to check if user is subscribed to your project to be able to get notifications from it. user_iden can be a username or a Beep code.

subscribed = beep.check_subscription("spiritedRaisins6")

Sending notifications

Use send_notification(title, body, username) method to send notifications.

Using username as receiver identification

beep.send_notification("Hello", "I SAID HELLOOOOO", "spiritedRaisins6")

Using Beep code as receiver identification

beep.send_notification("Hello", "I SAID HELLOOOOO", "665123731")

Sending auth code

Use send_auth_code(user_iden) method to send auth code to user, user_iden can be a username or a Beep code.

beep.send_auth_code("spiritedRaisins6")

Try to authenticate user with auth code

Use get_token(user_iden, auth_code) method to user authentication, user_iden can be a username or a Beep code.

token = beep.get_token("spiritedRaisins6", "1234")

Validate a token

Use validate_token(token, uac) method to validate a token, uac is 'username_as_code', if uac is True, then return a username of the token owner, else Beep code. This method returns 3 values: validation_result, user_iden and error.

res, user, errpr = beep.validate_token("some_token", uac=True)

Contact me!

Beep Telegram Chat
X / Twitter
Email [e-mail]
Telegram