Skip to content

armgit / camel

Public Imported from GitHub
0

🐫 CAMEL: The first and the best multi-agent framework. Finding the Scaling Law of Agents. https://www.camel-ai.org

feat: add lark_send_message (#3688)

Tao Sun64e16cb2bd69
diff --git a/camel/toolkits/lark_toolkit.py b/camel/toolkits/lark_toolkit.py
index 423d7c447..8cea57568 100644
--- a/camel/toolkits/lark_toolkit.py
+++ b/camel/toolkits/lark_toolkit.py
@@ -356,6 +356,72 @@ class LarkToolkit(BaseToolkit):
logger.error(f"Error getting chat messages: {e}")
return {"error": f"Error getting chat messages: {e!s}"}
+ def lark_send_message(
+ self,
+ receive_id: str,
+ text: str,
+ receive_id_type: Literal[
+ "open_id", "user_id", "union_id", "email", "chat_id"
+ ] = "chat_id",
+ ) -> Dict[str, object]:
+ r"""Sends a message to a user or chat. If send message to
+ a chat, use lark_list_chats to get chat_id first, if send
+ message to a user, need user provide open_id, user_id,
+ union_id or email.
+
+ Args:
+ receive_id (str): The recipient identifier.
+ text (str): The text message content.
+ receive_id_type (str): The recipient ID type. Options:
+ - "open_id"
+ - "user_id"
+ - "union_id"
+ - "email"
+ - "chat_id" (default)
+
+ Returns:
+ Dict[str, object]: A dictionary containing:
+ - message_id: The sent message ID
+ - chat_id: The chat ID the message belongs to
+ - msg_type: Message type (text)
+ """
+ # NOTE: Currently supports plain text messages only.
+ try:
+ url = f"{self._domain}/open-apis/im/v1/messages"
+ headers = self._get_tenant_http_headers()
+ params = {"receive_id_type": receive_id_type}
+ payload = {
+ "receive_id": receive_id,
+ "msg_type": "text",
+ "content": json.dumps({"text": text}),
+ }
+
+ response = requests.post(
+ url, headers=headers, params=params, json=payload, timeout=30
+ )
+ result = response.json()
+
+ if result.get("code") != 0:
+ logger.error(
+ f"Failed to send message: {result.get('code')} - "
+ f"{result.get('msg')}"
+ )
+ return {
+ "error": f"Failed to send message: {result.get('msg')}",
+ "code": result.get("code"),
+ }
+
+ data = result.get("data", {}) or {}
+ return {
+ "message_id": data.get("message_id"),
+ "chat_id": data.get("chat_id"),
+ "msg_type": data.get("msg_type"),
+ }
+
+ except Exception as e:
+ logger.error(f"Error sending message: {e}")
+ return {"error": f"Error sending message: {e!s}"}
+
def lark_get_message_resource(
self,
message_id: str,
@@ -507,6 +573,7 @@ class LarkToolkit(BaseToolkit):
return [
FunctionTool(self.lark_list_chats),
FunctionTool(self.lark_get_chat_messages),
+ FunctionTool(self.lark_send_message),
FunctionTool(self.lark_get_message_resource),
FunctionTool(self.lark_get_message_resource_key),
]
diff --git a/examples/toolkits/lark_toolkit_example.py b/examples/toolkits/lark_toolkit_example.py
index 732af9909..3be094daf 100644
--- a/examples/toolkits/lark_toolkit_example.py
+++ b/examples/toolkits/lark_toolkit_example.py
@@ -64,9 +64,17 @@ response = agent.step(
)
print(f"Response: {response.msgs[0].content}\n")
-# Example 4: Direct toolkit usage (without agent)
+# Example 4: Send a message to chat
print("=" * 60)
-print("Example 4: Direct toolkit usage")
+print("Example 4: Send a message to chat")
+print("=" * 60)
+
+response = agent.step("Say hi to my first chat ")
+print(f"Response: {response.msgs[0].content}\n")
+
+# Example 5: Direct toolkit usage (without agent)
+print("=" * 60)
+print("Example 5: Direct toolkit usage")
print("=" * 60)
# List chats directly
diff --git a/test/toolkits/test_lark_toolkit.py b/test/toolkits/test_lark_toolkit.py
index dd19516e1..fcd6aa6bf 100644
--- a/test/toolkits/test_lark_toolkit.py
+++ b/test/toolkits/test_lark_toolkit.py
@@ -11,8 +11,9 @@
# See the License for the specific language governing permissions and
# limitations under the License.
# ========= Copyright 2023-2026 @ CAMEL-AI.org. All Rights Reserved. =========
+import json
import os
-from unittest.mock import patch
+from unittest.mock import Mock, patch
import pytest
@@ -74,11 +75,12 @@ def test_lark_toolkit_init_with_feishu(mock_env_vars):
def test_lark_toolkit_get_tools(lark_toolkit):
"""Test only the expected tools are exposed."""
tools = lark_toolkit.get_tools()
- assert len(tools) == 4
+ assert len(tools) == 5
assert all(isinstance(tool, FunctionTool) for tool in tools)
assert [tool.func.__name__ for tool in tools] == [
"lark_list_chats",
"lark_get_chat_messages",
+ "lark_send_message",
"lark_get_message_resource",
"lark_get_message_resource_key",
]
@@ -169,6 +171,45 @@ def test_lark_get_chat_messages_time_filters(lark_toolkit):
assert params["sort_type"] == "ByCreateTimeAsc"
+def test_lark_send_message(lark_toolkit):
+ """Test sending a text message."""
+ with patch("requests.post") as mock_post:
+ tenant_response = Mock()
+ tenant_response.json.return_value = {
+ "code": 0,
+ "tenant_access_token": "token",
+ "expire": 7200,
+ }
+ send_response = Mock()
+ send_response.json.return_value = {
+ "code": 0,
+ "data": {
+ "message_id": "om_123",
+ "chat_id": "oc_456",
+ "msg_type": "text",
+ },
+ }
+ mock_post.side_effect = [tenant_response, send_response]
+
+ result = lark_toolkit.lark_send_message(
+ receive_id="oc_456",
+ text="test content",
+ receive_id_type="chat_id",
+ )
+
+ assert result["message_id"] == "om_123"
+ assert result["chat_id"] == "oc_456"
+ assert result["msg_type"] == "text"
+
+ call_args = mock_post.call_args_list[1]
+ params = call_args[1]["params"]
+ payload = call_args[1]["json"]
+ assert params["receive_id_type"] == "chat_id"
+ assert payload["receive_id"] == "oc_456"
+ assert payload["msg_type"] == "text"
+ assert payload["content"] == json.dumps({"text": "test content"})
+
+
def test_lark_get_message_resource(tmp_path, mock_env_vars):
"""Test downloading a message resource."""
from camel.toolkits import LarkToolkit