azure-communication-callautomation 1.3.0b2

Microsoft Azure Communication Call Automation Client Library for Python

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 | Product documentation

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.8 or later is required to use this package.
• You need an Azure subscription to use this package.
• A deployed Communication Services resource. You can use the Azure Portal or the Azure PowerShell to set it up.

Installing

Install the Azure Communication Service Call Automation SDK.

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 for detail.

Examples

Initialize CallAutomationClient

from azure.identity import DefaultAzureCredential
from azure.communication.callautomation import (CallAutomationClient)

# Your unique Azure Communication service endpoint
endpoint_url = '<ENDPOINT>'
credential = DefaultAzureCredential()
client = CallAutomationClient(endpoint_url, credential)

Create Call

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(
    target_participant=user,
    callback_url=callback_url
)

# this id can be used to do further actions in the call
call_connection_id = result.call_connection_id

Play Media

# 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_to_all(my_file)

Troubleshooting

Next steps

• Call Automation Overview
• Incoming Call Concept
• Build a customer interaction workflow using Call Automation
• Redirect inbound telephony calls with Call Automation
• Quickstart: Play action
• Quickstart: Recognize action
• Read more about Call Recording in Azure Communication Services
• Record and download calls with Event Grid

Provide Feedback

If you encounter any bugs or have suggestions, please file an issue in the 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 [e-mail] with any additional questions or comments.