Download the PHP package aristide/nimbasms without Composer
On this page you can find all versions of the php package aristide/nimbasms. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package nimbasms
Nimbasms
Client Laravel pour l'API Nimba SMS : SMS, WhatsApp (templates Meta), OTP, contacts, groupes, sender names, achats et extensions.
Prérequis
- PHP 8.3+
- Laravel 11, 12 ou 13
- Un compte Nimba SMS et des clés API (
service_id/secret_token) depuis API Keys
Installation
Publiez le fichier de configuration :
Ajoutez vos identifiants dans .env :
L'authentification suit la spec officielle : HTTP Basic base64(service_id:secret_token) vers https://api.nimbasms.com/v1.
| Clé | Description |
|---|---|
NIMBASMS_BASE_URL |
URL de base (https://api.nimbasms.com/v1 par défaut) |
NIMBASMS_SERVICE_ID |
Identifiant de service |
NIMBASMS_SECRET_TOKEN |
Jeton secret |
NIMBASMS_SENDER_NAME |
Nom d'expéditeur par défaut (sensible à la casse) |
NIMBASMS_TIMEOUT |
Timeout HTTP en secondes (20 par défaut) |
Usage
Toutes les réponses JSON de l'API sont renvoyées sous forme de tableaux PHP. Les erreurs HTTP lèvent une exception typée.
Compte
GET /accounts — soldes SMS et WhatsApp (sms_balance, whatsapp_balance ; balance est obsolète).
Messages SMS
POST /messages avec channel: sms. Maximum 30 destinataires par requête ; le client découpe automatiquement au-delà.
Jusqu'à 7 parties SMS (1071 caractères GSM-7). Simulateur : simulator.nimbasms.com.
Messages WhatsApp
POST /messages avec channel: whatsapp. Le texte libre n'est pas accepté : il faut un template Meta validé créé depuis le dashboard Nimba SMS.
Les clés "1", "2", "3" correspondent à {{1}}, {{2}}, {{3}} dans le corps du template.
Détail d'un message
GET /messages/{messageid}
Vérifications OTP
POST /verifications puis PATCH /verifications/{verificationid}.
Le message SMS doit contenir le motif <1234>. Pour WhatsApp, le contenu est remplacé par le template d'authentification. Préférez cet endpoint aux SMS OTP via /messages : Nimba lui donne une file prioritaire.
Contacts
GET /contacts et POST /contacts
Groupes, sender names, achats
Extensions marketplace
Couvre la spec OpenAPI : liste, création, détail, mise à jour, publication, logo, actions et plans tarifaires.
Webhooks de livraison
L'URL se configure dans le dashboard Nimba (API Keys). Nimba envoie un POST JSON ; répondez 200 OK (3 tentatives sinon).
Statuts documentés côté livraison : tosend, sent, received, read, failure, not_available. Le webhook OpenAPI mentionne aussi failed.
Exceptions
| HTTP | Exception |
|---|---|
| 400 / 422 | Nimbasms\Nimbasms\Exceptions\ValidationException |
| 401 | AuthenticationException |
| 404 | NotFoundException |
| 420 / 429 | RateLimitException |
| 5xx | ServerException |
| autre | NimbaSmsException |
Toutes étendent NimbaSmsException ($exception->status, $exception->body).
L'API limite les envois à 300 SMS / seconde. Prévoyez un retry sur RateLimitException.
Tests dans l'application hôte
Documentation officielle
- developers.nimbasms.com
- OpenAPI :
https://developers.nimbasms.com/openapi?lang=fr - Changelog Nimba SMS
Changelog
Voir CHANGELOG.
Contributing
Voir .github/CONTRIBUTING.md.
Security Vulnerabilities
Voir .github/SECURITY.md.
Credits
- Aristide
- All Contributors
License
Nimbasms is open-sourced software licensed under the MIT license.
All versions of nimbasms with dependencies
illuminate/http Version ^12.0||^13.0
illuminate/support Version ^12.0||^13.0