{ "info": { "author": "Mark Vartanyan", "author_email": "kolypto@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 5 - Production/Stable", "Intended Audience :: Developers", "Natural Language :: English", "Operating System :: OS Independent", "Programming Language :: Python :: 2", "Programming Language :: Python :: 3" ], "description": "[![Build Status](https://api.travis-ci.org/kolypto/py-smsframework-clickatell.png?branch=master)](https://travis-ci.org/kolypto/py-smsframework-clickatell)\n[![Pythons](https://img.shields.io/badge/python-2.7%20%7C%203.4%E2%80%933.7%20%7C%20pypy-blue.svg)](.travis.yml)\n\nSMSframework Clickatell Provider\n================================\n\n[Clickatell](https://www.clickatell.com/) Provider for [smsframework](https://pypi.python.org/pypi/smsframework/).\n\nYou need a \"Developers' Central\" Clickatell account with an HTTP API set up.\nFrom the API, you need: api_id, username, password.\n\n\n\n\n\n\nInstallation\n============\n\nInstall from pypi:\n\n $ pip install smsframework_clickatell\n\nTo receive SMS messages, you need to ensure that\n[Flask microframework](http://flask.pocoo.org) is also installed:\n\n\n $ pip install smsframework_clickatell[receiver]\n\n\n\n\n\n\nInitialization\n==============\n\n```python\nfrom smsframework import Gateway\nfrom smsframework_clickatell import ClickatellProvider\n\ngateway = Gateway()\ngateway.add_provider('clickatell', ClickatellProvider,\n api_id=1,\n user='kolypto',\n password='123',\n https=False\n)\n```\n\nConfig\n------\n\nSource: /smsframework_clickatell/provider.py\n\n* `api_id: str`: API ID to use\n* `user: str`: Account username\n* `password: str`: Account password\n* `https: bool`: Use HTTPS for outgoing messages? Default: `False`\n\n\n\n\n\n\nSending Parameters\n==================\n\nProvider-specific sending params:\n\n* `deliv_time: int`: Delay the delivery for X minutes\n\nExample:\n\n```python\nfrom smsframework import OutgoingMessage\n\ngateway.send(OutgoingMessage('+123', 'hi').params(deliv_time=15))\n```\n\n\n\n\n\n\nAdditional Information\n======================\n\nOutgoingMessage.meta\n--------------------\nNone.\n\nIncomingMessage.meta\n--------------------\n* `api_id: str`: API id\n* `charset: str`: Message character set (when applicable, else - None)\n* `udh: str`: Header Data (when applicable, else - None)\n\nMessageStatus.meta\n------------------\n* `status: int`: Message status code\n* `api_id: str`: API id\n* `charge: float`: Charged funds\n\n\n\n\n\n\nPublic API\n==========\n\nClickatellProvider.get_balance()\n--------------------------------\nReturns the credist left on the account:\n\n```python\nprovider = gateway.get_provider('clickatell')\nprovider.get_balance() #-> 10.6\n```\n\n\n\n\n\n\nReceivers\n=========\n\nSource: /smsframework_clickatell/receiver.py\n\nMessage Receiver: /im\n---------------------\nAfter a number is purchased, go to Receive Messages > Manage long numbers / short codes, and then click the \u2018Edit\u2019\nlink of the two-way number which you would like to configure. Set \"Reply Path\" to \"HTTP Get\" | \"HTTP Post\",\nin the field - put the message receiver URL.\n\n* \"Username & Password\" is not supported\n* \"Secondary callback\" is up to you\n\nMessage Receiver URL: `/im`\n\nStatus Receiver: /status\n------------------------\nTo start getting status reports from Clickatell, edit the HTTP API in the admin panel and click on\n\"Enable your app to receive message delivery notifications\".\nIn the field, put the receiver URL.\n\n* Status receiver only supports \"HTTP Get\" and \"HTTP Post\" methods.\n* \"basic HTTP Authentication\" is not supported\n\nStatus Receiver URL: `/status`\n\n\n\n", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/kolypto/py-smsframework-clickatell", "keywords": "sms,message,notification,receive,send,clickatell", "license": "BSD", "maintainer": "", "maintainer_email": "", "name": "smsframework-clickatell", "package_url": "https://pypi.org/project/smsframework-clickatell/", "platform": "any", "project_url": "https://pypi.org/project/smsframework-clickatell/", "project_urls": { "Homepage": "https://github.com/kolypto/py-smsframework-clickatell" }, "release_url": "https://pypi.org/project/smsframework-clickatell/0.0.3.post0/", "requires_dist": [ "smsframework (>=0.0.9)", "flask (>=0.10) ; extra == 'receiver'" ], "requires_python": "", "summary": "SMS framework: Clickatell provider", "version": "0.0.3.post0" }, "last_serial": 4685323, "releases": { "0.0.1": [ { "comment_text": "", "digests": { "md5": "eec33acc552dddc891be34f8c0bf6137", "sha256": "eb113a4acc8b58694c7517c0c1b7c5fc524644461187b7071e64a027bfb0d314" }, "downloads": -1, "filename": "smsframework_clickatell-0.0.1-py2.7.egg", "has_sig": false, "md5_digest": "eec33acc552dddc891be34f8c0bf6137", "packagetype": "bdist_egg", "python_version": "2.7", "requires_python": null, "size": 19611, "upload_time": "2014-01-29T01:04:20", "url": "https://files.pythonhosted.org/packages/35/2a/e6642101785ce536473c4ddd91ed7517e6d8077a72d01daf6745b9c2a902/smsframework_clickatell-0.0.1-py2.7.egg" }, { "comment_text": "", "digests": { "md5": "3a7cf9801625efe6ce014b42cf242ff0", "sha256": "9ec54ba0fbf8a7591c7db6c127c35f8e3a6fd17fef8799007800ceca55e29186" }, "downloads": -1, "filename": "smsframework-clickatell-0.0.1.tar.gz", "has_sig": false, "md5_digest": "3a7cf9801625efe6ce014b42cf242ff0", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8397, "upload_time": "2014-01-29T01:04:16", "url": "https://files.pythonhosted.org/packages/cb/dd/d194913638c96ba5cb779fe469a72f9b6745d258d36dd2bcd7bf555071cb/smsframework-clickatell-0.0.1.tar.gz" } ], "0.0.2-2": [ { "comment_text": "", "digests": { "md5": "1681c8dad1af81f85449740f9ff5aab5", "sha256": "a0b032becf42284f9cc452c44afe65dabcea4b81a85c51ed94d59a5d933b373d" }, "downloads": -1, "filename": "smsframework_clickatell-0.0.2_2-py2-none-any.whl", "has_sig": false, "md5_digest": "1681c8dad1af81f85449740f9ff5aab5", "packagetype": "bdist_wheel", "python_version": "2.7", "requires_python": null, "size": 12305, "upload_time": "2014-08-14T15:56:00", "url": "https://files.pythonhosted.org/packages/03/aa/11612e8e78c6c23ce18db5fb0f2632434073298529ed17ec214660d86c17/smsframework_clickatell-0.0.2_2-py2-none-any.whl" }, { "comment_text": "", "digests": { "md5": "00087928d2ad082cdb2812e7dda78a40", "sha256": "6898ac09e2f076c4d1d8a5393bc0dee43bfc870bc2e251363fcbf33c4aff61d9" }, "downloads": -1, "filename": "smsframework-clickatell-0.0.2-2.tar.gz", "has_sig": false, "md5_digest": "00087928d2ad082cdb2812e7dda78a40", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8551, "upload_time": "2014-08-14T15:55:53", "url": "https://files.pythonhosted.org/packages/9e/d0/f93d8e90dc91a83cf280e9f0fed7a0887157783053a7182c64efa4faa2ef/smsframework-clickatell-0.0.2-2.tar.gz" } ], "0.0.3.post0": [ { "comment_text": "", "digests": { "md5": "414486f77e8971f201467c056798f748", "sha256": "0b0ca24b331c2ce792f6858026019de93a7b356ec048641c31a21e8275596a1b" }, "downloads": -1, "filename": "smsframework_clickatell-0.0.3.post0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "414486f77e8971f201467c056798f748", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 11162, "upload_time": "2019-01-11T12:57:11", "url": "https://files.pythonhosted.org/packages/34/f8/4f4f024d3b5e04d79d8e1b3b1a05faae0351e36a5bd00bf02962fb9cac82/smsframework_clickatell-0.0.3.post0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "6aecd43d7f81c23da5e79e306c5efe23", "sha256": "5908b53fe28dfd88e1b9b44932820e65bbc78bdb7a1474001d7fc2a5ca6a93e1" }, "downloads": -1, "filename": "smsframework-clickatell-0.0.3.post0.tar.gz", "has_sig": false, "md5_digest": "6aecd43d7f81c23da5e79e306c5efe23", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 9480, "upload_time": "2019-01-11T12:57:12", "url": "https://files.pythonhosted.org/packages/c5/65/b220327494228b11715126023782a410078044d6128767083568c252e1d9/smsframework-clickatell-0.0.3.post0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "414486f77e8971f201467c056798f748", "sha256": "0b0ca24b331c2ce792f6858026019de93a7b356ec048641c31a21e8275596a1b" }, "downloads": -1, "filename": "smsframework_clickatell-0.0.3.post0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "414486f77e8971f201467c056798f748", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 11162, "upload_time": "2019-01-11T12:57:11", "url": "https://files.pythonhosted.org/packages/34/f8/4f4f024d3b5e04d79d8e1b3b1a05faae0351e36a5bd00bf02962fb9cac82/smsframework_clickatell-0.0.3.post0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "6aecd43d7f81c23da5e79e306c5efe23", "sha256": "5908b53fe28dfd88e1b9b44932820e65bbc78bdb7a1474001d7fc2a5ca6a93e1" }, "downloads": -1, "filename": "smsframework-clickatell-0.0.3.post0.tar.gz", "has_sig": false, "md5_digest": "6aecd43d7f81c23da5e79e306c5efe23", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 9480, "upload_time": "2019-01-11T12:57:12", "url": "https://files.pythonhosted.org/packages/c5/65/b220327494228b11715126023782a410078044d6128767083568c252e1d9/smsframework-clickatell-0.0.3.post0.tar.gz" } ] }