Sending messages through One Chat API
Project description
OneChat Python Library Documentation
Overview
The OneChat Python library provides an interface for sending messages, broadcasting messages to multiple users, sending location information, and sending stickers through the OneChat API.
Features
- Send Messages: Send messages to individual users or groups.
- Broadcast Messages: Send messages to multiple recipients at once.
- Send Locations: Share geographical locations with users.
- Send Stickers: Send sticker messages to users.
- Get Friends and Groups: Get a list of friends and groups.
- Get All Friends: Get a list of all friends.
- Get One ID of Friend: Get the One ID of a friend.
- Get All Groups: Get a list of all groups.
- Get Group ID of Group: Get the group ID of a group.
Installation
To install the OneChat Python library, run the following command
pip install one-chat-api
Usage
To use the OneChat library, follow these steps
Import the Library
from one_chat import (
init,
send_message,
broadcast_message,
send_location,
send_sticker,
fetch_friends_and_groups,
list_all_friends,
list_friend_ids,
list_all_groups,
list_group_ids,
)
or you can import all functions at once
from one_chat import *
Initialize the Library
Before using the functions, you need to initialize the library with your authorization token, default recipient, and bot id
init(
"YOUR_AUTHORIZATION_TOKEN", # Replace with your token
"DEFAULT_RECIPIENT_ID", # Replace with user ID or group ID
"YOUR_BOT_ID" # Replace with your bot ID
)
Send Messages
You can send a message to a specific user or group
response = send_message(message="Hello One!")
print("Send Message response:", response)
Broadcast Messages
To send a message to multiple recipients
[!IMPORTANT] recipients must be a list of user IDs only !!! cannot be a group ID
response = broadcast_message(message="Hello Multi!", to=["USER_ID_1", "USER_ID_2"])
print("Send Message Multi response:", response)
Send Locations
To share a location
response = send_location(latitude=13.7563, longitude=100.5018, address="Bangkok, Thailand")
print("Send Location Response:", response)
Send Stickers
To send a sticker
response = send_sticker(sticker_id="YOUR_STICKER_ID")
print("Send Sticker Response:", response)
Example
Here’s a complete example of how to use the library
from one_chat import *
def main():
# Initialize OneChat with your token, recipient, and bot ID
init(
"YOUR_AUTHORIZATION_TOKEN",
"DEFAULT_RECIPIENT_ID", # Send to (One ID) or (Group ID)
"YOUR_BOT_ID" # Bot ID
)
# Send a single message
resp_msg = send_message(message="Hello One!")
print("Send Message response:", resp_msg)
# Broadcast a message to multiple users
resp_msg_multi = broadcast_message(message="Hello Multi!", to=["USER_ID_1", "USER_ID_2"])
print("Send Message Multi response:", resp_msg_multi)
# Send a location
resp_location = send_location(latitude=13.7563, longitude=100.5018, address="Bangkok, Thailand")
print("Send Location Response:", resp_location)
# Send a sticker
resp_sticker = send_sticker(sticker_id="YOUR_STICKER_ID")
print("Send Sticker Response:", resp_sticker)
# Get a list of friends and groups
friends_and_groups = fetch_friends_and_groups() # you can use fetch_friends_and_groups("BOT_ID") to get friends and groups of another bot
print("Friends and Groups:", friends_and_groups)
# Get a list of friends
friends = list_all_friends() # you can use list_all_friends("BOT_ID") to get friends of another bot
print("Friends:", friends)
# Get the One ID of a friend
one_id = list_friend_ids() # you can use list_friend_ids("BOT_ID") to get one id of a friend of another bot
print("One ID of Friend:", one_id)
# Get a list of groups
groups = list_all_groups() # you can use list_all_groups("BOT_ID") to get groups of another bot
print("Groups:", groups)
# Get the group ID of a group
group_id = list_group_ids() # you can use list_group_ids("BOT_ID") to get group id of a group of another bot
print("Group ID of Group:", group_id)
if __name__ == "__main__":
main()
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for one_chat_api-0.2.10-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6ffc08cf1306338dfc9d60ac2ba1c5281a5bb59a25fe1711a38a572fc791ad27 |
|
MD5 | 5ab58c657913e3ff1e8d07482655d755 |
|
BLAKE2b-256 | 8d60f3b034fe31e1d0d1f2ca0923b307d7320b56ada52efa384c725074e02f34 |