File size: 6,326 Bytes
62da328 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 |
# ========= Copyright 2023-2024 @ CAMEL-AI.org. All Rights Reserved. =========
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# ========= Copyright 2023-2024 @ CAMEL-AI.org. All Rights Reserved. =========
import os
from typing import Any, Dict, List, Union
import requests
from camel.toolkits import FunctionTool
from camel.toolkits.base import BaseToolkit
from camel.utils.commons import retry_request
class WhatsAppToolkit(BaseToolkit):
r"""A class representing a toolkit for WhatsApp operations.
This toolkit provides methods to interact with the WhatsApp Business API,
allowing users to send messages, retrieve message templates, and get
business profile information.
Attributes:
retries (int): Number of retries for API requests in case of failure.
delay (int): Delay between retries in seconds.
base_url (str): Base URL for the WhatsApp Business API.
version (str): API version.
"""
def __init__(self, retries: int = 3, delay: int = 1):
r"""Initializes the WhatsAppToolkit with the specified number of
retries and delay.
Args:
retries (int): Number of times to retry the request in case of
failure. (default: :obj:`3`)
delay (int): Time in seconds to wait between retries.
(default: :obj:`1`)
"""
self.retries = retries
self.delay = delay
self.base_url = "https://graph.facebook.com"
self.version = "v17.0"
self.access_token = os.environ.get("WHATSAPP_ACCESS_TOKEN", "")
self.phone_number_id = os.environ.get("WHATSAPP_PHONE_NUMBER_ID", "")
if not all([self.access_token, self.phone_number_id]):
raise ValueError(
"WhatsApp API credentials are not set. "
"Please set the WHATSAPP_ACCESS_TOKEN and "
"WHATSAPP_PHONE_NUMBER_ID environment variables."
)
def send_message(
self, to: str, message: str
) -> Union[Dict[str, Any], str]:
r"""Sends a text message to a specified WhatsApp number.
Args:
to (str): The recipient's WhatsApp number in international format.
message (str): The text message to send.
Returns:
Union[Dict[str, Any], str]: A dictionary containing
the API response if successful, or an error message string if
failed.
"""
url = f"{self.base_url}/{self.version}/{self.phone_number_id}/messages"
headers = {
"Authorization": f"Bearer {self.access_token}",
"Content-Type": "application/json",
}
data = {
"messaging_product": "whatsapp",
"to": to,
"type": "text",
"text": {"body": message},
}
try:
response = retry_request(
requests.post,
retries=self.retries,
delay=self.delay,
url=url,
headers=headers,
json=data,
)
response.raise_for_status()
return response.json()
except Exception as e:
return f"Failed to send message: {e!s}"
def get_message_templates(self) -> Union[List[Dict[str, Any]], str]:
r"""Retrieves all message templates for the WhatsApp Business account.
Returns:
Union[List[Dict[str, Any]], str]: A list of dictionaries containing
template information if successful, or an error message string
if failed.
"""
url = (
f"{self.base_url}/{self.version}/{self.phone_number_id}"
"/message_templates"
)
headers = {"Authorization": f"Bearer {self.access_token}"}
try:
response = retry_request(
requests.get,
retries=self.retries,
delay=self.delay,
url=url,
headers=headers,
)
response.raise_for_status()
return response.json().get("data", [])
except Exception as e:
return f"Failed to retrieve message templates: {e!s}"
def get_business_profile(self) -> Union[Dict[str, Any], str]:
r"""Retrieves the WhatsApp Business profile information.
Returns:
Union[Dict[str, Any], str]: A dictionary containing the business
profile information if successful, or an error message string
if failed.
"""
url = (
f"{self.base_url}/{self.version}/{self.phone_number_id}"
"/whatsapp_business_profile"
)
headers = {"Authorization": f"Bearer {self.access_token}"}
params = {
"fields": (
"about,address,description,email,profile_picture_url,"
"websites,vertical"
)
}
try:
response = retry_request(
requests.get,
retries=self.retries,
delay=self.delay,
url=url,
headers=headers,
params=params,
)
response.raise_for_status()
return response.json()
except Exception as e:
return f"Failed to retrieve business profile: {e!s}"
def get_tools(self) -> List[FunctionTool]:
r"""Returns a list of FunctionTool objects representing the
functions in the toolkit.
Returns:
List[FunctionTool]: A list of FunctionTool objects for the
toolkit methods.
"""
return [
FunctionTool(self.send_message),
FunctionTool(self.get_message_templates),
FunctionTool(self.get_business_profile),
]
|