{ "info": { "author": "Vincent Van Hollebeke", "author_email": "vincent@compuscene.org", "bugtrack_url": null, "classifiers": [ "Development Status :: 3 - Alpha", "Intended Audience :: System Administrators", "License :: OSI Approved :: Apache Software License", "Programming Language :: Python", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.0", "Programming Language :: Python :: 3.1", "Programming Language :: Python :: 3.2", "Programming Language :: Python :: 3.3", "Programming Language :: Python :: 3.4", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Topic :: Communications", "Topic :: Communications :: Telephony", "Topic :: System :: Networking", "Topic :: System :: Networking :: Monitoring" ], "description": ".. image:: https://badge.fury.io/py/smsgateway-gammu.svg\n :target: https://badge.fury.io/py/smsgateway-gammu\n\n================\nsmsgateway-gammu\n================\n\nSend SMS messages via REST api using Gammu as backend.\n\nRequirements\n------------\n\n* The following program works both on Linux and OSX.\n\n* You must already have `Gammu `_ installed and configured on the right device.\nNote it's obvious that your device must manage SMS sending/receiving with Gammu perfectly.\n\nInstallation\n------------\n\n* Install the package into your project's virtual environment :\n\n ``pip install smsgateway-gammu``\n\nConfiguration\n-------------\n\n* Modify the ``/etc/smsgateway.yml`` configuration file with your favorite text editor.\n\n.. code-block:: yaml\n\n # Server settings\n server:\n # Listen address, put 0.0.0.0 to listen on all interfaces\n host: \"127.0.0.1\"\n\n # Listen port\n port: 1234\n\n # Gammu settings\n gammu:\n # PIN code, enter pin code there to unlock directly from application\n pin: 1234\n\n # Configuration : instead of a .gammurc file you can give configuration there\n # config:\n # Device: /dev/tty.HUAWEIMobile-Modem\n # Connection: at\n\n # General settings\n # Phone numbers that doesn't want to receive messages from gateway\n send_blacklist: [\"+33689898989\", \"+33652525252\"]\n\n # Phone numbers that are allowed to send messages to gateway\n receive_whitelist: [\"+33638383838\", \"+33614141414\"]\n\nUsage\n-----\n\nStart the gateway\n~~~~~~~~~~~~~~~~~\n\n* To start the gateway, just type the command :\n\n ``smsgateway``\n\n* Or if configuration file is elsewhere than ``/etc/smsgateway.yml`` :\n\n ``smsgateway --config ``\n\nSending a text message\n~~~~~~~~~~~~~~~~~~~~~~\n\nThere are different ways to send a message :\n\n**GET method**\n\n``GET /sms?number=mynumbers&message=mymessage``\n\nWhere **mynumbers** are phone numbers, comma separated.\n\nFor instance : ``GET /sms?number=+33565656565,+33689898989&message=Hello``\n\nWill send \"Hello\" message to the 2 phone numbers and return the JSON : ``{\"status\": \"ok\", \"message\": \"messages sent\"}``.\n\n**POST method**\n\n::\n\n POST /sms?number=mynumbers\n {\n \"message\": \"Hello World\"\n }\n\nWhere POST data is JSON containing the field string \"message\".\n\n::\n\n POST /sms?number=mynumbers\n {\n \"messages\": [\n \"Hello\",\n \"World\"\n ]\n }\n\nWhere JSON contains the field \"messages\" which is a list for multiple messages.\n\nUser interaction\n~~~~~~~~~~~~~~~~\n\nUsers allowed to send SMS messages to the gateway (receive_whitelist in config) can interact with the system.\n\n**Keywords are :**\n\n* **PING** : to check if the gateway works correctly, returns PONG if all is good.\n* **PAUSE** : temporary pause messages coming from the gateway. It's worth to have this feature when a monitoring system spams you. To enable again just resend **PAUSE**.\n\nPrometheus Alertmanager\n~~~~~~~~~~~~~~~~~~~~~~~\n\nThe gateway was primary designed to work with Prometheus `Alertmanager `_, allowing sending alerts with SMS messages.\n\nTo configure it, create a new **receiver** entry in the alertmanager configuration file :\n\n.. code-block:: yaml\n\n receivers:\n ...\n\n ...\n - name: sms\n webhook_configs:\n - url: http://localhost:9876/sms?number=+33623232323,+33690909090\n", "description_content_type": null, "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/vvanholl/smsgateway-gammu", "keywords": "", "license": "Apache License, Version 2.0", "maintainer": "", "maintainer_email": "", "name": "smsgateway-gammu", "package_url": "https://pypi.org/project/smsgateway-gammu/", "platform": "", "project_url": "https://pypi.org/project/smsgateway-gammu/", "project_urls": { "Homepage": "https://github.com/vvanholl/smsgateway-gammu" }, "release_url": "https://pypi.org/project/smsgateway-gammu/0.0.7/", "requires_dist": null, "requires_python": "", "summary": "Send SMS messages via REST api using Gammu", "version": "0.0.7" }, "last_serial": 3025518, "releases": { "0.0.6": [ { "comment_text": "", "digests": { "md5": "c62d79a3151d24d4816f31451915a811", "sha256": "0636ffe8665097649acf268891f1fe8a81a5f1ad1d31873772d6d21912ea3edc" }, "downloads": -1, "filename": "smsgateway-gammu-0.0.6.tar.gz", "has_sig": false, "md5_digest": "c62d79a3151d24d4816f31451915a811", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5501, "upload_time": "2017-07-03T06:26:53", "url": "https://files.pythonhosted.org/packages/f2/47/1a18b0ff1e51ba0bbb1d756d0d621af47a582d8209f6ef882e2ad044c58c/smsgateway-gammu-0.0.6.tar.gz" } ], "0.0.7": [ { "comment_text": "", "digests": { "md5": "f3b0f09b9c96ab38483c30b94f24a9a7", "sha256": "7408d5b905ce76fe376ae64cf0c11f7e7972e4792921a12825eaed3aa3211f8b" }, "downloads": -1, "filename": "smsgateway-gammu-0.0.7.tar.gz", "has_sig": false, "md5_digest": "f3b0f09b9c96ab38483c30b94f24a9a7", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5583, "upload_time": "2017-07-15T20:14:05", "url": "https://files.pythonhosted.org/packages/e8/8f/fef924df0585e7f574423f1392df741802456635629ded346a270e950e8e/smsgateway-gammu-0.0.7.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "f3b0f09b9c96ab38483c30b94f24a9a7", "sha256": "7408d5b905ce76fe376ae64cf0c11f7e7972e4792921a12825eaed3aa3211f8b" }, "downloads": -1, "filename": "smsgateway-gammu-0.0.7.tar.gz", "has_sig": false, "md5_digest": "f3b0f09b9c96ab38483c30b94f24a9a7", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5583, "upload_time": "2017-07-15T20:14:05", "url": "https://files.pythonhosted.org/packages/e8/8f/fef924df0585e7f574423f1392df741802456635629ded346a270e950e8e/smsgateway-gammu-0.0.7.tar.gz" } ] }