Metadata-Version: 2.1
Name: azure-communication-callautomation
Version: 1.1.0
Summary: Microsoft Azure Communication Call Automation Client Library for Python
Home-page: https://github.com/Azure/azure-sdk-for-python
Author: Microsoft Corporation
Author-email: azpysdkhelp@microsoft.com
License: MIT License
Project-URL: Bug Reports, https://github.com/Azure/azure-sdk-for-python/issues
Project-URL: Source, https://github.com/Azure/azure-sdk-for-python
Description: # Azure Communication Call Automation client library for Python
        
        This package contains a Python SDK for Azure Communication Call Automation. Call Automation provides developers the ability to build server-based, intelligent call workflows, and call recording for voice and PSTN channels.
        
        [Overview of Call Automation][overview] | [Product documentation][product_docs]
        
        ## _Disclaimer_
        _Azure SDK Python packages support for Python 2.7 has ended 01 January 2022. For more information and questions, please
        refer to https://github.com/Azure/azure-sdk-for-python/issues/20691_
        
        ## Getting started
        ### Prerequisites
        - Python 3.7 or later is required to use this package.
        - You need an [Azure subscription][azure_sub] to use this package.
        - A deployed Communication Services resource. You can use the [Azure Portal][azure_portal] or the [Azure PowerShell][azure_powershell] to set it up.
        
        ### Installing
        Install the Azure Communication Service Call Automation SDK.
        
        ```bash
        pip install azure-communication-callautomation
        ```
        
        ## Key concepts
        | Name                 | Description                                                                                                                                                                                                                                                                                                                              |
        | -------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
        | CallAutomationClient | `CallAutomationClient` is the primary interface for developers using this client library. It can be used to initiate calls by `createCall` or `answerCall`. It can also be used to do recording actions such as `startRecording`                                                                                                         |                                                                      |
        | CallConnectionClient | `CallConnectionClient` represents a ongoing call. Once the call is established with `createCall` or `answerCall`, further actions can be performed for the call, such as `transfer` or `play_media`.                                                                                                                                     |                                                                                                                                                               |
        | Callback Events      | Callback events are events sent back during duration of the call. It gives information and state of the call, such as `CallConnected`. `CallbackUrl` must be provided during `createCall` and `answerCall`, and callback events will be sent to this url. |
        | Incoming Call Event  | When incoming call happens (that can be answered with `answerCall`), incoming call eventgrid event will be sent. This is different from Callback events above, and should be setup on Azure portal. See [Incoming Call][incomingcall] for detail.                                                                                        |
        
        ## Examples
        ### Initialize CallAutomationClient
        ```Python
        from azure.communication.callautomation import (CallAutomationClient)
        
        # Your unique Azure Communication service endpoint
        endpoint_url = '<ENDPOINT>'
        client = CallAutomationClient.from_connection_string(endpoint_url)
        ```
        
        ### Create Call
        ```Python
        from azure.communication.callautomation import (
            CallAutomationClient,
            CommunicationUserIdentifier
        )
        
        # target endpoint for ACS User
        user = CommunicationUserIdentifier("8:acs:...")
        
        # callback url to receive callback events
        callback_url = "https://<MY-EVENT-HANDLER-URL>/events"
        
        # send out the invitation, creating call
        result = client.create_call(user, callback_url)
        
        # this id can be used to do further actions in the call
        call_connection_id = result.call_connection_id
        ```
        
        ### Play Media
        ```Python
        # using call connection id, get call connection
        call_connection = client.get_call_connection(call_connection_id)
        
        # from callconnection of result above, play media to all participants
        my_file = FileSource(url="https://<FILE-SOURCE>/<SOME-FILE>.wav")
        call_connection.play_media(my_file)
        ```
        
        ## Troubleshooting
        ## Next steps
        - [Call Automation Overview][overview]
        - [Incoming Call Concept][incomingcall]
        - [Build a customer interaction workflow using Call Automation][build1]
        - [Redirect inbound telephony calls with Call Automation][build2]
        - [Connect Azure Communication Services with Azure AI services][cognitive_integration]
        - [Quickstart: Play action][build3]
        - [Quickstart: Recognize action][build4]
        - [Read more about Call Recording in Azure Communication Services][recording1]
        - [Record and download calls with Event Grid][recording2]
        
        ## Provide Feedback
        
        If you encounter any bugs or have suggestions, please file an issue in the [Issues](https://github.com/Azure/azure-sdk-for-python/issues) section of the project
        
        ## Contributing
        
        This project welcomes contributions and suggestions. Most contributions require
        you to agree to a Contributor License Agreement (CLA) declaring that you have
        the right to, and actually do, grant us the rights to use your contribution.
        For details, visit https://cla.microsoft.com.
        
        When you submit a pull request, a CLA-bot will automatically determine whether
        you need to provide a CLA and decorate the PR appropriately (e.g., label,
        comment). Simply follow the instructions provided by the bot. You will only
        need to do this once across all repos using our CLA.
        
        This project has adopted the
        [Microsoft Open Source Code of Conduct][code_of_conduct]. For more information,
        see the Code of Conduct FAQ or contact opencode@microsoft.com with any
        additional questions or comments.
        
        <!-- LINKS -->
        [overview]: https://learn.microsoft.com/azure/communication-services/concepts/voice-video-calling/call-automation
        [product_docs]: https://docs.microsoft.com/azure/communication-services/overview
        [azure_cli]: https://docs.microsoft.com/cli/azure
        [azure_sub]: https://azure.microsoft.com/free/
        [azure_portal]: https://portal.azure.com
        [azure_powershell]: https://docs.microsoft.com/powershell/module/az.communication/new-azcommunicationservice
        [build_doc]: https://aka.ms/AzureSDKBundling
        [incomingcall]: https://learn.microsoft.com/azure/communication-services/concepts/voice-video-calling/incoming-call-notification
        [build1]: https://learn.microsoft.com/azure/communication-services/quickstarts/voice-video-calling/callflows-for-customer-interactions?pivots=programming-language-python
        [build2]: https://learn.microsoft.com/azure/communication-services/how-tos/call-automation-sdk/redirect-inbound-telephony-calls?pivots=programming-language-python
        [build3]: https://learn.microsoft.com/azure/communication-services/quickstarts/voice-video-calling/play-action?pivots=programming-language-python
        [build4]: https://learn.microsoft.com/azure/communication-services/quickstarts/voice-video-calling/recognize-action?pivots=programming-language-python
        [recording1]: https://learn.microsoft.com/azure/communication-services/concepts/voice-video-calling/call-recording
        [recording2]: https://learn.microsoft.com/azure/communication-services/quickstarts/voice-video-calling/get-started-call-recording?pivots=programming-language-python
        [cognitive_integration]: https://learn.microsoft.com/azure/communication-services/concepts/call-automation/azure-communication-services-azure-cognitive-services-integration
        
Keywords: azure,azure sdk
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: License :: OSI Approved :: MIT License
Requires-Python: >=3.7
Description-Content-Type: text/markdown
