Azure Communication Services

https://learn.microsoft.com/en-us/azure/communication-services/
Admin
Azure Communication Services is a cloud-based platform offering multichannel communication APIs for...
Tokens:1,857,648
Snippets:15,466
Trust Score:10
Update:3 days ago
Show doc for...
Tokens:
Raw
### Install dependencies with npm run setup

Source: https://learn.microsoft.com/en-us/azure/communication-services/samples/calling-hero-sample

Run this command to install the project dependencies before starting the calling app locally.

```bash
npm run setup

```

--------------------------------

### Install dependencies and run the application

Source: https://learn.microsoft.com/en-us/azure/communication-services/tutorials/calling-widget/calling-widget-tutorial

Execute these commands in your terminal to install the required project dependencies and start the development server.

```bash
# Install the new dependencies
npm install

# run the React app
npm run dev
```

--------------------------------

### Run the React development server

Source: https://learn.microsoft.com/en-us/azure/communication-services/tutorials/call-readiness/call-readiness-overview

Start the development server to test the application setup.

```bash
# Run the React App
npm run dev
```

--------------------------------

### Start the calling app with npm run start

Source: https://learn.microsoft.com/en-us/azure/communication-services/samples/calling-hero-sample

Starts the client server on port 3000 and an API server on port 8080 for token minting. Requires dependencies to be installed first.

```bash
npm run start

```

--------------------------------

### Compile, Package, and Run the Java Application with Maven

Source: https://learn.microsoft.com/en-us/azure/communication-services/quickstarts/chat/get-started

Executes the build lifecycle and starts the quickstart application from the directory containing pom.xml. Compiles the code, builds the package, and executes com.communication.quickstart.App.

```console
mvn compile

```

```console
mvn package

```

```console
mvn exec:java -Dexec.mainClass="com.communication.quickstart.App" -Dexec.cleanupDaemonThreads=false

```

--------------------------------

### Create project directory and navigate to it

Source: https://learn.microsoft.com/en-us/azure/communication-services/quickstarts/sms/send

Create a new directory called sms-quickstart and change the working directory to it.

```console
mkdir sms-quickstart && cd sms-quickstart

```

--------------------------------

### Run the router-quickstart.py script

Source: https://learn.microsoft.com/en-us/azure/communication-services/quickstarts/router/get-started-router

Executes the quickstart script and displays the expected console output.

```console
python router-quickstart.py

Azure Communication Services - Job Router Quickstart
Worker worker-1 has an active offer for job job-1
Worker worker-1 is assigned job job-1
Worker worker-1 has completed job job-1
Worker worker-1 has closed job job-1
Deleting job job-1
```

--------------------------------

### Get assignment example

Source: https://learn.microsoft.com/en-us/azure/communication-services/quickstarts/tpe/teams-phone-extensibility-rest-api

An example of a GET request and its corresponding JSON response.

```HTTP
GET {endpoint}/access/teamsExtension/tenants/aaaabbbb-0000-cccc-1111-dddd2222eeee/assignments/aaaaaaaa-bbbb-cccc-1111-222222222222?api-version=2025-06-30
```

```JSON
{
  "objectId": "aaaaaaaa-bbbb-cccc-1111-222222222222",
  "tenantId": "aaaabbbb-0000-cccc-1111-dddd2222eeee",
  "principalType": "user",
  "clientIds": ["00001111-aaaa-2222-bbbb-3333cccc4444"]
}
```

--------------------------------

### Set up the C# Program.cs structure

Source: https://learn.microsoft.com/en-us/azure/communication-services/quickstarts/rooms/get-started-rooms

Import the necessary namespaces and define the main entry point for the RoomsQuickstart application.

```csharp

using System;
using Azure;
using Azure.Core;
using Azure.Communication.Rooms;

namespace RoomsQuickstart
{
    class Program
    {
        static async System.Threading.Tasks.Task Main(string[] args)
        {
            Console.WriteLine("Azure Communication Services - Rooms Quickstart");

            // Quickstart code goes here
        }
    }
}


```

--------------------------------

### Get ServerCallId to start recording

Source: https://learn.microsoft.com/en-us/azure/communication-services/how-tos/calling-sdk/record-calls

Obtain the ServerCallId from the call to send to your recording server to start the recording process.

```APIDOC
## Get ServerCallId to start recording

### Description
Obtain the ServerCallId from the call to send to your recording server to start the recording process.

### Method
N/A (SDK method call)

### Endpoint
N/A

### Parameters
None

### Request Example
```java
try {
    String serverCallId = call.getInfo().getServerCallId().get();
    // Send serverCallId to your recording server to start the call recording.
} catch (ExecutionException | InterruptedException e) {

} catch (UnsupportedOperationException unsupportedOperationException) {

}
```

### Response
#### Success Response
- **serverCallId** (String) - The server call ID to send to the recording server.

#### Response Example
```java
String serverCallId = call.getInfo().getServerCallId().get();
```
```

--------------------------------

### Create project directory

Source: https://learn.microsoft.com/en-us/azure/communication-services/quickstarts/telephony/voice-routing-sdk-config

Initialize a new directory for the direct routing quickstart project.

```bash
mkdir direct-routing-quickstart && cd direct-routing-quickstart
```

--------------------------------

### Create project directory

Source: https://learn.microsoft.com/en-us/azure/communication-services/quickstarts/chat/get-started

Creates a new directory named chat-quickstart and navigates into it from the command line.

```console
mkdir chat-quickstart && cd chat-quickstart

```

--------------------------------

### Get call start time in Swift

Source: https://learn.microsoft.com/en-us/azure/communication-services/tutorials/call-duration

Implement the didUpdateStartTime method on the CallDelegate to receive the call start time as a Date object.

```swift
class CallObserver : NSObject, CallDelegate
{
    // subscribe to didUpdateStartTime
    public func call(_ call: Call, didUpdateStartTime args: PropertyChangedEventArgs) {
        let dateFormatter = DateFormatter()
        dateFormatter.dateFormat = "yyyy-MM-dd HH:mm:ss"
        dateFormatter.timeZone = TimeZone.current
        let dateString = dateFormatter.string(from: call.startTime)
        print("==> didUpdateStartTime for call: \(dateString)")
    }
}

// set call delegate
call.delegate = CallObserver()
```

--------------------------------

### Set up the Python application framework

Source: https://learn.microsoft.com/en-us/azure/communication-services/quickstarts/rooms/get-started-rooms

Basic structure for the rooms-quickstart.py file, including necessary imports and the class definition.

```python
import os
from datetime import datetime, timedelta
from azure.core.exceptions import HttpResponseError
from azure.communication.rooms import (
    RoomsClient,
    RoomParticipant,
    ParticipantRole
)

class RoomsQuickstart(object):
    print("Azure Communication Services - Rooms Quickstart")
    #room method implementations goes here

if __name__ == '__main__':
    rooms = RoomsQuickstart()
```

--------------------------------

### Get call start time in Java

Source: https://learn.microsoft.com/en-us/azure/communication-services/tutorials/call-duration

Subscribe to the addOnStartTimeUpdatedListener on the CommonCall object to receive the call start time as a Date object.

```java
CommonCall call;
PropertyChangedListener onStartTimeUpdated = this::OnStartTimeUpdated;

// subscribe to start time updated
call.addOnStartTimeUpdatedListener(onStartTimeUpdated);

// get start time
private void OnStartTimeUpdated(PropertyChangedEvent propertyChangedEvent) {
    SimpleDateFormat dateFormatter = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
    dateFormatter.setTimeZone(TimeZone.getDefault());
    String dateString = dateFormatter.format(call.getStartTime());
    // dateString with dateFormatter
}

// unsubscribe to start time updated
call.removeOnStartTimeUpdatedListener(onStartTimeUpdated);
```

--------------------------------

### Set up application framework

Source: https://learn.microsoft.com/en-us/azure/communication-services/quickstarts/router/get-started-router

Initialize the index.js file with the Job Router client and a main function structure.

```javascript
const JobRouterClient = require('@azure-rest/communication-job-router').default;

const main = async () => {
  console.log("Azure Communication Services - Job Router Quickstart")

  // Quickstart code goes here

};

main().catch((error) => {
  console.log("Encountered an error");
  console.log(error);
})
```

--------------------------------

### Start Twilio Chat Thread

Source: https://learn.microsoft.com/en-us/azure/communication-services/tutorials/migrating-to-azure-communication-services-chat

Example of creating a chat thread in Twilio Conversations.

```javascript
let conversation = await client.createConversation({
    friendlyName: "Testing Chat"
});
await conversation.join();
```

--------------------------------

### Create project directory and initialize npm package

Source: https://learn.microsoft.com/en-us/azure/communication-services/quickstarts/chat/get-started

Create a new directory for the chat quickstart application and generate a package.json file with default settings.

```console
mkdir chat-quickstart && cd chat-quickstart

```

```console
npm init -y

```

--------------------------------

### Create a new project directory

Source: https://learn.microsoft.com/en-us/azure/communication-services/quickstarts/email/send-email

Creates a directory named email-quickstart and navigates into it from your terminal or command window.

```console
mkdir email-quickstart && cd email-quickstart

```

--------------------------------

### Get ServerCallId to start recording

Source: https://learn.microsoft.com/en-us/azure/communication-services/how-tos/calling-sdk/record-calls

Retrieve the ServerCallId from the call info to send to your server for initiating the recording process.

```java
try {
    String serverCallId = call.getInfo().getServerCallId().get();
    // Send serverCallId to your recording server to start the call recording.
} catch (ExecutionException | InterruptedException e) {

} catch (UnsupportedOperationException unsupportedOperationException) {

}
```

--------------------------------

### Initialize Python application

Source: https://learn.microsoft.com/en-us/azure/communication-services/quickstarts/telephony/number-lookup

Create the number_lookup_sample.py file with the basic structure for the lookup quickstart.

```Python
import os
from azure.communication.phonenumbers import PhoneNumbersClient

try:
   print('Azure Communication Services - Number Lookup Quickstart')
   # Quickstart code goes here
except Exception as ex:
   print('Exception:')
   print(ex)
```

--------------------------------

### Check microphone permission before call

Source: https://learn.microsoft.com/en-us/azure/communication-services/resources/troubleshooting/voice-video-calling/references/ufd/microphone-permission-denied

Example of invoking DeviceManager.askDevicePermission before a call starts to check whether proper permissions were granted.

```APIDOC
## Check microphone permission before call

### Description
Invoke DeviceManager.askDevicePermission before a call starts to check whether the proper permissions were granted. If the permission is denied, display a message in the user interface to alert about this situation.

### Method
askDevicePermission

### Endpoint
DeviceManager.askDevicePermission

### Parameters
- **permission** (object) - The permission request object.
  - **audio** (boolean) - Indicates whether audio permission is requested.
  - **video** (boolean) - Indicates whether video permission is requested.

### Example
```typescript
// Example usage (pseudo-code)
const deviceManager = call.feature(Features.UserFacingDiagnostics).media.deviceManager;
const permission = await deviceManager.askDevicePermission({ audio: true, video: false });
if (!permission.audio) {
    // show a warning message on UI
}
```

### Notes
- Some browser platforms cache the permission results. If a user denied the permission at browser layer previously, invoking askDevicePermission API doesn't trigger the permission UI prompt, but the method can know the permission was denied.
- Your application should show instructions and ask the user to reset or grant the browser microphone permission manually.
```

--------------------------------

### Create number-lookup-quickstart.js

Source: https://learn.microsoft.com/en-us/azure/communication-services/quickstarts/telephony/number-lookup

Create the main application file with a basic async structure.

```javascript
async function main() {
    // quickstart code will go here
}

main();
```

--------------------------------

### Enable Data Channel feature

Source: https://learn.microsoft.com/en-us/azure/communication-services/quickstarts/voice-video-calling/get-started-data-channel

Gets the DataChannelCallFeature object from the ongoing call to start using the data channel feature.

```APIDOC
## Enable Data Channel feature

### Description
Gets the DataChannelCallFeature object from the ongoing call to start using the data channel feature.

### Method
Get property

### Endpoint
call.Features.DataChannel

### Parameters
None

### Request Example
```csharp
DataChannelCallFeature dataChannelCallFeature = call.Features.DataChannel;
```

### Response
#### Success Response
Returns a DataChannelCallFeature object.

#### Response Example
```csharp
DataChannelCallFeature dataChannelCallFeature = call.Features.DataChannel;
```
```

--------------------------------

### Set up Java app framework in App.java

Source: https://learn.microsoft.com/en-us/azure/communication-services/quickstarts/email/send-email

Configures the initial application entry point in src/main/java/com/communication/quickstart/App.java with necessary Azure Communication Services and polling imports.

```java
package com.communication.quickstart;

import com.azure.communication.email.models.*;
import com.azure.communication.email.*;
import com.azure.core.util.polling.*;

public class App
{
    public static void main( String[] args )
    {
        // Quickstart code goes here.
    }
}

```

--------------------------------

### Join a group call in Java

Source: https://learn.microsoft.com/en-us/azure/communication-services/how-tos/calling-sdk/manage-calls

Use the join method with a GroupCallLocator containing a GUID to start or join a group call.

```Java
Context appContext = this.getApplicationContext();
GroupCallLocator groupCallLocator = new GroupCallLocator("<GUID>");
JoinCallOptions joinCallOptions = new JoinCallOptions();

call = callAgent.join(context, groupCallLocator, joinCallOptions);
```

--------------------------------

### Enable Data Channel feature

Source: https://learn.microsoft.com/en-us/azure/communication-services/quickstarts/voice-video-calling/get-started-data-channel

Get the Data Channel feature object from the ongoing call to start using data channels.

```APIDOC
## Enable Data Channel feature

### Description
Get the Data Channel feature object from the ongoing call to start using data channels.

### Method
N/A (SDK method call)

### Endpoint
N/A

### Parameters
None

### Request Example
```swift
var dataChannelCallFeature = self.call!.feature(Features.dataChannel)
```

### Response
#### Success Response
Returns a `DataChannelCallFeature` object.

#### Response Example
```swift
var dataChannelCallFeature = self.call!.feature(Features.dataChannel)
```
```

--------------------------------

### Initialize Program.cs for Entra ID Integration

Source: https://learn.microsoft.com/en-us/azure/communication-services/quickstarts/identity/microsoft-entra-id-authentication-integration

The starting template for the Program.cs file required to implement the Entra ID user support quickstart.

```csharp
using Azure.Communication;
using Azure.Identity;

namespace EntraIdUsersSupportQuickstart
{
    class Program
    {
        static async Task Main(string[] args)
        {
            Console.WriteLine("Azure Communication Services - Obtain Access Token for Entra ID User Quickstart");

            // Quickstart code goes here
        }
    }
}
```

--------------------------------

### Run the Python quickstart script

Source: https://learn.microsoft.com/en-us/azure/communication-services/quickstarts/advanced-messaging/whatsapp/download-media

Execute the script from the directory where the file is located.

```bash
python download-media-quickstart.py
```

--------------------------------

### Navigate to project directory and build with dotnet build

Source: https://learn.microsoft.com/en-us/azure/communication-services/quickstarts/sms/send

Switches into the newly created SmsQuickstart directory and compiles the application.

```Console
cd SmsQuickstart
dotnet build

```

--------------------------------

### Place a call with a custom video stream

Source: https://learn.microsoft.com/en-us/azure/communication-services/quickstarts/voice-video-calling/get-started-raw-media-access

This example demonstrates how to create a custom MediaStream from a canvas and use it as the local video stream when starting a call.

```javascript
const createVideoMediaStreamToSend = () => {
    const canvas = document.createElement('canvas');
    const ctx = canvas.getContext('2d');
    canvas.width = 1500;
    canvas.height = 845;
    ctx.fillStyle = 'blue';
    ctx.fillRect(0, 0, canvas.width, canvas.height);

    const colors = ['red', 'yellow', 'green'];
    window.setInterval(() => {
        if (ctx) {
            ctx.fillStyle = colors[Math.floor(Math.random() * colors.length)];
            const x = Math.floor(Math.random() * canvas.width);
            const y = Math.floor(Math.random() * canvas.height);
            const size = 100;
            ctx.fillRect(x, y, size, size);
        }
    }, 1000 / 30);

    return canvas.captureStream(30);
};

...
const userId = 'acs_user_id';
const mediaStream = createVideoMediaStreamToSend();
const localVideoStream = new LocalVideoStream(mediaStream);
const callOptions = {
    videoOptions: {
        localVideoStreams: [localVideoStream]
    }
};
callAgent.startCall(userId, callOptions);
```

--------------------------------

### iOS: Set Screen Orientation with CallCompositeOptions

Source: https://learn.microsoft.com/en-us/azure/communication-services/how-tos/ui-library-sdk/orientation

This example demonstrates how to set the screen orientation for the setup and calling screens of the iOS CallComposite using CallCompositeOptions.

```APIDOC
## CallCompositeOptions(setupScreenOrientation:callingScreenOrientation:)

### Description
Initializes CallCompositeOptions with the specified screen orientations for the setup and calling screens.

### Method
Initializer: CallCompositeOptions(localization:setupScreenOrientation:callingScreenOrientation:)

### Parameters
- **localization** (LocalizationConfiguration) - Optional - The localization configuration.
- **setupScreenOrientation** (OrientationOptions) - Required - The orientation for the setup screen.
- **callingScreenOrientation** (OrientationOptions) - Required - The orientation for the calling screen.

### Request Example
```swift
let callCompositeOptions = CallCompositeOptions(localization: localizationConfig,
                                                setupScreenOrientation: OrientationOptions.portrait,
                                                callingScreenOrientation: OrientationOptions.allButUpsideDown)
let callComposite = CallComposite(withOptions: callCompositeOptions)
```

### Response
Returns a CallComposite instance with the specified orientations.
```

--------------------------------

### Create messages-quickstart.py file

Source: https://learn.microsoft.com/en-us/azure/communication-services/quickstarts/advanced-messaging/whatsapp/download-media

Create the main Python file for the application.

```bash
type nul > messages-quickstart.py   
```

--------------------------------

### Android: Set Screen Orientation with CallCompositeBuilder

Source: https://learn.microsoft.com/en-us/azure/communication-services/how-tos/ui-library-sdk/orientation

This example demonstrates how to set the screen orientation for the setup and calling screens of the Android CallComposite using the CallCompositeBuilder.

```APIDOC
## CallCompositeBuilder.setupScreenOrientation and callScreenOrientation

### Description
Sets the screen orientation for the setup and calling screens of the Android CallComposite.

### Method
Builder methods: setupScreenOrientation(CallCompositeSupportedScreenOrientation) and callScreenOrientation(CallCompositeSupportedScreenOrientation)

### Parameters
- **setupScreenOrientation** (CallCompositeSupportedScreenOrientation) - Required - The orientation for the setup screen.
- **callScreenOrientation** (CallCompositeSupportedScreenOrientation) - Required - The orientation for the calling screen.

### Request Example
```kotlin
import com.azure.android.communication.ui.calling.models.CallCompositeSupportedScreenOrientation

val callComposite: CallComposite =
            CallCompositeBuilder()
            .setupScreenOrientation(CallCompositeSupportedScreenOrientation.FULL_SENSOR)
            .callScreenOrientation(CallCompositeSupportedScreenOrientation.LANDSCAPE)
            .build()
```

### Response
Returns a CallComposite instance with the specified orientations.

### Response Example
```kotlin
val callComposite: CallComposite = // built composite
```
```

--------------------------------

### Get supported caption language

Source: https://learn.microsoft.com/en-us/azure/communication-services/how-tos/calling-sdk/closed-captions-teams-interop-how-to

Retrieves the list of supported caption languages from the teamsCaptions object. The example iterates over the supported languages and selects one, such as 'en'.

```APIDOC
## Get supported caption language

### Description
Retrieves the list of supported caption languages from the teamsCaptions object.

### Method
Not applicable (SDK property access)

### Endpoint
Not applicable

### Parameters
None

### Request Example
```swift
// ISO 639-1 formatted language code
let captionLanguage : String = "en"
for language in teamsCaptions?.supportedCaptionLanguages ?? [] {
    // choose required language
    captionLanguage = language
}
```

### Response
#### Success Response
- **supportedCaptionLanguages** (array of String) - List of ISO 639-1 formatted language codes.

#### Response Example
```swift
// The variable captionLanguage is set to the chosen language code.
```
```

--------------------------------

### Initialize App.java framework

Source: https://learn.microsoft.com/en-us/azure/communication-services/quickstarts/telephony/voice-routing-sdk-config

Set up the initial class structure and import necessary SipRouting classes.

```java
import com.azure.communication.phonenumbers.siprouting.SipRoutingAsyncClient;
import com.azure.communication.phonenumbers.siprouting.SipRoutingClientBuilder;
import com.azure.communication.phonenumbers.siprouting.models.SipTrunk;
import com.azure.communication.phonenumbers.siprouting.models.SipTrunkRoute;
import static java.util.Arrays.asList;

public class App
{
    public static void main( String[] args ) throws IOException
    {
        System.out.println("Azure Communication Services - Direct Routing Quickstart");
        // Quickstart code goes here
    }
}
```

--------------------------------

### Run the application and verify output

Source: https://learn.microsoft.com/en-us/azure/communication-services/quickstarts/chat/get-started

Execute the start script to bundle and serve the application, and verify the resulting message in the browser console.

```console
npm install
npm run start

```

```console
Azure Communication Chat client created!

```

--------------------------------

### Subscribe to effectsError event

Source: https://learn.microsoft.com/en-us/azure/communication-services/how-tos/calling-sdk/events

Use this snippet to handle the effectsError event, which fires when an error occurs while starting or applying an audio effect. The example logs the error and displays an alert to the user.

```JavaScript
audioEffectsFeature.on('effectsError', (error) => {
    console.log(`Error with the audio effect ${error}`);
    alert(`Error with the audio effect`);
});
```

--------------------------------

### Initialize Twilio Client

Source: https://learn.microsoft.com/en-us/azure/communication-services/tutorials/migrating-to-azure-communication-services-chat

Example of setting up the Twilio client using account credentials.

```C#
var twilio = new TwilioRestClient(accountSid, authToken);
```

--------------------------------

### Subscribe to effectsStopped event

Source: https://learn.microsoft.com/en-us/azure/communication-services/how-tos/calling-sdk/events

Use this snippet to handle the effectsStopped event, which fires when an audio effect is stopped. The example shows how to make a start effect button visible when the event occurs.

```JavaScript
audioEffectsFeature.on('effectsStopped', (effects) => {
    startEffectButton.style.visibility = "visible"; 
});
```
Tokens:
Raw