Download the PHP package rstacode/otpiq without Composer

On this page you can find all versions of the php package rstacode/otpiq. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

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 PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • 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.
Please rate this library. Is it a good library?

Example code of rstacode/otpiq

Informations about the package otpiq

OTPIQ Laravel Package

A Laravel package for seamless integration with the OTPIQ SMS service API. Send verification codes and custom messages via SMS, WhatsApp, or Telegram with ease.

🔗 Quick Links

✨ Features

🛠️ Requirements

🚀 Installation

  1. Install the package via Composer:

  2. Publish the configuration file:

  3. Add your OTPIQ API key to your .env file:

⚙️ Configuration

The configuration file (config/otpiq.php) includes the following options:

🎯 Usage

Send Verification Code

Send Custom Message

Track SMS Status

Get Project Information

Get Sender IDs

🚨 Error Handling

The package provides comprehensive error handling. Here's how to handle errors:

🔌 Available Providers

OTPIQ offers 6 provider options including smart fallback routes:

Note: For custom messages, the provider is typically set to sms since sender IDs are mainly supported via SMS.

🔗 Webhooks

OTPIQ provides real-time delivery status notifications via webhooks. When you configure webhooks, you'll receive instant updates about message delivery status directly to your server.

How to Configure Webhooks

Include a deliveryReport object in your SMS request:

Webhook Configuration Fields

Field Type Required Description
webhookUrl string Yes HTTPS URL where status updates are sent
deliveryReportType string No "all" for all updates, "final" for final status only
webhookSecret string No Secret key for webhook authentication

Webhook Payload Structure

Each webhook request contains a JSON payload with these fields:

Required Fields:

Optional Fields:

Delivery Status Flow

SMS Messages:

WhatsApp Messages:

Telegram Messages:

Webhook Examples

Example 1: SMS with Custom Sender ID

Request:

Webhook Payloads Received:

Sent Status:

Delivered Status:

Example 2: WhatsApp with Final-Only Reports

Request:

Webhook Payload (Final Status Only):

Example 3: Failed Message

Request:

Webhook Payload (Failure):

Laravel Event Integration

For handling webhook events in Laravel:

📜 License

This package is licensed under the MIT License. See the LICENSE file for details.

🔒 Security

If you discover any security-related issues, please email [email protected] instead of using the issue tracker.

💡 Credits

🤝 Contributing

Thank you for considering contributing to the OTPIQ Laravel package!

  1. Fork the repository.
  2. Create your feature branch (git checkout -b feature/amazing-feature).
  3. Commit your changes (git commit -m 'Add some amazing feature').
  4. Push to the branch (git push origin feature/amazing-feature).
  5. Open a Pull Request.

📞 Support

For support, email GitHub repository.

All versions of otpiq with dependencies

PHP Build Version
Package Version
Requires php Version ^8.1|^8.2|^8.3|^8.4
illuminate/support Version ^10.0|^11.0|^12.0
guzzlehttp/guzzle Version ^7.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package rstacode/otpiq contains the following files

Loading the files please wait ....