{
"info": {
"author": "Voximplant",
"author_email": "support@voximplant.com",
"bugtrack_url": null,
"classifiers": [
"License :: OSI Approved :: MIT License",
"Operating System :: OS Independent",
"Programming Language :: Python"
],
"description": "\nVoximplant API client library\n=============================\n\nVersion 1.0\n~~~~~~~~~~~\n\nPrerequisites\n-------------\n\nIn order to use the Voximplant Python SDK, you need the following:\n\n\n#. A developer account. If you don't have one, `sign up here `_.\n#. A private API key. There are 2 options to obtain it: \n\n #. Either generate it in the `Voximplant Control panel `_\n #. Or call the `CreateKey `_ HTTP API method with the specified `authentication parameters `_. You'll receive a response with the **result** field in it. Save the **result** value in a file (since we don't store the keys, save it securely on your side).\n\n#. Python 2.x or 3.x runtime with ``pip`` and ``setuptools``\\ >=18.5 installed\n\nHow to use\n----------\n\nGo to your project folder and install the SDK using ``pip``\\ :\n\n.. code-block:: bash\n\n python -m pip install --user voximplant-apiclient\n\nThen import the SDK in your script\n\n.. code-block:: python\n\n from voximplant.apiclient import VoximplantAPI\n\nNext, specify the path to the JSON service account file either in the constructor or using the environment.\n\n**constructor**\\ :\n\n.. code-block:: python\n\n api = VoximplantAPI(\"/path/to/credentials.json\")\n\n**env**\\ :\n\n.. code-block:: bash\n\n export VOXIMPLANT_CREDENTIALS=/path/to/credentials.json\n\nExamples\n--------\n\nStart a scenario\n^^^^^^^^^^^^^^^^\n\n.. code-block:: python\n\n from voximplant.apiclient import VoximplantAPI, VoximplantException\n\n if __name__ == \"__main__\":\n api = VoximplantAPI(\"credentials.json\")\n\n # Start a scenario of the user 1\n\n RULE_ID = 1\n SCRIPT_CUSTOM_DATA = \"mystr\"\n USER_ID = 1\n\n try:\n res = api.start_scenarios(RULE_ID, script_custom_data=SCRIPT_CUSTOM_DATA, user_id=USER_ID)\n print(res)\n except VoximplantException as e:\n print(\"Error: {}\".format(e.message))\n\nSend an SMS\n^^^^^^^^^^^\n\n.. code-block:: python\n\n from voximplant.apiclient import VoximplantAPI, VoximplantException\n\n if __name__ == \"__main__\":\n api = VoximplantAPI(\"credentials.json\")\n\n # Send the SMS with the \"Test message\" text from the phone number 447443332211 to the phone number 447443332212\n\n SOURCE = \"447443332211\"\n DESTINATION = \"447443332212\"\n SMS_BODY = \"Test message\"\n\n try:\n res = api.send_sms_message(SOURCE, DESTINATION, SMS_BODY)\n print(res)\n except VoximplantException as e:\n print(\"Error: {}\".format(e.message))\n\nGet a call history item\n^^^^^^^^^^^^^^^^^^^^^^^\n\n.. code-block:: python\n\n from voximplant.apiclient import VoximplantAPI, VoximplantException\n import pytz\n import datetime\n\n if __name__ == \"__main__\":\n api = VoximplantAPI(\"credentials.json\")\n\n # Get the first call session history record from the 2012-01-01 00:00:00 UTC to the 2014-01-01 00:00:00 UTC\n\n FROM_DATE = datetime.datetime(2012, 1, 1, 0, 0, 0, pytz.utc)\n TO_DATE = datetime.datetime(2014, 1, 1, 0, 0, 0, pytz.utc)\n COUNT = 1\n\n try:\n res = api.get_call_history(FROM_DATE, TO_DATE, count=COUNT)\n print(res)\n except VoximplantException as e:\n print(\"Error: {}\".format(e.message))\n\n\n",
"description_content_type": "",
"docs_url": null,
"download_url": "",
"downloads": {
"last_day": -1,
"last_month": -1,
"last_week": -1
},
"home_page": "https://voximplant.com/",
"keywords": "",
"license": "",
"maintainer": "",
"maintainer_email": "",
"name": "voximplant-apiclient",
"package_url": "https://pypi.org/project/voximplant-apiclient/",
"platform": "",
"project_url": "https://pypi.org/project/voximplant-apiclient/",
"project_urls": {
"Homepage": "https://voximplant.com/"
},
"release_url": "https://pypi.org/project/voximplant-apiclient/1.0.9/",
"requires_dist": [
"cryptography",
"pyjwt",
"pytz",
"requests"
],
"requires_python": "",
"summary": "Voximplant API client library",
"version": "1.0.9"
},
"last_serial": 5772611,
"releases": {
"1.0.0": [
{
"comment_text": "",
"digests": {
"md5": "891ecb4b472c9cf73ed37c409671964e",
"sha256": "15c1f71e1d7c01f5ff72a8fba83fcbfd1056ecfbddb09ed6f82231762b4655f8"
},
"downloads": -1,
"filename": "voximplant_apiclient-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "891ecb4b472c9cf73ed37c409671964e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 38228,
"upload_time": "2019-06-03T15:37:17",
"url": "https://files.pythonhosted.org/packages/7e/8a/cf16b8dc0a3d3dc23bf01990336bcddc661b746fc44ad13efe5c759a011d/voximplant_apiclient-1.0.0-py3-none-any.whl"
},
{
"comment_text": "",
"digests": {
"md5": "cde90f1759b7c6cf6b93cc469ead070d",
"sha256": "5f1a6ce3f7736539e4743aae076ce749d024d338bceec3246fc0032e5bbf6708"
},
"downloads": -1,
"filename": "voximplant-apiclient-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "cde90f1759b7c6cf6b93cc469ead070d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 35543,
"upload_time": "2019-06-03T15:37:20",
"url": "https://files.pythonhosted.org/packages/b8/46/2f35f4c311192f3e20d195872244a20ca6a9dbf42046f118fc5b7b3b167d/voximplant-apiclient-1.0.0.tar.gz"
}
],
"1.0.1": [
{
"comment_text": "",
"digests": {
"md5": "531664e6dbac06ecec7a17b00dd8eb77",
"sha256": "6d8f94483e00a1ccd510c68808ed4520dd13ca0b0217c1a13b6a8c0099851554"
},
"downloads": -1,
"filename": "voximplant_apiclient-1.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "531664e6dbac06ecec7a17b00dd8eb77",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 37919,
"upload_time": "2019-06-05T19:12:11",
"url": "https://files.pythonhosted.org/packages/47/7a/0754d209105aa50be58ad95e68670f06b6cac3eb6a9c72a3b334f0d309fc/voximplant_apiclient-1.0.1-py3-none-any.whl"
},
{
"comment_text": "",
"digests": {
"md5": "08f25f77ff3c6d5809fc9c199aee4f82",
"sha256": "25a2fb3227156852b2be8937049aab0ea257f9868fa4cfa7a5893636b9532e6e"
},
"downloads": -1,
"filename": "voximplant-apiclient-1.0.1.tar.gz",
"has_sig": false,
"md5_digest": "08f25f77ff3c6d5809fc9c199aee4f82",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 35414,
"upload_time": "2019-06-05T19:12:13",
"url": "https://files.pythonhosted.org/packages/d3/e0/e25fae2c3c3296fab0b03825c00909b44952ae6c8496cac4801d0d113525/voximplant-apiclient-1.0.1.tar.gz"
}
],
"1.0.3": [
{
"comment_text": "",
"digests": {
"md5": "a39fec72711095df8578703bb52948a4",
"sha256": "85fe90200879e2e1cfad17bfe891e11da869052759d1e05f4d4407ad05c51bc9"
},
"downloads": -1,
"filename": "voximplant_apiclient-1.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a39fec72711095df8578703bb52948a4",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 38022,
"upload_time": "2019-06-05T19:42:36",
"url": "https://files.pythonhosted.org/packages/b2/20/585292cdb1ee46cc5e9a8aba52128f8d55681a9ead04c6246821c5c6e018/voximplant_apiclient-1.0.3-py3-none-any.whl"
},
{
"comment_text": "",
"digests": {
"md5": "6b1d2be3d5282cdd49693d4fd1e1c523",
"sha256": "edc2b3f7a09fbe9195bc58d3dcfe7f0439e3aeb290bef65b6c92d388c4f19215"
},
"downloads": -1,
"filename": "voximplant-apiclient-1.0.3.tar.gz",
"has_sig": false,
"md5_digest": "6b1d2be3d5282cdd49693d4fd1e1c523",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 35466,
"upload_time": "2019-06-05T19:42:38",
"url": "https://files.pythonhosted.org/packages/d3/5c/4d9bad8e3945cdb4ac7fd62d6c5e8ccb90bfefe22a147698d7248aa7c57b/voximplant-apiclient-1.0.3.tar.gz"
}
],
"1.0.4": [
{
"comment_text": "",
"digests": {
"md5": "115de1044295e62afe1145f7710d6e1e",
"sha256": "c277d9a014272578887500e78125f4f5cc4bded1e8dd7940896999ac9779891c"
},
"downloads": -1,
"filename": "voximplant_apiclient-1.0.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "115de1044295e62afe1145f7710d6e1e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 38423,
"upload_time": "2019-06-07T10:12:58",
"url": "https://files.pythonhosted.org/packages/e6/d7/673ba5e8f999b7684fcba44227bae95daf414a38e6d6758f76de5f491ab0/voximplant_apiclient-1.0.4-py3-none-any.whl"
},
{
"comment_text": "",
"digests": {
"md5": "662f8aa4df1e082e8d20c453a2ab96a3",
"sha256": "683676e01adcee8fd980b68a7f536299065f5b90b7dcc147850c6e821bb59cf9"
},
"downloads": -1,
"filename": "voximplant-apiclient-1.0.4.tar.gz",
"has_sig": false,
"md5_digest": "662f8aa4df1e082e8d20c453a2ab96a3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 35650,
"upload_time": "2019-06-07T10:13:00",
"url": "https://files.pythonhosted.org/packages/8c/bc/c58a3aa50c714dc5beffafad1c03a249858af41d05fb7a6405a7428b02b5/voximplant-apiclient-1.0.4.tar.gz"
}
],
"1.0.7": [
{
"comment_text": "",
"digests": {
"md5": "bc45c0283b78cb928fff46a44eb3ec7a",
"sha256": "02f1ada76add2bd4e582b2dd32cd72ffb92fbb224e961059a07bdb96fce013a5"
},
"downloads": -1,
"filename": "voximplant_apiclient-1.0.7-py3-none-any.whl",
"has_sig": false,
"md5_digest": "bc45c0283b78cb928fff46a44eb3ec7a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 40120,
"upload_time": "2019-07-30T20:18:24",
"url": "https://files.pythonhosted.org/packages/6b/c6/dddc7adabd18030b967d5da6019e3f6231da1528b5e15da011cf40189e41/voximplant_apiclient-1.0.7-py3-none-any.whl"
},
{
"comment_text": "",
"digests": {
"md5": "2531854b13561b403753da8ac0e9bf39",
"sha256": "71f306e187fe598e2c8f44d137ab7d3afffd763a12ef6a849bb4d18313183736"
},
"downloads": -1,
"filename": "voximplant-apiclient-1.0.7.tar.gz",
"has_sig": false,
"md5_digest": "2531854b13561b403753da8ac0e9bf39",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 37350,
"upload_time": "2019-07-30T20:18:26",
"url": "https://files.pythonhosted.org/packages/73/ca/70f7504d51b3c74b11b03873c5ac59a68f40f9d9d5a71a3387a070cd3d79/voximplant-apiclient-1.0.7.tar.gz"
}
],
"1.0.9": [
{
"comment_text": "",
"digests": {
"md5": "d2259cca28d1a33113c80a25533ae1b3",
"sha256": "3ff8ce59c6b3deb6263ad59179d5ee003d394020e745c1ca3340d679f2286dfb"
},
"downloads": -1,
"filename": "voximplant_apiclient-1.0.9-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d2259cca28d1a33113c80a25533ae1b3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 40780,
"upload_time": "2019-09-02T20:44:01",
"url": "https://files.pythonhosted.org/packages/29/f0/6bd92fe0cdc485d53941f2a5d4635124b881f7c9076290c731a817d52c1a/voximplant_apiclient-1.0.9-py3-none-any.whl"
},
{
"comment_text": "",
"digests": {
"md5": "5269b19d66c4fdfca698daf92eea7239",
"sha256": "22ed4566aad26d6bb27a345850ae00d8d471399628764b82fae396494ab175ae"
},
"downloads": -1,
"filename": "voximplant-apiclient-1.0.9.tar.gz",
"has_sig": false,
"md5_digest": "5269b19d66c4fdfca698daf92eea7239",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 38023,
"upload_time": "2019-09-02T20:44:03",
"url": "https://files.pythonhosted.org/packages/54/53/85ca266e3ece4d49231cd7dd03a360c1eb4c000f0aa0aebcabaf74636077/voximplant-apiclient-1.0.9.tar.gz"
}
]
},
"urls": [
{
"comment_text": "",
"digests": {
"md5": "d2259cca28d1a33113c80a25533ae1b3",
"sha256": "3ff8ce59c6b3deb6263ad59179d5ee003d394020e745c1ca3340d679f2286dfb"
},
"downloads": -1,
"filename": "voximplant_apiclient-1.0.9-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d2259cca28d1a33113c80a25533ae1b3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 40780,
"upload_time": "2019-09-02T20:44:01",
"url": "https://files.pythonhosted.org/packages/29/f0/6bd92fe0cdc485d53941f2a5d4635124b881f7c9076290c731a817d52c1a/voximplant_apiclient-1.0.9-py3-none-any.whl"
},
{
"comment_text": "",
"digests": {
"md5": "5269b19d66c4fdfca698daf92eea7239",
"sha256": "22ed4566aad26d6bb27a345850ae00d8d471399628764b82fae396494ab175ae"
},
"downloads": -1,
"filename": "voximplant-apiclient-1.0.9.tar.gz",
"has_sig": false,
"md5_digest": "5269b19d66c4fdfca698daf92eea7239",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 38023,
"upload_time": "2019-09-02T20:44:03",
"url": "https://files.pythonhosted.org/packages/54/53/85ca266e3ece4d49231cd7dd03a360c1eb4c000f0aa0aebcabaf74636077/voximplant-apiclient-1.0.9.tar.gz"
}
]
}