Download the PHP package kirimi/kirimi-php without Composer
On this page you can find all versions of the php package kirimi/kirimi-php. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download kirimi/kirimi-php
More information about kirimi/kirimi-php
Files in kirimi/kirimi-php
Package kirimi-php
Short Description Official PHP client library for the Kirimi WhatsApp API. Send messages, handle OTP verification, and manage WhatsApp communication with ease.
License MIT
Homepage https://github.com/kiriminow/kirimi-php
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package kirimi-php
Kirimi PHP Client
Official PHP client library for the Kirimi WhatsApp API. This library provides a simple and efficient way to send WhatsApp messages, handle OTP generation and validation, and manage WhatsApp communication from your PHP applications.
🚀 Features
- ✅ Send WhatsApp messages (text and media)
- ✅ Broadcast to up to 1000 recipients
- ✅ WhatsApp Business API (WABA) templates, replies, conversations and OTP
- ✅ Generate and validate OTP codes (v1 and v2)
- ✅ Reverse OTP verification
- ✅ Devices, contacts, packages and deposits
- ✅ Support for multiple package types (Free, Lite, Basic, Pro)
- ✅ PSR-4 autoloading support
- ✅ Comprehensive error handling with HTTP status codes
- ✅ Type hints and modern PHP features
- ✅ Service classes for common use cases
📦 Installation
Install via Composer:
🔧 Requirements
- PHP 8.0 or higher
- Guzzle HTTP client (installed automatically)
- ext-json (usually included in PHP)
🔧 Setup
Get your User Code and Secret Key from the Kirimi Dashboard.
📖 API Reference
Constructor
Parameters:
$userCode(string): Your unique user code from Kirimi Dashboard$secret(string): Your secret key for authentication$endpoint(string): API endpoint URL (optional)
Send Message
Send WhatsApp messages with optional media support. The recipient is passed as $receiver
and sent to the API as receiver (country code, no +).
Parameters:
$deviceId(string): Your device ID$receiver(string): Recipient's phone number (with country code)$message(string): Message content$mediaUrl(string|null): URL of media file to send (optional)$options(array): OptionalfileName,enableTypingEffect,typingSpeedMs,quotedMessageId
Send Message Fast
Send a message without the typing effect simulation.
Send Message File
Send a file/document via multipart upload (max 50MB). The filename is sent both as the
multipart filename and as the fileName field.
Broadcast Message
Send a message to up to 1000 recipients. $numbers is always sent as a JSON array
and $label is required.
WABA — Send Template Message
Send a Meta-approved template via WhatsApp Business API. WABA endpoints use waba_id,
never device_id.
WABA — Reply, Conversations & Templates
WABA — OTP
Devices
User Info
Contacts
Existing numbers are skipped, not overwritten.
Generate OTP
Generate and send OTP via device WhatsApp.
Validate OTP
Send OTP V2
Send an OTP through the Kirimi provider, your own device, or your own WABA.
Verify OTP V2
Reverse OTP
The customer sends a token back to your device, which verifies automatically.
Deposits & Packages
Package Support:
- Free: Text only (with watermark)
- Lite/Basic/Pro: Text + Media support
Health Check
Check the API service status.
🎯 Quick Start
Check out the examples/demo.php file for a complete demonstration of all features:
💡 Usage Examples
Basic WhatsApp Messaging
OTP Verification Flow
Notification Service
Laravel Integration
📋 Package Types & Features
| Package | ID | Features | OTP Support |
|---|---|---|---|
| Free | 1 | Text only (with watermark) | ❌ |
| Lite | 2, 6, 9 | Text + Media | ❌ |
| Basic | 3, 7, 10 | Text + Media + OTP | ✅ |
| Pro | 4, 8, 11 | Text + Media + OTP | ✅ |
⚠️ Error Handling
The library provides comprehensive error handling using KirimiException. Use
getStatusCode() to distinguish failures; it returns the HTTP status code from the
response (null for network errors).
| Code | Meaning |
|---|---|
400 |
Invalid params |
401 |
Wrong secret |
402 |
Insufficient balance (/v2/otp/send whatsapp) |
403 |
Feature not in package / subscription inactive |
404 |
Not found |
429 |
Rate limited |
500 |
Server error |
502 |
Number undeliverable |
503 |
Provider outage |
🔒 Security Notes
- Always keep your secret key secure and never expose it in client-side code
- Use environment variables to store credentials
- Validate phone numbers before sending messages
- Implement rate limiting in your application
🚦 Rate Limits & Quotas
- Each message sent reduces your device quota (unless unlimited)
- OTP codes expire after 5 minutes
- Device must be in 'connected' status to send messages
- Check your dashboard for current quota and usage statistics
🧪 Testing
Run the test suite:
Run tests with coverage:
Check code style:
Fix code style:
🤝 Contributing
Contributions are welcome! Please follow these steps:
- Fork the repository
- Create a feature branch
- Follow PSR-12 coding standards
- Add tests for new features
- Submit a pull request
📄 License
👨💻 Author
Ari Padrian - [email protected]
📚 Additional Resources
Made with ❤️ for the PHP and WhatsApp automation community
