Azure Communication Services documentation

Build powerful, cloud-based communication and customer engagement experiences by adding voice, video, chat, sms, email, teams interoperability, call automation, and telephony to your apps.

• Azure Communication Services documentation
• Overview
  • What's new
  • Fundamentals
    • What is Azure Communication Services?
    • Pricing
    • Create a Communication Services resource
    • Create an email resource
    • Create an access token
    • Get a phone number
    • Subscribe to events
    • SDKs and APIs
    • Designing your architecture
  • Services
    • SMS
    • Voice and Video
    • Phone calling
    • Chat
    • Email
    • Advanced Messaging
      • WhatsApp
    • Job Router
  • Common scenarios
    • Virtual visit
    • Virtual event
    • Contact center
    • Embed chat in Teams custom app
  • Privacy and compliance
    • Data residency and user privacy
    • European Union Data Boundary
    • Azure Government
  • Security
    • Security baseline
  • Artificial intelligence AI
  • Service limits
  • Troubleshooting
  • Help and support options
• Quickstart
  • SMS
    • Send an SMS message
    • Receive and reply to SMS
    • Get a phone number
    • Apply for a short code
    • Apply for toll-free verification
    • Apply for 10 digit long codes Registration
    • Enable alphanumeric sender ID
    • Use the Opt-Out API
  • Voice and Video
    • Connect to a call
      • Create an access token
      • Add voice calling to your app
      • Add video calling to your app
    • Connect to a Teams call
      • Use an external identity
        • Create an access token
        • Add Teams meeting calling to your app
        • Connect Teams users to Azure calls
      • Use a Teams identity
        • Generate an access token for a Teams User
        • Add Teams video calling to your app
    • Connect to a Teams calling application
      • Connect to Call Queue
      • Connect to Auto Attendant
    • Connect to a Room call
      • Create a room
      • Join a room call
      • Manage a room call
    • Use UI components for voice and video
    • Add data channel messaging to your calling app
    • Set video constraints in your calling app
  • Chat
    • Connect to a chat
      • Create an access token
      • Add chat to your app
    • Connect to Teams
      • Use an external identity
        • Create an access token
        • Add Teams meeting chat to your app
    • Use UI components for chat
  • Phone calling
    • Get a phone number
    • Get a trial phone number
    • Lookup number type and carrier details
    • Make an outbound call
    • Add a Microsoft Teams user to an existing call
    • Add outbound phone calling to your app
    • Configure direct routing
  • Email
    • Create an email resource
    • Get a free Azure managed domain
    • Add a custom domain
    • Connect domain to send email
    • Send an email
    • Advanced email sending
      • Send email to multiple recipients
      • Send email with attachments
      • Send email with inline attachments
      • Manually poll for email status
      • Throw an exception when sending tier limit is reached
      • Use email object model for payload
    • Add multiple sender addresses
    • Add multiple sender addresses with Azure Communication Services Management SDKs
    • Manage domain suppression lists with Azure Communication Services Management SDKs
    • Manage domain suppression lists in the Azure portal
    • Sending emails using SMTP
      • Setting up SMTP Authentication
      • Smtp Send Mail Examples
  • Job Router
    • Submit a job for queuing and routing
    • Integrate Azure OpenAI with Job Router
  • Advanced Messaging
    • WhatsApp
      • Register WhatsApp Business Account
      • WhatsApp Business Account FAQ
      • Send WhatsApp Messages
      • Handle Advanced Messaging Events
      • Download Media Payload
      • Try Advanced Messaging Sandbox
    • Message Analysis
      • Enable Message Analysis With Azure OpenAI
  • Managed Identity
    • Enable Managed Identity on Azure Communication Services resources
  • Events and notifications
    • Subscribe to events
    • Validate events
    • Test events locally
    • Deliver push notifications
• Tutorials
  • SMS
    • Authenticate with Microsoft Entra ID
    • Use Postman to send SMS messages
    • Send short URL
    • Migrate to Android push notifications FCM v1
    • Register for Android push notifications FCM v1
    • Phone numbers
      • Port a phone number into Azure
      • Look up a recipient phone number
    • Events
      • View SMS events
    • Analytics
      • Enable logging with Azure Monitor
      • SMS insights
      • Export SDK telemetry to Application Insights
  • Voice and Video
    • Setup for Node.js app
    • Build an authentication service using Azure Functions
    • Add Calling and Chat SDK in an Android application
    • Adding audio quality enhancements
      • Enabling audio effects
    • Virtual appointments
      • Sample builder
      • Extend Teams
        • Overview
        • Scheduling
        • Before and after appointment
        • Precall
        • Call
    • Calling widget
      • Overview
      • Create Calling widget for Teams Voice Apps using React
      • Create Calling widget for Teams Voice Apps using JavaScript Bundles
    • Call management
      • Manage calls
      • Manage video
      • Manage Teams calling
      • Manage Teams meeting Lobby
      • Manage call duration
      • PowerPoint Live
      • Record calls
      • Raise Hand
      • Reactions
      • Spotlight
      • Show transcription state
      • Manage role assignment
      • Show active speakers
      • Transfer calls
      • Subscribe to SDK events
      • Enable Closed captions
      • Enable Closed captions for Teams Interoperability
      • Get local capabilities
      • Pass User-to-User Information UUI data in a header
    • Call recording
      • Record a call
      • Record every call in the resource
    • Editing audio and video media from the client
      • Access raw audio and video
      • Add video background effects
      • Add Augmented Reality filters to your video calls
    • Diagnostics
      • Diagnose your network
      • Diagnose client issues
      • Diagnose media quality issues
      • Ensure pre-call readiness
      • Add pre-call diagnostics
      • Check if user is running supported browser
      • Verify if an application is active in multiple tabs of a browser
      • Collect and Share Log Files
      • Get users ready for their call with UI Library
        • Call readiness overview
        • 1. Ensure user is on a supported browser
        • 2. Request camera and microphone permissions
        • 3. Microphone and camera setup before a call
    • Add end of call survey
      • Using the survey users API
      • Collecting user feedback with the mobile UI Library
    • Migrating to Azure Communication Services
      • Migrate from Twilio Video to Azure Communication Services
      • How to migrate from Twilio Video to Azure Communication Services
      • How to migrate from Twilio Conversations Chat to Azure Communication Services
    • Mobile integrations
      • Integrate with CallKit in iOS
      • Integrate with TelecomManager on Android
      • Enable push notifications
      • Using the mobile UI Library for voice and video
        • Add chat capabilities
        • Configure default orientation
        • Configure closed captions
        • Configure theming
        • Customize buttons
        • Customize the title and subtitle
        • Disable end call confirmation
        • Enable audio only mode
        • Enable picture-in-picture
        • Enable skip the setup screen
        • Events
        • Inject participant view data
        • Integrate CallKit
        • Integrate TelecomManager
        • Set up localization
        • Set up one-to-one calling and push notifications
        • Troubleshooting
    • Events
      • Using Event Grid to send calling push notifications
      • View calling events
    • Analytics
      • Enable logging with Azure Monitor
      • Voice and Video insights
      • Call Recording insights
      • Query call logs
      • Add Diagnostic options tag to your calling logs
      • Rooms Insights
      • Export SDK telemetry to Application Insights
    • Teams interoperability
      • Audio Conferencing
      • Breakout rooms
      • Together Mode
    • Configuring to proxy traffic
      • Proxy your calling traffic
    • Build a Webview based client
      • Add audio and video calling to your WebView application
  • Chat
    • Build an authentication service using Azure Functions
    • Add a bot to your chat app
    • Add file sharing with UI Library in Azure Communication Service Chat
    • Add file sharing with UI Library in Teams Interoperability Chat
    • Add inline image support with UI Library in Teams Interoperability Chat
    • Integrate with data loss prevention policies
    • Connect to Teams
      • Enable inline image interoperability in your chat app
      • Enable file attachment interoperability in your chat app
    • Mobile integrations
      • Enable push notifications in your chat app
      • Using chat SDK with React Native
    • Analytics
      • Enable logging with Azure Monitor
      • Chat insights
      • Export SDK telemetry to Application Insights
  • Phone calling
    • Add emergency calling to your app
    • Validate a domain for direct routing
    • Phone numbers
      • Port a phone number into Azure
    • Call Automation
      • Control and steer calls
      • Control mid call media actions
      • Customize voice prompts to users with play action
      • Gather user input with recognize action
      • Get Real-time Transcription of call audio
      • How to secure webhook endpoint
      • Handling Call Automation Events with EventProcessor
      • How to pass call contextual data in Call Automation
      • How to use Audio Streaming
    • Call recording
      • Record a call
      • Record every call in the resource
    • Analytics
      • Enable logging with Azure Monitor
      • Call Automation insights
      • Call Recording insights
      • Query call logs
      • Export SDK telemetry to Application Insights
  • Email
    • Events
      • View email events
    • Analytics
      • Enable User Engagement Tracking
      • Enable logging with Azure Monitor
      • Email insights
      • Export SDK telemetry to Application Insights
  • Job Router
    • Manage queues
    • Classify a job
    • Accept or decline a job
    • Get wait time and job position
    • Escalate a job
    • Target a Preferred Worker
    • Scheduling a job
    • Azure function rule engine
    • Customize how worker ranking for best worker mode
    • Events
      • Subscribe to Job Router Events
• Samples
  • Voice and Video
    • Calling hero sample
    • Xamarin calling sample
    • React Native calling sample
    • MAUI calling sample
    • Web calling sample
    • Web calling - Push notifications sample
    • Authentication service hero sample
  • Chat
    • Chat hero sample
    • Authentication service hero sample
  • Email
    • Azure AI to detect sensitive data example
  • Call Automation
    • Call Automation Azure OpenAI sample
    • Call Automation AI sample
• Concepts
  • Identity
    • Overview
    • Authenticating services
    • Understand identifiers
    • Credentials best practices
    • Use cases for string identifiers
    • Events
      • Overview
      • Presence events
  • SMS
    • Overview
    • SMS Number Types
    • SDK features
    • Opt-Out API
    • Pricing
    • Messaging policy
    • Phone numbers
      • Phone number types
      • Short code program brief filling guidelines
      • Toll-free verification guidelines
      • 10 Digit Long Codes Registration Guidelines
    • Events
      • Overview
      • SMS events
    • Analytics
      • SMS logs
      • SMS metrics overview
    • SMS FAQ
  • Voice and Video Calling
    • Overview
    • Voice and video terminology
    • Pricing
    • Migrate to Azure Communication Services
      • Migrate from Twilio Video to Azure Communication Services
      • How to migrate from Twilio Video to Azure Communication Services
    • Web UI library
    • Call Automation
      • Overview
      • Pricing
      • Answer a call
      • Connect to Azure AI
      • Play audio
      • Gather user input
      • Ring Microsoft Teams users
    • Teams interoperability
      • Overview
      • Communication as external user
        • Overview
        • Calling capabilities
        • Meeting capabilities
        • Teams client experience
        • Teams controls
        • Logs & metrics
        • User privacy
        • Government clouds
        • Security
        • Known issues
      • Communication as Teams user
        • Overview
        • Use cases
        • Authentication overview
        • Calling capabilities
        • Phone capabilities
        • Meeting capabilities
        • Teams client experience
        • Teams license requirements
        • Microsoft Entra API permissions
        • Firewall configuration
        • Government clouds
      • Virtual visits
        • Overview
        • Plan user experience
        • Govern meeting experience
        • Teams controls
      • Closed captions
      • Pricing
      • Enable interoperability with Teams
    • Advanced audio and video
      • Rooms API for structured meetings
      • Recording
      • Music mode
      • Media access
      • Simulcast
    • Quality and Diagnostics
      • Optimizing call quality
      • Call Diagnostics
      • End of Call Survey
      • Troubleshooting PSTN call failures
      • Troubleshooting VoIP call quality
      • Tuning video quality
      • SDK best practices
    • Networking and Data
      • Network recommendations
      • Call networking internals
      • Call flow topologies
      • Data channel
    • Logging via Azure Monitor
      • Call client logs
      • Call Diagnostics
      • Recording logs
      • End of call survey logs
      • Call automation metrics
      • Rooms logs
      • Rooms metrics
      • Closed captions logs
    • Service events via Event Grid
      • Overview
      • Voice and Video events
    • Real Time Text
      • Real Time Text overview
    • Closed captions
      • Closed captions overview
    • UI Library
      • UI Library overview
      • UI Library use cases
      • Design with UI Library Design Kit
    • User support and experience
      • User support
      • User experience
    • Known Issues
      • WebJS calling SDK
      • Native calling SDK
      • Call Automation
  • Chat
    • Overview
    • SDK features
    • Archiving Chats
    • Pricing
    • Government clouds
    • Translating chats
    • Events
      • Overview
      • Chat events
    • Analytics
      • Chat logs
      • Chat metrics overview
  • Phone calling
    • Telephony
      • Overview
      • Trial phone numbers
      • Pricing
      • Phone number types
      • Number Lookup Concept
      • Number Lookup SDK
      • Country/region availability
      • Emergency calling
      • Direct routing infrastructure requirements
      • Connect to existing telephony
      • Try Phone Calling
      • Certified Session Border Controllers
      • Inbound telephony calling capabilities
      • Calling with toll-free numbers
      • Known limitations
      • Troubleshooting
        • Monitor direct routing
        • Troubleshoot TLS connectivity
        • Troubleshoot outbound calls
        • SIP protocol details for direct routing
    • Call Automation
      • Overview
      • Pricing
      • Answer a call
      • Connect to Azure AI
      • Play audio
      • Gather user input
      • Get Real-Time Audio Insights using Transcriptions
      • Ring Microsoft Teams users
      • Get Audio Streams from a call
    • Call recording
    • Events
      • Overview
      • Voice and video events
    • Analytics
      • Call logs
      • Call Automation logs
      • End of call survey logs
      • Recording logs
      • Call automation metrics overview
      • Rooms metrics overview
  • Email
    • Overview
    • Concepts
    • SDK features
    • SMTP
    • Allowed attachment types
    • Inline attachments
    • Managing Opt-outs
    • Understanding sender reputation
    • Quota increase for email domains
    • Pricing
    • Domains
      • Email domains and sender authentication
      • Best practices for sender authentication support
      • Troubleshooting Domain Configuration issues
    • Messaging policy
    • Events
      • Overview
      • Email events
    • Analytics
      • Email logs
      • Email metrics overview
  • Job Router
    • Overview
    • How jobs are matched to workers
    • How worker capacity is configured
    • Distribution modes
    • Exception Policies
    • Classification concepts
    • Router Rule concepts
    • Events
      • Overview
      • Job Router events
    • Analytics
      • Job Router logs
      • Job Router metrics
  • Advanced Messaging
    • WhatsApp
      • Overview
      • WhatsApp Terms of Service
      • Messaging policy
      • Pricing
      • Analytics
        • Metrics
        • Logs
      • Events
        • Overview
        • Advanced Messaging events
      • Templates
    • Message Analysis
      • Overview
      • Message Analysis Transparency FAQ
  • Azure Advisor
    • Overview
    • Metrics
• Resources
  • Release notes
  • Learn modules
  • Troubleshooting Guides
    • Troubleshooting in Azure Communication Services
    • Troubleshooting response codes
    • Voice and Video
      • General troubleshooting strategies
        • Overview
        • Understanding error messages and codes
        • Reporting an issue
      • Calling JavaScript
        • Call setup issues
          • Overview
          • Invalid or expired tokens
          • Failed to create callAgent
          • The user doesn't receive incoming call notifications
          • The call setup takes too long
          • The call ends with 410/3112
        • Device and permission issues
          • Overview
          • The getMicrophones API doesn't return detailed microphone list
          • The getSpeakers API doesn't return detailed speaker list
          • No permission prompt shows when calling askDevicePermission
          • The askDevicePermission API takes too long
        • Audio issues
          • Overview
          • The user cannot hear sound during the call
            • The speaking participant doesn't grant the microphone permission
            • The speaking participant's microphone has a problem
            • The user's speaker has a problem
            • There is a network issue in the call
          • The user experiences poor audio quality
          • The user experiences delays during the call
          • The user experiences echo during the call
          • The volume of the incoming audio is low
        • Video issues
          • Overview
          • The user cannot see video from the remote participant
            • Subscribing to a video that is unavailable
            • The remote video becomes unavailable while subscribing the video
            • The application disposes the video renderer while subscribing the video
            • The maximum number of active video subscriptions has been reached
            • CreateView timeout
          • The user experiences poor video quality
            • The network is poor during the call
            • The video sender has high CPU load
            • The sender's video is frozen
        • References
          • How to collect call info
          • How to collect client logs
          • How to collect diagnostic audio recordings from the browser
          • How to collect verbose log from browsers
          • How to collect Windows audio event log
          • User Facing Diagnostics
            • Network
              • noNetwork
              • networkRelaysNotReachable
              • networkReconnect
              • networkReceiveQuality
              • networkSendQuality
            • Audio
              • noSpeakerDevicesEnumerated
              • speakingWhileMicrophoneIsMuted
              • noMicrophoneDevicesEnumerated
              • microphoneNotFunctioning
              • microphoneMuteUnexpectedly
              • microphonePermissionDenied
            • Video
              • cameraFreeze
              • cameraStartFailed
              • cameraStartTimedOut
              • cameraPermissionDenied
              • cameraStoppedUnexpectedly
            • Screensharing
              • screenshareRecordingDisabled
              • capturerStartFailed
              • capturerStoppedUnexpectedly
• References
  • Reference documentation overview
  • Azure CLI
  • REST API documentation
  • Azure Resource Manager
    • Azure Resource Manager JavaScript
    • Azure Resource Manager .NET
    • Azure Resource Manager Java
    • Azure Resource Manager Python
  • Advanced Messaging
    • Messages Java
    • Messages JavaScript
    • Messages .NET
    • Messages Python
    • Advanced Messaging REST
  • Calling
    • Calling JavaScript
    • Calling Android/Java
    • Calling iOS
  • Call Automation
    • Call Automation JavaScript
    • Call Automation .NET
    • Call Automation Java
    • Call Automation Python
  • Chat
    • Chat JavaScript
    • Chat .NET
    • Chat Android/Java
    • Chat Python
    • Chat iOS
  • Email
    • Email JavaScript
    • Email .NET
    • Email Java
    • Email Python
  • Identity
    • Identity JavaScript
    • Identity .NET
    • Identity Java
    • Identity Python
  • Job Router
    • Job Router JavaScript
    • Job Router .NET
    • Job Router Java
    • Job Router Python
  • Phone Numbers
    • Phone Numbers JavaScript
    • Phone Numbers .NET
    • Phone Numbers Java
    • Phone Numbers Python
  • Rooms
    • Rooms JavaScript
    • Rooms .NET
    • Rooms Java
    • Rooms Python
  • SMS
    • SMS JavaScript
    • SMS .NET
    • SMS Java
    • SMS Python
  • UI Library
    • UI Library JavaScript
    • UI Library for Calling iOS
    • UI Library for Calling Android
    • UI Library for Chat iOS
    • UI Library for Chat Android
  • Common
    • Common JavaScript
    • Common .NET
    • Common Android/Java
    • Common iOS
  • Country/region phone number management
    • Phone number management for Argentina
    • Phone number management for Australia
    • Phone number management for Austria
    • Phone number management for Belgium
    • Phone number management for Brazil
    • Phone number management for Canada
    • Phone number management for Chile
    • Phone number management for China
    • Phone number management for Colombia
    • Phone number management for Czech Republic
    • Phone number management for Denmark
    • Phone number management for Estonia
    • Phone number management for Finland
    • Phone number management for France
    • Phone number management for Germany
    • Phone number management for Hong Kong SAR
    • Phone number management for Indonesia
    • Phone number management for Ireland
    • Phone number management for Israel
    • Phone number management for Italy
    • Phone number management for Japan
    • Phone number management for Latvia
    • Phone number management for Lithuania
    • Phone number management for Luxembourg
    • Phone number management for Malaysia
    • Phone number management for Mexico
    • Phone number management for Netherlands
    • Phone number management for New Zealand
    • Phone number management for Norway
    • Phone number management for Philippines
    • Phone number management for Poland
    • Phone number management for Portugal
    • Phone number management for Saudi Arabia
    • Phone number management for Singapore
    • Phone number management for Slovakia
    • Phone number management for Slovenia
    • Phone number management for South Africa
    • Phone number management for South Korea
    • Phone number management for Spain
    • Phone number management for Sweden
    • Phone number management for Switzerland
    • Phone number management for Taiwan
    • Phone number management for Thailand
    • Phone number management for United Arab Emirates
    • Phone number management for United Kingdom
    • Phone number management for United States