{ "info": { "author": "Chris Brand, Stephen Leibbrandt, Renier Minne", "author_email": "support@clickatell.com", "bugtrack_url": null, "classifiers": [ "License :: OSI Approved :: MIT License", "Operating System :: OS Independent", "Programming Language :: Python" ], "description": "Clickatell Python Library\n================================\n\nThis library supports version **2.7** & **3.6** of Python.\n\n------------------------------------\n\nThis library allows easy access to connecting the [Clickatell's](http://www.clickatell.com) different messenging API's.\n\nInstallation\n------------------\n\nYou can install this library via PIP as part of your requirements file.\n\n```\npip install clickatell-platform\n```\n\n[Clickatell Python PyPI](https://pypi.python.org/pypi?name=clickatell-platform&version=2.0.1&:action=display)\n\nUsage\n------------------\n\nThe library currently supports the `Http` and `Rest` protocols.\n\n### HTTP API\n\n``` python\nfrom clickatell.http import Http\n\nclickatell = Http(apiKey)\nresponse = clickatell.sendMessage(['1111111111'], \"My Message rest\")\n\nprint(response) #Returns the headers with all the messages\n\nfor entry in response['messages']:\n print(entry) #Returns all the message details per message\n #print(entry['apiMessageId'])\n #print(entry['to'])\n #print(entry['accepted'])\n #print(entry['error'])\n```\n\n### REST API\n\n``` python\nfrom clickatell.rest import Rest\n\nclickatell = Rest(apiKey)\nresponse = clickatell.sendMessage(['1111111111'], \"My Message rest\")\n\nprint response #Returns the headers with all the messages\n\nfor entry in response['messages']:\n print(entry) #Returns all the message details per message\n #print(entry['apiMessageId'])\n #print(entry['to'])\n #print(entry['accepted'])\n #print(entry['error'])\n```\n\n### Sending to multiple numbers\n\nThe `sendMessage` call `to` parameter can take an array of numbers. If you specify only a single number like `clickatell.sendMessage(1111111111, \"Message\")` the library will automatically convert it to an array for your convenience.\n\nTo send to multiple numbers, just pass a list of numbers like `clickatell.sendMessage([1111111111,2222222222], \"Message\")`\n\nSupported API calls\n------------------\n\nThe available calls are defined in the `clickatell.Transport` interface.\n\n``` python\n\ndef sendMessage(self, to, message, extra={})\n\n```\n\nDealing with extra parameters in sendMessage\n--------------------------------------\n\nFor usability purposes the `sendMessage` call focuses on the recipients and the content. In order to specify and of the additional parameters defined\nin the [Clickatell document](http://www.clickatell.com), you can use the `extra` parameter and pass them as a dictionary.\n\nReceiving and consuming the status callback\n--------------------------------------\n\nThe following will be returned from the callback in two different sets:\n\nDELIVERED_TO_GATEWAY :\n* integrationName\n* messageId\n* requestId\n* clientMessageId\n* to\n* from\n* statusCode\n* status\n* statusDescription\n* timestamp\n\nRECEIVED_BY_RECIPIENT :\n* integrationName\n* messageId\n* requestId\n* clientMessageId\n* to\n* from\n* statusCode\n* status\n* statusDescription\n* timestamp\n\nThere is a python test server included in the clickatell folder.\nTo run this server, you require the endpoints pip package:\n```\npip install endpoints\n```\n\nYou can run the server using the following command:\n```\n endpoints --dir=clickatell/ --prefix=controller --host=:\n```\n\nThis server currently prints out to the server console. Replace the print function with your function name to consume the data.\nAll data is returned in JSON.\n\n## Reference Links and More Info:\n\nFound a bug or missing a feature? Log it here and we will take a look.\nhttps://github.com/clickatell/clickatell-python/issues\n\nRegister a new account to send sms's:\nhttps://www.clickatell.com/sign-up/\n\nLogin to platform for API id, etc:\nhttps://portal.clickatell.com/#/login\n\nRequest Parameters:\nhttps://www.clickatell.com/developers/api-documentation/rest-api-request-parameters/\n\nSend Message Info:\nhttps://www.clickatell.com/developers/api-documentation/rest-api-send-message/\n\nError Messages:\nhttps://www.clickatell.com/developers/api-documentation/rest-api-error-message-descriptions/\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/clickatell/clickatell-python", "keywords": "clickatell,sms,platform", "license": "LICENSE", "maintainer": "", "maintainer_email": "", "name": "clickatell-platform", "package_url": "https://pypi.org/project/clickatell-platform/", "platform": "", "project_url": "https://pypi.org/project/clickatell-platform/", "project_urls": { "Homepage": "https://github.com/clickatell/clickatell-python" }, "release_url": "https://pypi.org/project/clickatell-platform/2.0.1/", "requires_dist": [ "httplib2" ], "requires_python": "", "summary": "Library for interacting with the Clickatell Platform SMS Gateway", "version": "2.0.1" }, "last_serial": 5215724, "releases": { "2.0.0": [ { "comment_text": "", "digests": { "md5": "2e9d8694fcde77a4c104216b6193d0ae", "sha256": "94f50e557a129d83539924c69a71955cf9c6c5c37cb6f4ff8f0e31416cd3129e" }, "downloads": -1, "filename": "clickatell_platform-2.0.0-py2-none-any.whl", "has_sig": false, "md5_digest": "2e9d8694fcde77a4c104216b6193d0ae", "packagetype": "bdist_wheel", "python_version": "py2", "requires_python": null, "size": 7544, "upload_time": "2017-10-20T08:50:09", "url": "https://files.pythonhosted.org/packages/79/3a/13c922d053354cec08fbfe9311f301599fce9787d4ab2f67e61506dc1588/clickatell_platform-2.0.0-py2-none-any.whl" } ], "2.0.1": [ { "comment_text": "", "digests": { "md5": "22883282b6ed3f0a75bf3035469bde23", "sha256": "8ef0712794dc39ccfd4b32f22c6bbbcf8fa48dab5a11375e829aa800b3601a0f" }, "downloads": -1, "filename": "clickatell_platform-2.0.1-py2-none-any.whl", "has_sig": false, "md5_digest": "22883282b6ed3f0a75bf3035469bde23", "packagetype": "bdist_wheel", "python_version": "py2", "requires_python": null, "size": 6499, "upload_time": "2019-05-02T07:45:13", "url": "https://files.pythonhosted.org/packages/a6/6a/9ebe234da1e7cd3f7616f67f191bf15e05eefb9f349fc2ab2476c4e79381/clickatell_platform-2.0.1-py2-none-any.whl" }, { "comment_text": "", "digests": { "md5": "624c5a397ac41dd33ebd916d356d8cbc", "sha256": "015609e7165912257624a9303b23f52dfc958a53559637aeaad28a8fd16444dd" }, "downloads": -1, "filename": "clickatell_platform-2.0.1-py3-none-any.whl", "has_sig": false, "md5_digest": "624c5a397ac41dd33ebd916d356d8cbc", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 6498, "upload_time": "2019-05-02T07:45:14", "url": "https://files.pythonhosted.org/packages/b7/9c/0e9fa5f2ab20a9dfe14099ac9335a278457156b7c02456b071c0bbfb0b10/clickatell_platform-2.0.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "440a91a222b4e7816a4e02c87b137ad8", "sha256": "e45b7b47bbf359689bcb3311f92e3d1cd6ce6cb8961dfd5478ccbc271406171c" }, "downloads": -1, "filename": "clickatell-platform-2.0.1.tar.gz", "has_sig": false, "md5_digest": "440a91a222b4e7816a4e02c87b137ad8", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5609, "upload_time": "2019-05-02T07:45:16", "url": "https://files.pythonhosted.org/packages/c6/7e/39a79ba5bf512c8be185182913f845e57163a57c569b16a82bb29c10ce97/clickatell-platform-2.0.1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "22883282b6ed3f0a75bf3035469bde23", "sha256": "8ef0712794dc39ccfd4b32f22c6bbbcf8fa48dab5a11375e829aa800b3601a0f" }, "downloads": -1, "filename": "clickatell_platform-2.0.1-py2-none-any.whl", "has_sig": false, "md5_digest": "22883282b6ed3f0a75bf3035469bde23", "packagetype": "bdist_wheel", "python_version": "py2", "requires_python": null, "size": 6499, "upload_time": "2019-05-02T07:45:13", "url": "https://files.pythonhosted.org/packages/a6/6a/9ebe234da1e7cd3f7616f67f191bf15e05eefb9f349fc2ab2476c4e79381/clickatell_platform-2.0.1-py2-none-any.whl" }, { "comment_text": "", "digests": { "md5": "624c5a397ac41dd33ebd916d356d8cbc", "sha256": "015609e7165912257624a9303b23f52dfc958a53559637aeaad28a8fd16444dd" }, "downloads": -1, "filename": "clickatell_platform-2.0.1-py3-none-any.whl", "has_sig": false, "md5_digest": "624c5a397ac41dd33ebd916d356d8cbc", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 6498, "upload_time": "2019-05-02T07:45:14", "url": "https://files.pythonhosted.org/packages/b7/9c/0e9fa5f2ab20a9dfe14099ac9335a278457156b7c02456b071c0bbfb0b10/clickatell_platform-2.0.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "440a91a222b4e7816a4e02c87b137ad8", "sha256": "e45b7b47bbf359689bcb3311f92e3d1cd6ce6cb8961dfd5478ccbc271406171c" }, "downloads": -1, "filename": "clickatell-platform-2.0.1.tar.gz", "has_sig": false, "md5_digest": "440a91a222b4e7816a4e02c87b137ad8", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5609, "upload_time": "2019-05-02T07:45:16", "url": "https://files.pythonhosted.org/packages/c6/7e/39a79ba5bf512c8be185182913f845e57163a57c569b16a82bb29c10ce97/clickatell-platform-2.0.1.tar.gz" } ] }