Name | anonpi JSON |
Version |
2.0.1
JSON |
| download |
home_page | None |
Summary | The "anonpi" module is a Python package designed to streamline interactions with calling systems. It simplifies the development of applications that require features like machine detection, IVR, DTMF handling, call recording, playback, and more. This module provides a clean and intuitive API for seamless integration into Python applications. |
upload_time | 2024-06-09 10:49:50 |
maintainer | None |
docs_url | None |
author | EvenueStar |
requires_python | >=3.9 |
license | MIT |
keywords |
anonpi
python
calling
systems
api
wrapper
module
|
VCS |
|
bugtrack_url |
|
requirements |
No requirements were recorded.
|
Travis-CI |
No Travis.
|
coveralls test coverage |
No coveralls.
|
# anonpi: Python Module for Calling Systems
The **anonpi** module is a powerful Python package that provides a convenient interface for interacting with calling systems. It simplifies the development of applications that require functionalities such as machine detection, IVR (Interactive Voice Response), DTMF (Dual-Tone Multi-Frequency) handling, recording, playback, and more.
## Key Features
- **Machine Detection:** Easily detect whether a call is being answered by a human or an automated system, enabling intelligent call handling and routing.
- **IVR Support:** Build interactive voice response systems by creating menus, prompts, and collecting user input through voice or DTMF tones.
- **DTMF Handling:** Efficiently capture and process DTMF tones (telephone keypad input) during calls for user interaction, menu navigation, and decision-making.
- **Call Recording:** Seamlessly record incoming or outgoing calls, enabling compliance with legal requirements, quality monitoring, and archiving for later analysis.
- **Playback Functionality:** Retrieve and play back pre-recorded audio files during calls, enhancing the user experience and providing personalized content.
- **Call Control:** Take control of call initiation, termination, and manipulation, allowing for call transfers, forwarding, muting, and more.
## Usage
The **anonpi** module provides a clean and intuitive API, making it easy to integrate calling functionalities into your Python applications. Here's an example of how you can use the module to perform machine detection during a call:
```python
import anonpi
anonpi.api_key = "<API KEY>"
call = anonpi.Call.create(
from_number="18888888888",
to_number="1234567890",
callback_url="https://callback.url",
amd=False
)
# operations using call
call.gather_using_audio(
audio_url="https://audio.url",
dtmf_digits="6"
)
# last hangup the call
call.hangup()
```
## Getting Started
To install the anonpi module, use the following command:
```bash
pip install anonpi
```
> Add any additional installation instructions or requirements here.
> Disclaimer: Ensure compliance with all legal and regulatory requirements when using the "anonpi" module for call recording or related functionalities.
### Additional Resources
- [Documentation Link](https://docs.anonpi.co)
- [GitHub Repository](https://github.com/evenuestar/anonpi)
Raw data
{
"_id": null,
"home_page": null,
"name": "anonpi",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "anonpi, python, calling, systems, api, wrapper, module",
"author": "EvenueStar",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/09/09/1f7438b9645ed7e75398999cee22817f7b6f4eab4ad3ba6616b597c31c5f/anonpi-2.0.1.tar.gz",
"platform": null,
"description": "# anonpi: Python Module for Calling Systems\n\nThe **anonpi** module is a powerful Python package that provides a convenient interface for interacting with calling systems. It simplifies the development of applications that require functionalities such as machine detection, IVR (Interactive Voice Response), DTMF (Dual-Tone Multi-Frequency) handling, recording, playback, and more.\n\n## Key Features\n\n- **Machine Detection:** Easily detect whether a call is being answered by a human or an automated system, enabling intelligent call handling and routing.\n- **IVR Support:** Build interactive voice response systems by creating menus, prompts, and collecting user input through voice or DTMF tones.\n- **DTMF Handling:** Efficiently capture and process DTMF tones (telephone keypad input) during calls for user interaction, menu navigation, and decision-making.\n- **Call Recording:** Seamlessly record incoming or outgoing calls, enabling compliance with legal requirements, quality monitoring, and archiving for later analysis.\n- **Playback Functionality:** Retrieve and play back pre-recorded audio files during calls, enhancing the user experience and providing personalized content.\n- **Call Control:** Take control of call initiation, termination, and manipulation, allowing for call transfers, forwarding, muting, and more.\n\n## Usage\n\nThe **anonpi** module provides a clean and intuitive API, making it easy to integrate calling functionalities into your Python applications. Here's an example of how you can use the module to perform machine detection during a call:\n\n```python\nimport anonpi\n\nanonpi.api_key = \"<API KEY>\"\n\ncall = anonpi.Call.create(\n from_number=\"18888888888\",\n to_number=\"1234567890\",\n callback_url=\"https://callback.url\",\n amd=False\n)\n\n# operations using call\ncall.gather_using_audio(\n audio_url=\"https://audio.url\",\n dtmf_digits=\"6\"\n )\n\n# last hangup the call\ncall.hangup()\n```\n\n## Getting Started\nTo install the anonpi module, use the following command:\n\n```bash\npip install anonpi\n```\n\n> Add any additional installation instructions or requirements here.\n\n> Disclaimer: Ensure compliance with all legal and regulatory requirements when using the \"anonpi\" module for call recording or related functionalities.\n\n### Additional Resources\n- [Documentation Link](https://docs.anonpi.co)\n- [GitHub Repository](https://github.com/evenuestar/anonpi)\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "The \"anonpi\" module is a Python package designed to streamline interactions with calling systems. It simplifies the development of applications that require features like machine detection, IVR, DTMF handling, call recording, playback, and more. This module provides a clean and intuitive API for seamless integration into Python applications.",
"version": "2.0.1",
"project_urls": null,
"split_keywords": [
"anonpi",
" python",
" calling",
" systems",
" api",
" wrapper",
" module"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6da4703038b886347395c0fd8971497e6652a8cc825159d310fea40a6ed3e967",
"md5": "8a9e8193aef1cb51e89779f8d028bbac",
"sha256": "3a9faedd5621f3c55e038dfae40c0c8c89b90af8af06b6ed962ed2503ecf3e21"
},
"downloads": -1,
"filename": "anonpi-2.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8a9e8193aef1cb51e89779f8d028bbac",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 24547,
"upload_time": "2024-06-09T10:49:48",
"upload_time_iso_8601": "2024-06-09T10:49:48.211704Z",
"url": "https://files.pythonhosted.org/packages/6d/a4/703038b886347395c0fd8971497e6652a8cc825159d310fea40a6ed3e967/anonpi-2.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "09091f7438b9645ed7e75398999cee22817f7b6f4eab4ad3ba6616b597c31c5f",
"md5": "7a4b7f53f9009b3569786121e8803113",
"sha256": "e44d106e6a1f7a37c281e23e4937849c2508bc119d4f914a26f9ad3f56e3656e"
},
"downloads": -1,
"filename": "anonpi-2.0.1.tar.gz",
"has_sig": false,
"md5_digest": "7a4b7f53f9009b3569786121e8803113",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 17413,
"upload_time": "2024-06-09T10:49:50",
"upload_time_iso_8601": "2024-06-09T10:49:50.047022Z",
"url": "https://files.pythonhosted.org/packages/09/09/1f7438b9645ed7e75398999cee22817f7b6f4eab4ad3ba6616b597c31c5f/anonpi-2.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-09 10:49:50",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "anonpi"
}