khushalps/api_utils_converse_v2
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

(20250121) With APIs to send, list, and update tags on WhatsApp messages (through Nimbus).

Browse Source
This commit is contained in:
khushal
2025-01-21 15:27:53 +05:30
parent f94d9e1a4b
commit cadbc19f28
13 changed files with 498 additions and 182 deletions
Download Patch File Download Diff File Expand all files Collapse all files
controllers_v2/message/chat/all_chat.py
+68 -7
View File
@@ -36,19 +36,24 @@ sys.path.append(".")
sys.path.append("..")
# My async utils:
from utils_v2.date_time import date_time
from utils_v2.database.async_mysql_v2 import AsyncMySQL
from utils_v2.database.async_mongo_v2 import AsyncMongo
from utils_v2.cache.async_redis_cache_v2 import AsyncRedisCache
# Controllers:
from controllers_v2.core.message import CoreMessageController
from controllers_v2.message.chat.base import ChatController
# Models:
from models.core.auth_token import CoreAuthTokenModel
from models.core.message import CoreMessageModel
from models.message.chat.send import (
NimbusWhatsAppMessage,
ChatSendOneResult,
ChatSendManyResults
)
# SMS Clients:
from utils_v2.sms.india.nimbus.controllers.async_nimbus import AsyncNimbusSMS
# Chat clients:
from utils_v2.whatsapp.nimbus.controllers.async_nimbus_whatsapp import AsyncNimbusWhatsapp
# To work with datatypes:
from typing import List, Any
@@ -56,8 +61,11 @@ from typing import List, Any
# To make HTTP requests:
import httpx
# For asynchronous activities:
import asyncio
# to work with MongoDB:
from bson.objectid import ObjectId
# To make abstract classes:
from abc import ABC, abstractmethod
# *****************************************************************************************************************
@@ -128,12 +136,65 @@ class AllChatController(ChatController):
cache = cache,
alert_url = alert_url,
http_client = http_client,
base_filter = {"client": "whatsappNimbus"},
base_filter = {},
debug = debug,
debug_prefix = debug_prefix,
debug_only_errors = debug_only_errors
)
# ┏┓ ┓ ┳┳┓
# ┗┓┏┓┏┓┏┫ ┃┃┃┏┓┏┏┏┓┏┓┏┓┏
# ┗┛┗ ┛┗┗┻ ┛ ┗┗ ┛┛┗┻┗┫┗ ┛
# ┛
async def send_one_message(
self,
sql_conn: AsyncMySQL,
mongo_data_conn: AsyncMongo,
auth_token: CoreAuthTokenModel,
client: AsyncNimbusWhatsapp,
message: NimbusWhatsAppMessage,
tags: List[Any]
) -> ChatSendOneResult:
"""
To send one message from the third-party client.
:param sql_conn: The connection to the database to use for this operation.
:param mongo_data_conn: The connection to the database to use for this operation.
:param auth_token: The auth-token model for the account from which the message has to be sent.
:param client: The connection/instance of the third-party client to use to perform this operation.
:param message: The message that you want to send to the recipient.
:param tags: Any tags that you would like to attach to the message. To be used later for internal filtering.
:return: The structured response model to describe the operation.
"""
raise NotImplementedError
async def send_many_messages(
self,
sql_conn: AsyncMySQL,
mongo_data_conn: AsyncMongo,
http_client: httpx.AsyncClient,
auth_token: CoreAuthTokenModel,
client: AsyncNimbusWhatsapp | None,
messages: List[NimbusWhatsAppMessage],
tags: List[Any]
) -> ChatSendManyResults:
"""
To send many chat messages in one go.
:param sql_conn: The connection to the database to use for this operation.
:param mongo_data_conn: The connection to the database to use for this operation.
:param http_client: An HTTP client to use to make API calls through the third-party client's class.
:param auth_token: The auth-token model for the account from which the message has to be sent.
:param client: The connection/instance of the third-party client to use to perform this operation.
:param messages: The messages that you want to send to the recipients.
:param tags: Any tags that you would like to attach to the message. To be used later for internal filtering.
:return: The structured response model to describe the operation.
"""
raise NotImplementedError
# *****************************************************************************************************************
# ***** ****
controllers_v2/message/chat/base.py
+99 -9
View File
@@ -36,6 +36,7 @@ sys.path.append(".")
sys.path.append("..")
# My async utils:
from utils_v2.database.async_mysql_v2 import AsyncMySQL
from utils_v2.database.async_mongo_v2 import AsyncMongo
from utils_v2.cache.async_redis_cache_v2 import AsyncRedisCache
@@ -44,16 +45,14 @@ from controllers_v2.core.message import CoreMessageController
# Models:
from models.core.auth_token import CoreAuthTokenModel
from models.api.message.sms.send import (
NimbusSMSIndiaMessage,
SavvyBulkSMSKenyaMessage,
SMSSendOneResult,
SMSSendManyResults
from models.message.chat.send import (
NimbusWhatsAppMessage,
ChatSendOneResult,
ChatSendManyResults
)
# SMS clients:
from utils_v2.sms.india.nimbus.controllers.async_nimbus import AsyncNimbusSMS
from utils_v2.sms.kenya.savvy_bulk_sms.controllers.async_savvy_bulk_sms import AsyncSavvyBulkSMS
# Chat clients:
from utils_v2.whatsapp.nimbus.controllers.async_nimbus_whatsapp import AsyncNimbusWhatsapp
# To work with datatypes:
from typing import List, Any
@@ -61,6 +60,9 @@ from typing import List, Any
# To make HTTP requests:
import httpx
# to work with MongoDB:
from bson.objectid import ObjectId
# To make abstract classes:
from abc import ABC, abstractmethod
@@ -135,7 +137,7 @@ class ChatController(CoreMessageController, ABC):
# Prepare the combined base filter:
sms_filter = {}
for k, v in (base_filter or {}).items(): sms_filter[k] = v
sms_filter["serviceType"] = "sms"
sms_filter["serviceType"] = "chat"
# Invoke the parent's constructor:
CoreMessageController.__init__(
@@ -149,6 +151,94 @@ class ChatController(CoreMessageController, ABC):
debug_only_errors = debug_only_errors
)
# ┏┓ ┓ ┳┳┓
# ┗┓┏┓┏┓┏┫ ┃┃┃┏┓┏┏┏┓┏┓┏┓┏
# ┗┛┗ ┛┗┗┻ ┛ ┗┗ ┛┛┗┻┗┫┗ ┛
# ┛
@abstractmethod
async def send_one_message(
self,
sql_conn: AsyncMySQL,
mongo_data_conn: AsyncMongo,
auth_token: CoreAuthTokenModel,
client: AsyncNimbusWhatsapp,
message: NimbusWhatsAppMessage,
tags: List[Any]
) -> ChatSendOneResult:
"""
To send one message from the third-party client.
:param sql_conn: The connection to the database to use for this operation.
:param mongo_data_conn: The connection to the database to use for this operation.
:param auth_token: The auth-token model for the account from which the message has to be sent.
:param client: The connection/instance of the third-party client to use to perform this operation.
:param message: The message that you want to send to the recipient.
:param tags: Any tags that you would like to attach to the message. To be used later for internal filtering.
:return: The structured response model to describe the operation.
"""
pass
@abstractmethod
async def send_many_messages(
self,
sql_conn: AsyncMySQL,
mongo_data_conn: AsyncMongo,
http_client: httpx.AsyncClient,
auth_token: CoreAuthTokenModel,
client: AsyncNimbusWhatsapp | None,
messages: List[NimbusWhatsAppMessage],
tags: List[Any]
) -> ChatSendManyResults:
"""
To send many chat messages in one go.
:param sql_conn: The connection to the database to use for this operation.
:param mongo_data_conn: The connection to the database to use for this operation.
:param http_client: An HTTP client to use to make API calls through the third-party client's class.
:param auth_token: The auth-token model for the account from which the message has to be sent.
:param client: The connection/instance of the third-party client to use to perform this operation.
:param messages: The messages that you want to send to the recipients.
:param tags: Any tags that you would like to attach to the message. To be used later for internal filtering.
:return: The structured response model to describe the operation.
"""
pass
# ┳┳ ┓ ┏┳┓
# ┃┃┏┓┏┫┏┓╋┏┓ ┃ ┏┓┏┓┏
# ┗┛┣┛┗┻┗┻┗┗ ┻ ┗┻┗┫┛
# ┛ ┛
# We cannot modify the SMS messages themselves, but we can set/unset tags on them for internal referencing and
# filtering. This will help the users organize their inboxes well.
async def update_chat_message_tags(
self,
mongo_data_conn: AsyncMongo,
message_id: ObjectId | str,
unset_tags: List[str] = None,
set_tags: List[str] = None
) -> bool:
"""
To set and unset tags on one chat message.
:param mongo_data_conn: The database connection to use to perform this action.
:param message_id: The ObjectId of the document in MongoDb that holds the message.
:param unset_tags: The list of tags to unset (done before setting new tags).
:param set_tags: The list of tags to set (done after unsetting old tags).
:return: True if successful, else False.
"""
# Simply call the core model:
return await self.update_message_tags(
mongo_data_conn = mongo_data_conn,
message_id = message_id,
unset_tags = unset_tags,
set_tags = set_tags
)
# *****************************************************************************************************************
# ***** ****
controllers_v2/message/chat/whatsapp_nimbus.py
+138 -2
View File
@@ -37,6 +37,7 @@ sys.path.append("..")
# My async utils:
from utils_v2.date_time import date_time
from utils_v2.database.async_mysql_v2 import AsyncMySQL
from utils_v2.database.async_mongo_v2 import AsyncMongo
from utils_v2.cache.async_redis_cache_v2 import AsyncRedisCache
@@ -46,9 +47,14 @@ from controllers_v2.message.chat.base import ChatController
# Models:
from models.core.auth_token import CoreAuthTokenModel
from models.core.message import CoreMessageModel
from models.message.chat.send import (
NimbusWhatsAppMessage,
ChatSendOneResult,
ChatSendManyResults
)
# SMS Clients:
from utils_v2.sms.india.nimbus.controllers.async_nimbus import AsyncNimbusSMS
# Chat clients:
from utils_v2.whatsapp.nimbus.controllers.async_nimbus_whatsapp import AsyncNimbusWhatsapp
# To work with datatypes:
from typing import List, Any
@@ -134,6 +140,136 @@ class WhatsAppNimbusController(ChatController):
debug_only_errors = debug_only_errors
)
# ┏┓ ┓ ┳┳┓
# ┗┓┏┓┏┓┏┫ ┃┃┃┏┓┏┏┏┓┏┓┏┓┏
# ┗┛┗ ┛┗┗┻ ┛ ┗┗ ┛┛┗┻┗┫┗ ┛
# ┛
async def send_one_message(
self,
sql_conn: AsyncMySQL,
mongo_data_conn: AsyncMongo,
auth_token: CoreAuthTokenModel,
client: AsyncNimbusWhatsapp,
message: NimbusWhatsAppMessage,
tags: List[Any]
) -> ChatSendOneResult:
"""
To send one message from the third-party client.
:param sql_conn: The connection to the database to use for this operation.
:param mongo_data_conn: The connection to the database to use for this operation.
:param auth_token: The auth-token model for the account from which the message has to be sent.
:param client: The connection/instance of the third-party client to use to perform this operation.
:param message: The message that you want to send to the recipient.
:param tags: Any tags that you would like to attach to the message. To be used later for internal filtering.
:return: The structured response model to describe the operation.
"""
# Send the SMS:
client_response = await client.send_whatsapp(
recipient_number = message.recipientNo,
message = message.message,
pdf_url = message.pdfUrl,
image_0_url = message.image0Url,
image_1_url = message.image1Url,
schedule_on = message.scheduleTs
)
# Convert the format of the SMS client's response to the core message model.
sent_message_model = CoreMessageModel(
ts = client_response.ts,
syncTs = date_time.get_current_utc_date_time(as_string = False),
tokenId = auth_token.authTokenId,
serviceType = auth_token.serviceType,
client = auth_token.client,
clientMessageId = client_response.requestId,
clientThreadId = message.recipientNo,
isSent = True,
isBroadcast = False,
sentSuccessfully = client_response.success,
sender = auth_token.clientUserId["senderId"],
recipient = message.recipientNo,
chat = message.recipientNo,
message = client_response.model_dump(),
snippet = message.message,
aiSnippet = None,
tags = list(set(tags + ["Chat", "Nimbus", "WhatsApp"]))
)
# Save the result to the database:
message_id = await self.save_one_message(
mongo_data_conn = mongo_data_conn,
message = sent_message_model
)
self._printer(message_id, client_response.success)
# Done here:
success = True if client_response.success and message_id else False
return ChatSendOneResult(
success = success,
message = "Message sent successfully." if client_response.success else "Message sending failed.",
chatMessage = sent_message_model
)
async def send_many_messages(
self,
sql_conn: AsyncMySQL,
mongo_data_conn: AsyncMongo,
http_client: httpx.AsyncClient,
auth_token: CoreAuthTokenModel,
client: AsyncNimbusWhatsapp | None,
messages: List[NimbusWhatsAppMessage],
tags: List[Any]
) -> ChatSendManyResults:
"""
To send many chat messages in one go.
:param sql_conn: The connection to the database to use for this operation.
:param mongo_data_conn: The connection to the database to use for this operation.
:param http_client: An HTTP client to use to make API calls through the third-party client's class.
:param auth_token: The auth-token model for the account from which the message has to be sent.
:param client: The connection/instance of the third-party client to use to perform this operation.
:param messages: The messages that you want to send to the recipients.
:param tags: Any tags that you would like to attach to the message. To be used later for internal filtering.
:return: The structured response model to describe the operation.
"""
# Start with a blank variable:
cumulative_results = ChatSendManyResults()
# Make the client from the auth-token:
client = client or AsyncNimbusWhatsapp(
api_key = auth_token.auth["apiKey"],
http_client = self._http_client,
debug = False
)
# Create and fire all the message-sending tasks:
tasks = [
self.send_one_message(
sql_conn = sql_conn,
mongo_data_conn = mongo_data_conn,
auth_token = auth_token,
client = client,
message = message,
tags = tags
)
for message in messages
]
individual_results = await asyncio.gather(*tasks)
# Prepare the final result:
for result in individual_results:
if result.success: cumulative_results.successCount += 1
else: cumulative_results.failureCount += 1
cumulative_results.totalCount += 1
cumulative_results.chatMessages.append(result.chatMessage)
cumulative_results.message = f"{cumulative_results.successCount}/{cumulative_results.totalCount} messgae(s) sent."
# Done here:
return cumulative_results
# *****************************************************************************************************************
# ***** ****