mirror of
https://github.com/simstudioai/sim.git
synced 2026-02-19 02:34:37 -05:00
54e1439224
* added scaffolding for auto-generating docs for integrations based on block definition, get rendering error for mdx pages * page renders, have to add more useful information * standardized tool naming convention, added script to autogenerate docs for integrations, added docs for each tool * re-generated docs, updated CONTRIBUTING.md to reflect new format * added a dedicated tools page * added additional information for tools, added manual section logic to docs producer * added a link back to sim studio, fixed z level issue on mobile, added better intro * updated script to more accurately reflect the params for each tool, as well as the overall blocks' output
92 lines
4.0 KiB
Plaintext
92 lines
4.0 KiB
Plaintext
---
|
|
title: WhatsApp
|
|
description: Send WhatsApp messages
|
|
---
|
|
|
|
import { BlockInfoCard } from "@/components/ui/block-info-card"
|
|
|
|
<BlockInfoCard
|
|
type="whatsapp"
|
|
color="#25D366"
|
|
icon={true}
|
|
iconSvg={`<svg className="block-icon"
|
|
|
|
xmlns="http://www.w3.org/2000/svg"
|
|
|
|
|
|
fill="currentColor"
|
|
viewBox="0 0 16 16"
|
|
>
|
|
<path d="M13.601 2.326A7.85 7.85 0 0 0 7.994 0C3.627 0 .068 3.558.064 7.926c0 1.399.366 2.76 1.057 3.965L0 16l4.204-1.102a7.9 7.9 0 0 0 3.79.965h.004c4.368 0 7.926-3.558 7.93-7.93A7.9 7.9 0 0 0 13.6 2.326zM7.994 14.521a6.6 6.6 0 0 1-3.356-.92l-.24-.144-2.494.654.666-2.433-.156-.251a6.56 6.56 0 0 1-1.007-3.505c0-3.626 2.957-6.584 6.591-6.584a6.56 6.56 0 0 1 4.66 1.931 6.56 6.56 0 0 1 1.928 4.66c-.004 3.639-2.961 6.592-6.592 6.592m3.615-4.934c-.197-.099-1.17-.578-1.353-.646-.182-.065-.315-.099-.445.099-.133.197-.513.646-.627.775-.114.133-.232.148-.43.05-.197-.1-.836-.308-1.592-.985-.59-.525-.985-1.175-1.103-1.372-.114-.198-.011-.304.088-.403.087-.088.197-.232.296-.346.1-.114.133-.198.198-.33.065-.134.034-.248-.015-.347-.05-.099-.445-1.076-.612-1.47-.16-.389-.323-.335-.445-.34-.114-.007-.247-.007-.38-.007a.73.73 0 0 0-.529.247c-.182.198-.691.677-.691 1.654s.71 1.916.81 2.049c.098.133 1.394 2.132 3.383 2.992.47.205.84.326 1.129.418.475.152.904.129 1.246.08.38-.058 1.171-.48 1.338-.943.164-.464.164-.86.114-.943-.049-.084-.182-.133-.38-.232" />
|
|
</svg>`}
|
|
/>
|
|
|
|
{/* MANUAL-CONTENT-START:intro */}
|
|
[WhatsApp](https://www.whatsapp.com/) is a globally popular messaging platform that enables secure, reliable communication between individuals and businesses.
|
|
|
|
WhatsApp Business API provides organizations with powerful capabilities to:
|
|
|
|
- **Engage customers**: Send personalized messages, notifications, and updates directly to customers' preferred messaging app
|
|
- **Automate conversations**: Create interactive chatbots and automated response systems for common inquiries
|
|
- **Enhance support**: Provide real-time customer service through a familiar interface with rich media support
|
|
- **Drive conversions**: Facilitate transactions and follow-ups with customers in a secure, compliant environment
|
|
|
|
In Sim Studio, the WhatsApp integration enables your agents to leverage these messaging capabilities as part of their workflows. This creates opportunities for sophisticated customer engagement scenarios like appointment reminders, verification codes, alerts, and interactive conversations. The integration bridges the gap between your AI workflows and customer communication channels, allowing your agents to deliver timely, relevant information directly to users' mobile devices. By connecting Sim Studio with WhatsApp, you can build intelligent agents that engage customers through their preferred messaging platform, enhancing user experience while automating routine messaging tasks.
|
|
{/* MANUAL-CONTENT-END */}
|
|
|
|
|
|
## Usage Instructions
|
|
|
|
Send messages to WhatsApp users using the WhatsApp Business API. Requires WhatsApp Business API configuration.
|
|
|
|
|
|
|
|
## Tools
|
|
|
|
### `whatsapp_send_message`
|
|
|
|
Send WhatsApp messages
|
|
|
|
#### Input
|
|
|
|
| Parameter | Type | Required | Description |
|
|
| --------- | ---- | -------- | ----------- |
|
|
| `phoneNumber` | string | Yes | Recipient phone number with country code |
|
|
| `message` | string | Yes | Message content to send |
|
|
| `phoneNumberId` | string | Yes | WhatsApp Business Phone Number ID |
|
|
| `accessToken` | string | Yes | WhatsApp Business API Access Token |
|
|
|
|
#### Output
|
|
|
|
| Parameter | Type |
|
|
| --------- | ---- |
|
|
| `success` | string |
|
|
| `messageId` | string |
|
|
|
|
|
|
|
|
## Block Configuration
|
|
|
|
### Input
|
|
|
|
| Parameter | Type | Required | Description |
|
|
| --------- | ---- | -------- | ----------- |
|
|
| `phoneNumber` | string | Yes | Recipient Phone Number - Enter phone number with country code \(e.g., +1234567890\) |
|
|
|
|
|
|
|
|
### Outputs
|
|
|
|
| Output | Type | Description |
|
|
| ------ | ---- | ----------- |
|
|
| `response` | object | Output from response |
|
|
| ↳ `success` | boolean | success of the response |
|
|
| ↳ `messageId` | any | messageId of the response |
|
|
| ↳ `error` | any | error of the response |
|
|
|
|
|
|
## Notes
|
|
|
|
- Category: `tools`
|
|
- Type: `whatsapp`
|