{"id":17705111,"url":"https://github.com/terox/smscampaignbundle","last_synced_at":"2025-03-13T08:31:51.102Z","repository":{"id":57066989,"uuid":"77220689","full_name":"terox/SmsCampaignBundle","owner":"terox","description":"Tools and services to send massive SMS campaigns in Symfony applications","archived":false,"fork":false,"pushed_at":"2017-07-24T11:48:57.000Z","size":35,"stargazers_count":6,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-02-26T19:27:41.129Z","etag":null,"topics":["rabbitmq","smpp","sms","sms-campaigns","symfony","symfony-bundle"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/terox.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-12-23T11:14:46.000Z","updated_at":"2021-03-10T19:15:53.000Z","dependencies_parsed_at":"2022-08-24T10:20:09.698Z","dependency_job_id":null,"html_url":"https://github.com/terox/SmsCampaignBundle","commit_stats":null,"previous_names":[],"tags_count":13,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/terox%2FSmsCampaignBundle","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/terox%2FSmsCampaignBundle/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/terox%2FSmsCampaignBundle/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/terox%2FSmsCampaignBundle/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/terox","download_url":"https://codeload.github.com/terox/SmsCampaignBundle/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243369890,"owners_count":20280097,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["rabbitmq","smpp","sms","sms-campaigns","symfony","symfony-bundle"],"created_at":"2024-10-24T22:06:28.482Z","updated_at":"2025-03-13T08:31:50.773Z","avatar_url":"https://github.com/terox.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# SmsCampaignBundle\n\n## About The Project\n\nThe **SmsCampaignBundle** provides tools and services to create and send SMS campaigns to a high volume of users. Currently,\nit can send SMS though SMPP client, the most used protocol for send high volumes.\n\n### About the SMPP Client\n\nDue the PHP limitations on persistent and async processes management, I have created the utility [smpp-cli](https://github.com/terox/smpp-cli)\nfor NodeJS. This is a little daemon that implements a ```DNode protocol``` to connect the PHP consumers with ***smpp-cli*** \nprocesses that sent the SMS through SMPP server.\n\nThe impact of implement this architecture is minimum and solves a lot of headaches with SMPP providers like repetitive \nconnections, timeouts, two processes (one to sent, one to receive) etc.\n\nThis is completely transparent for developer.\n\n\u003csmall\u003e**Note**: The customized [php-smpp](https://github.com/terox/php-smpp) is definitely deprecated.\u003c/small\u003e\n\n## Installation:\n\n#### 1. Require the bundle and its dependencies with composer:\n\n```bash\ncomposer require terox/sms-campaign-bundle\n```\n\n#### 2. Install ```smpp-cli```:\n\n```bash\nnpm install -g smpp-cli\n```\n\n#### 2. Register ```SmsCampaignBundle``` and ```RabbitMQBundle``` in your AppKernel.php:\n\n```php\npublic function registerBundles()\n{\n    $bundles = array(\n        // ...\n        new OldSound\\RabbitMqBundle\\OldSoundRabbitMqBundle(),\n        new Terox\\SmsCampaignBundle\\TeroxSmsCampaignBundle()\n        // ...\n    );\n    \n    return $bundles;\n}\n```\n\n#### 3. Add the ```SmsCampaignBundle``` configuration to your ```config.yml```:\n\n```yaml\nterox_sms_campaign:\n    providers:\n        example_provider:\n            host: \"%smpp_host%\"\n            port: \"%smpp_port%\"\n            login: \"%smpp_login%\"\n            password: \"%smpp_password%\"\n            rpc:\n              port: 7070\n```\n\n#### 4. If you haven't added the ```RabbitMQBundle``` configuration, add it to your ```config.yml```:\nYou are free to configure the RabbitMQ bundle. The producers and consumers **are preconfigured in SmsCampaignBundle**.\n\n```yaml\nold_sound_rabbit_mq:\n    connections:\n        default:\n            host:     \"%rabbitmq_host%\"\n            port:     \"%rabbitmq_port%\"\n            user:     \"%rabbitmq_user%\"\n            password: \"%rabbitmq_password%\"\n            vhost:    \"%rabbitmq_vhost%\"\n            lazy:     true\n            connection_timeout: 3\n            read_write_timeout: 3\n\n            # requires php-amqplib v2.4.1+ and PHP5.4+\n            keepalive: false\n\n            # requires php-amqplib v2.4.1+\n            heartbeat: 0\n```\n\n## Usage\n\nThere are two ways to start the SMPP daemon (```smpp-cli```):\n\n### A. Start the SMPP daemon manually (recommended):\n\nThis will execute the daemon and will listen the ```dnode``` port. You need to pass your credentials manually:\n\n```bash\nsmpp-cli listen 7070 -h smpp.example.com -p 2675 -L userLogin -P userPassword -C \"/var/www/bin/console sms:dlr:update\"\n```\n***Note:*** You can use as many demons as you need, for example if you have more than one SMPP provider; only change the port number.\n\nI recommend you that executes this command inside [supervisor](http://supervisord.org/) to keep it running if something was\nwrong (like server updates, unexpected errors...).\n\n#### Keep in mind:\n* The credentials could be shown at the process manager (like ```htop```) depending on how you pass the credentials to smpp-cli.\n* If you use some deployment scripts, be sure to hide the sensitive data where you store these scripts.\n\n### B. Start the SMPP daemon with a Symfony console:\n\nThe propose of this command is to use the Symfony configuration params to configure the ```smpp-cli``` daemons:\n\n```bash\n/var/www/bin/console sms:start:client\n```\n***Warning!*** This command still not working as I expected. It need little more research. I hope fix it in the next major release,\nbut you are free to sent your PR.\n\n## TODO\n[ ] Message model extension\n\n## License\n\nSee: [LICENSE.md](LICENSE.md)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fterox%2Fsmscampaignbundle","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fterox%2Fsmscampaignbundle","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fterox%2Fsmscampaignbundle/lists"}