Messaging Channels

Send messages across multiple platforms with PraisonAI channel tools

from praisonaiagents import Agent
from praisonai_tools import SignalTool

agent = Agent(name="Messenger", tools=[SignalTool()])
agent.start("Send a Signal message to +1234567890 saying hello")

The user sends a message through a channel; the agent delivers it via the configured messaging tool.

Quick Start

1. Simple Usage

   from praisonai_tools import SignalTool
   
   signal = SignalTool()
   signal.send_message(to="+1234567890", message="Hello!")

2. With Configuration

   from praisonai_tools import WhatsAppTool
   
   wa = WhatsAppTool()
   wa.send_message(to="+1234567890", message="Hello!")

Installation

pip install praisonai-tools

Signal

Setup

1. Install signal-cli REST API

   Run the signal-cli-rest-api Docker container:

   docker run -d --name signal-api -p 8080:8080 \
     -v signal-cli-config:/home/.local/share/signal-cli \
     bbernhard/signal-cli-rest-api

2. Link your device

   Visit http://localhost:8080/v1/qrcodelink?device_name=signal-api to link your Signal account.

3. Set environment variables

   export SIGNAL_CLI_URL=http://localhost:8080
   export SIGNAL_ACCOUNT=+1234567890

Usage

from praisonai_tools import SignalTool

signal = SignalTool()
result = signal.send_message(
    to="+1234567890",
    message="Hello from PraisonAI!"
)

from praisonaiagents import Agent
from praisonai_tools import SignalTool

agent = Agent(
    name="Notifier",
    tools=[SignalTool()]
)
agent.start("Send a Signal message to +1234567890 saying hello")

from praisonai_tools import SignalTool

signal = SignalTool()

# Send to group
signal.send_message(
    to="group:abc123xyz",
    message="Hello group!"
)

# List groups
groups = signal.list_groups()

Actions

LINE

Setup

1. Create LINE Channel

   Go to LINE Developers Console and create a Messaging API channel.

2. Get credentials

   Copy your Channel access token and Channel secret.

3. Set environment variables

   export LINE_CHANNEL_ACCESS_TOKEN=your_token
   export LINE_CHANNEL_SECRET=your_secret

Usage

from praisonai_tools import LineTool

line = LineTool()
result = line.push_message(
    to="user_id",
    message="Hello from PraisonAI!"
)

from praisonai_tools import LineTool

line = LineTool()
result = line.broadcast(message="Hello everyone!")

from praisonai_tools import LineTool

line = LineTool()
result = line.send_flex_message(
    to="user_id",
    alt_text="New notification",
    contents={
        "type": "bubble",
        "body": {
            "type": "box",
            "layout": "vertical",
            "contents": [
                {"type": "text", "text": "Hello!"}
            ]
        }
    }
)

Actions

iMessage

Setup

1. Enable Messages.app

   Ensure Messages.app is configured with your Apple ID.

2. Grant permissions

   Your terminal may need Accessibility and Automation permissions in System Preferences.

Usage

from praisonai_tools import iMessageTool

imsg = iMessageTool()
result = imsg.send_message(
    to="+1234567890",
    message="Hello from PraisonAI!"
)

from praisonai_tools import iMessageTool

imsg = iMessageTool()
result = imsg.send_message(
    to="user@example.com",
    message="Hello!"
)

from praisonai_tools import iMessageTool

imsg = iMessageTool()
status = imsg.check_availability()
print(status)  # {'available': True, 'mode': 'applescript', 'macos': True}

Actions

WhatsApp

Setup

1. Create WhatsApp Business Account

   Set up a WhatsApp Business API account.

2. Get credentials

   Copy your Access Token and Phone Number ID.

3. Set environment variables

   export WHATSAPP_ACCESS_TOKEN=your_token
   export WHATSAPP_PHONE_NUMBER_ID=your_phone_id

Usage

from praisonai_tools import WhatsAppTool

wa = WhatsAppTool()
result = wa.send_message(
    to="+1234567890",
    message="Hello from PraisonAI!"
)

Using with Agents

All channel tools work seamlessly with PraisonAI agents:

from praisonaiagents import Agent
from praisonai_tools import SignalTool, LineTool, TelegramTool

# Create agent with multiple channels
agent = Agent(
    name="MultiChannelBot",
    instructions="Send notifications across multiple platforms",
    tools=[SignalTool(), LineTool(), TelegramTool()]
)

# Agent decides which channel to use
agent.start("Notify John on Signal and the team on LINE about the meeting")

Channel Comparison

Environment Variables

Best Practices

Related