Unlock the Power of WhatsApp API with the PHP SDK from Whapi.Cloud
Streamline your WhatsApp bot development with the Whapi.Cloud PHP SDK, a comprehensive toolkit designed to simplify integration and automate messaging workflows. Whether you’re sending messages, managing groups, or creating advanced customer interactions, this SDK empowers developers to build robust, scalable solutions with ease.
Why Choose the Whapi.Cloud PHP SDK?
- No Number Migration Required: Use your existing number without the need to migrate.
- Simple Integration: Connect any number via QR code for quick testing.
- Effortless Webhook Setup: Configure webhooks for real-time messaging with just a few clicks.
- Comprehensive Functionality: Send and receive text, media, files, locations, polls, and more across personal and group chats.
Getting Started
1. Obtain Your API Token
Register and log in to your Whapi.Cloud Dashboard to authorize your number and generate an API token. This token will serve as the key to unlocking the SDK’s capabilities.
2. Download the SDK
Access the PHP SDK directly from the official GitHub repository: Download Here.
3. Install the SDK
Install the SDK using Composer for easy dependency management:
composer require whapi-cloud/whatsapp-api-sdk-php
Setting Up Your Integration
Initialize the Client
To authenticate your API requests, initialize the client with your API token.
use OpenAPI\Client\Api\MessagesApi;
use OpenAPI\Client\Configuration;
// Initialize the client
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()
->setApiKey('token', "your_token")
->setAccessToken("your_token");
$apiInstance = new OpenAPI\Client\Api\MessagesApi(
new GuzzleHttp\Client(),
$config
);
Messaging API: Key Features and Examples
Sending Text Messages
Effortlessly send text messages using the API. You can also include optional settings like typing simulation or ephemeral visibility.
$sender_text = new \OpenAPI\Client\Model\SenderText();
$sender_text->setTo('13016789891'); // Include country code
$sender_text->setBody('Your message here'); // Message content
$sender_text->setEphemeral(3600); // Message visibility time
$sender_text->setTypingTime(5.0); // Typing simulation duration
$result = $apiInstance->sendMessageText($sender_text);
print_r($result);
Retrieving Messages with Webhooks
Webhooks provide real-time updates for incoming messages, ensuring your bot stays up-to-date.
Retrieve Multiple Messages
Use the following example to retrieve a batch of messages.
$count = 100;
$offset = 0;
$result = $apiInstance->getMessages($count, $offset);
print_r($result);
Retrieve a Single Message
To fetch a specific message by its ID, use this example:
$message_id = "your_message_id";
$result = $apiInstance->getMessage($message_id);
print_r($result);
For detailed webhook setup instructions, check the Webhook Guide.
WhatsApp Groups API: Automate Group Management
Simplify and streamline the management of WhatsApp groups with Whapi.Cloud's Groups API. These features empower you to automate tasks, saving time and reducing manual effort.
Key Features for Group Management
- Create, Update, or Delete Groups: Programmatically manage your WhatsApp groups with ease.
- Participant Management: Add, remove, or block members as required.
- Custom Group Settings: Adjust group names, avatars, and permissions effortlessly.
- Generate Invitation Links: Quickly create and share group invite links for seamless onboarding.
Example: Creating a Group
Below is a practical example of how to create a new WhatsApp group using the API.
$create_group_request = [
"subject" => "Group Name",
"participants" => [
"13016789891",
"13016789892"
]
];
$result = $apiInstance->createGroup($create_group_request);
print_r($result);
Best Practices and Important Notes
Working with Phone Numbers
When using the Whapi.Cloud API, follow these best practices for handling phone numbers:
- Always include the country code: For example, use '13016789891' for a US number.
- Avoid special characters and spaces: Numbers should be entered as a continuous string of digits.
Media Requirements
Ensure your media files meet the following criteria to guarantee smooth delivery:
- Publicly Accessible URLs: All media files must be hosted at a URL that is accessible without authentication.
- Supported Formats: Common image formats such as JPEG and PNG are supported, along with other standard file types.
Optimizing Messaging
For a more engaging and user-friendly experience, use these options:
- Ephemeral Messages: Set messages to disappear after a specific time for added privacy.
- Typing Simulation: Simulate typing indicators to provide a more natural, human-like interaction.
Why Choose Whapi.Cloud?
Whapi.Cloud offers a robust and user-friendly WhatsApp API gateway, designed to make integration simple and efficient for developers. Here’s why it stands out:
- Comprehensive Group Management: Easily create, manage, and automate WhatsApp groups, communities, and channels.
- Interactive Messaging Features: Add dynamic elements such as buttons, media sharing, polls, and reactions to enhance communication.
- Reliable Support: Access fast and knowledgeable assistance from our dedicated care team to ensure your development process runs smoothly.
Whapi.Cloud’s transparency, flexibility, and robust documentation make it an ideal solution for scaling your WhatsApp operations while maintaining control and efficiency.
Get Started Today
Take the first step toward powerful WhatsApp automation with the Whapi.Cloud PHP SDK.
Links to Get Started:
- Register for your API token: Whapi.Cloud Dashboard
- Download the PHP SDK: GitHub Repository
Streamline your WhatsApp bot development and start building interactive solutions today.
Top comments (0)