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 is Azure Communication Services?
  • What's new
  • Services
  • Pricing
• Fundamentals
  • Create a Communication Services resource
  • SDKs and APIs
  • Service limits
  • Privacy, compliance, and security
    • Data residency and user privacy
    • European Union Data Boundary
    • Azure Government
    • Security baseline
• Identity
  • Overview
  • Access tokens for end users
  • Authenticate services
  • Enable managed identity
  • Understand identifiers
  • Credentials best practices
  • Use cases for string identifiers
  • Presence events
  • References
    • Identity JavaScript
    • Identity .NET
    • Identity Java
    • Identity Python
• Chat
  • Overview
  • Pricing
  • Chat architecture
  • Build intelligent, AI-powered chat experiences
  • Chat SDK overview
  • Message types
  • Real-time notifications
  • Push notifications
  • Archive chats
  • Government clouds
  • Translate chats
  • Events
    • Events overview
    • Subscribe to events
    • Chat events
    • Server events
  • Logging and analytics
    • Enable logging with Azure Monitor
    • Chat metrics
    • Chat logs
    • Chat insights
    • Export SDK telemetry to Application Insights
  • Samples and tutorials
    • Create a chat access token
    • Add chat to your app
    • Use UI Library with chat
      • Use UI components for chat
      • Add file sharing in chat
      • Add file sharing in Teams interop chat
      • Add inline image support in Teams interop chat
    • Connect to Teams
      • Add Teams meeting chat to your app
      • Enable inline image interop in your chat app
      • Enable file attachment interop in your chat app
    • Use chat SDK with React Native
    • Enable push notifications in your chat app
    • Build an authentication service using Azure Functions
    • Add a bot to your chat app
    • Integrate with data loss prevention policies
    • Chat hero sample
    • Authentication service hero sample
  • References
    • Chat JavaScript
    • Chat .NET
    • Chat Android/Java
    • Chat Python
    • Chat iOS
• Email
  • Overview
  • Pricing
  • SDK features
  • Quota increase for email domains
  • Provision and configure
    • Create an email resource
    • Prepare an email resource
    • Get a free Azure managed domain
    • Add a custom domain
    • Troubleshooting domain configuration issues
    • Connect domain to send email
    • Add multiple sender addresses
    • Add multiple sender addresses with Management SDKs
    • Automate email resource management
  • Send email
    • Send an email
    • Send email to multiple recipients
    • Manually poll for email status
    • Simple Mail Transfer Protocol SMTP
      • SMTP support
      • Set up SMTP authentication
      • Send email using SMTP
    • Attachments
      • Inline attachments
      • Supported attachment types
      • Send email with attachments
      • Send email with inline attachments
    • Advanced features
      • Throw an exception when sending tier limit is reached
      • Use email object model for payload
  • Manage sender reputation
    • Understand sender reputation
    • Manage opt-outs
    • Manage domain suppression lists with Management SDKs
    • Manage domain suppression lists in the Azure portal
    • Email domains and sender authentication
    • Best practices for sender authentication support
    • Messaging policy
  • Events
    • Events overview
    • Subscribe to events
    • Email events
    • View email events
  • Logging and analytics
    • Enable user engagement tracking
    • Enable logging with Azure Monitor
    • Email logs
    • Email metrics
    • Email insights
    • Export SDK telemetry to Application Insights
  • Samples and tutorials
    • Detect sensitive data using Azure AI
  • References
    • Email JavaScript
    • Email .NET
    • Email Java
    • Email Python
    • Email Azure CLI
    • Email PowerShell
• SMS
  • Overview
  • Pricing
  • SMS SDK overview
  • SMS FAQ
  • Phone number types
  • Country availability
  • Messaging policy
  • Short code program brief filling guidelines
  • Opt-Out management overview
  • Events
    • Events overview
    • Subscribe to events
    • SMS events
  • Toll-free verification guidelines
  • Logging and analytics
    • Enable logging with Azure Monitor
    • SMS logs
    • SMS metrics
    • SMS insights
    • Export SDK telemetry to Application Insights
  • Samples and tutorials
    • Get a phone number
    • Send an SMS message
    • Receive an SMS message
    • Handle SMS events
    • Apply for a short code
    • Use Postman to send SMS messages
    • Send short URL
    • Apply for toll-free verification
    • Enable alphanumeric sender ID
    • Migrate to Android push notifications FCM v1
    • Register for Android push notifications FCM v1
  • References
    • SMS JavaScript
    • SMS .NET
    • SMS Android/Java
    • SMS Python
• Advanced messaging with WhatsApp
  • Overview
  • Pricing
  • Advanced messaging for WhatsApp terms of service
  • Messaging policy
  • WhatsApp business account FAQ
  • Logging and analytics
    • Enable logging with Azure Monitor
    • Advanced Messaging logs
    • Message analysis
    • Message analysis transparency FAQ
  • Samples and tutorials
    • Try Advanced Messaging Sandbox
    • Register WhatsApp Business Account
    • Send WhatsApp Messages
      • Text and Media messages
      • Template messages
      • Interactive messages
      • Reaction messages
      • Sticker messages
    • Handle Advanced messaging events
    • Download media payload
    • WhatsApp business account FAQ
    • Enable Message Analysis With Azure OpenAI
  • References
    • Messages Java
    • Messages JavaScript
    • Messages .NET
    • Messages Python
    • Advanced Messaging REST
• Voice and video calling
  • Overview
  • Pricing
  • Calling fundamentals
    • Voice and video terminology
    • Connect to a call
      • Create an access token
      • Add voice calling to your app
      • Add video calling to your app
    • Rooms
      • Rooms API for structured meetings
      • Create a room
      • Join a room call
      • Manage a room call
      • Manage role assignment
    • Call management
      • Manage calls
      • Manage video
      • Subscribe to SDK events
      • Raise Hand
      • Enable reactions
      • Enable spotlight
      • Show transcription state
      • Show active speakers
      • Transfer calls
      • Get local capabilities
      • View PowerPoint Live
      • Shared Line appearance
    • Call flows and networking
      • Network recommendations
      • Call networking internals
      • Call flow topologies
  • Advanced audio and video features
    • Music mode
    • Edit audio and video media from the client
      • Understand media access
      • Access raw audio and video
      • Add augmented reality filters to video calls
    • Set video constraints in a calling app
    • Local preview mirroring
    • Optimize video placement on your web app
    • Simulcast
    • Enable audio noise suppression improvements
    • Enable video background effects
    • Pass user-to-user information UUI data in a header
    • Data channel
      • Data Channel overview
      • Add data channel messaging to a calling app
    • Proxy your calling traffic
  • Mobile integrations
    • Integrate with CallKit in iOS
    • Integrate with TelecomManager on Android
    • Enable push notifications
    • Add audio and video calling to your WebView application
    • Use Event Grid to send calling push notifications
  • User experience and accessibility
    • User support
    • User experience
    • Real Time Text RTT
    • Enable Real Time Text RTT
    • Closed captions
    • Enable closed captions
    • Enable closed captions for Teams interop
  • Events
    • Events overview
    • Subscribe to events
    • Voice and video events
    • View calling events
  • Migrate from Twilio to Azure Communication Services
    • Benefits of migrating voice and video from Twilio Video to Azure Communication Services
    • How to migrate voice and video from Twilio Video to Azure Communication Services
    • Benefits of migrating chat from Twilio Conversations Chat to Azure Communication Services
  • Logging and analytics
    • Enable logging with Azure Monitor
    • Query call logs
    • Voice and video insights
    • Call client logs
      • Overview of call logs
      • Call summary updates logs
      • Call summary logs
      • Call diagnostics updates logs
      • Call diagnostics logs
      • Call client operations logs
      • Call client media statistics logs
      • End of call survey logs
      • Call metrics logs
    • Call diagnostics
    • Billing usage logs
    • Insights dashboard
    • Add diagnostic options tag to calling logs
    • Rooms insights
    • Rooms logs
    • Rooms metrics
    • Closed captions logs
    • Export SDK telemetry to Application Insights
  • Quality and diagnostics
    • Optimize call quality
    • Call diagnostics
    • Diagnose client issues with UFD
    • Using media quality statistics
    • Collect and share log files
    • SDK best practices
    • Pre-call readiness
      • Ensure pre-call readiness
      • Check if user is running supported browser
      • Verify if an application is active in multiple browser tabs
    • End of call user survey
      • End of call survey
      • Collect user feedback with end of call survey
      • Collect user feedback with mobile UI Library
      • End of call survey logs
  • Troubleshooting and known issues
    • Overview
    • Understanding error messages and codes
    • Reporting an issue
    • Troubleshooting PSTN call failures
    • Troubleshooting VoIP call quality
    • Call setup issues
      • Overview
      • Invalid or expired tokens
      • Failed to create callAgent
      • User doesn't receive incoming call notifications
      • Call setup takes too long
      • Call ends with 410/3112
    • Device and permission issues
      • Overview
      • getMicrophones API doesn't return detailed microphone list
      • getSpeakers API doesn't return detailed speaker list
      • No permission prompt shows when calling askDevicePermission
      • askDevicePermission API takes too long
    • Audio issues
      • Overview
      • User cannot hear sound during the call
        • Speaking participant doesn't grant the microphone permission
        • Speaking participant's microphone has a problem
        • Participant's speaker has a problem
        • There is a network issue in the call
      • Participant experiences poor audio quality
      • Participant experiences delays during the call
      • Participant experiences echo during the call
      • The volume of the incoming audio is low
    • Video issues
      • Overview
      • Participants cannot see video from the remote participant
        • Subscribing to a video that is unavailable
        • Remote video becomes unavailable while subscribing the video
        • Application disposes the video renderer while subscribing the video
        • Maximum number of active video subscriptions has been reached
        • createView timeout
      • Participant experiences poor video quality
        • Network is poor during the call
        • Video sender has high CPU load
        • Sender's video is frozen
      • References
        • Collect call info
        • Collect client logs
        • Collect diagnostic audio recordings from the browser
        • Collect verbose log from browsers
        • 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
          • Screenshare
            • screenshareRecordingDisabled
            • capturerStartFailed
            • capturerStoppedUnexpectedly
    • Known issues
      • WebJS calling SDK
      • Native calling SDK
  • Samples and tutorials
    • Set up for Node.JS app
    • Virtual appointments
      • Sample builder
      • Extend Teams
        • Overview
        • Scheduling
        • Before and after appointment
        • Pre-call
        • Call
    • Add Calling and Chat SDK in an Android application
    • Authentication service hero sample
    • Build an authentication service using Azure Functions
    • Calling hero sample
    • React Native calling sample
    • MAUI calling sample
    • Web calling sample
    • Web calling push notifications sample
  • References
    • Calling
      • Calling JavaScript
      • Calling Android/Java
      • Calling iOS
    • Rooms
      • Rooms JavaScript
      • Rooms .NET
      • Rooms Java
      • Rooms Python
• Phone calling
  • Overview
  • Pricing
  • Phone number types
  • Define your caller identity
  • Country availability
  • Trial phone numbers
  • Try phone calling
  • Emergency calling
  • Inbound telephony calling capabilities
  • Calling with toll-free numbers
  • Number Lookup
    • Number Lookup concept
    • Number Lookup SDK
    • Try Number Lookup
  • Direct routing
    • Connect to existing telephony
    • Direct routing infrastructure requirements
    • Configure direct routing
    • Validate a domain for direct routing
    • Certified session border controllers
    • Monitor direct routing
    • SIP protocol details for direct routing
    • Known limitations
    • Troubleshoot TLS connectivity
    • Troubleshoot outbound calls
  • Logging and analytics
    • Enable logging with Azure Monitor
    • Query call logs
    • Export SDK telemetry to Application Insights
  • Samples and tutorials
    • Get a trial phone number
    • Get a phone number
    • Lookup number type and carrier details
    • Add a Teams user to an existing call
    • Add outbound phone calling to your app
    • Add emergency calling to your app
    • Port a phone number into Azure
  • References
    • Calling
      • Calling JavaScript
      • Calling Android/Java
      • Calling iOS
    • Phone Numbers
      • Phone Numbers JavaScript
      • Phone Numbers .NET
      • Phone Numbers Java
      • Phone Numbers Python
• Call Automation
  • Overview
  • Pricing
  • Call management
    • Answer a call
    • Make an outbound call
    • Control and steer calls
    • Mute participants during a call
    • Pass contextual data between calls
    • Ring Teams users
  • Interactive voice and AI
    • Connect to Azure AI
    • Play audio
    • Gather user input
    • Control mid call media actions
    • Customize voice prompts to users with play action
    • Gather user input with recognize action
    • Implement Answer Machine Detection
  • Call recording
    • Call recording overview
    • Record a call
    • Record a call automatically
  • Transcripts
    • Get real-time audio insights using transcriptions
    • Add real-time transcription
  • Audio streaming
    • Get audio streams from a call
    • Implement audio streaming
  • Logging and analytics
    • Enable logging with Azure Monitor
    • Call Automation insights
    • Call Automation logs
    • Call Automation metrics
    • Call recording logs
    • Call recording insights
  • Troubleshooting and known issues
    • Troubleshooting response codes
    • Call Automation known issues
  • Samples and tutorials
    • Secure webhook endpoints
    • Handle Call Automation events with EventProcessor
    • Call Automation Azure OpenAI sample
    • Call Automation AI sample
  • References
    • Call Automation REST
    • Call Automation JavaScript
    • Call Automation .NET
    • Call Automation Java
    • Call Automation Python
• 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 shared line appearance
    • Teams license requirements
    • Microsoft Entra API permissions
    • Firewall configuration
    • Government clouds
    • Teams users in Azure Communication Services calls
  • Samples and tutorials
    • Connect to a Teams call
      • Use an external identity
        • Create an access token
        • Add Teams meeting calling to your app
      • 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 Teams users to Azure calls
    • Calling widget
      • Overview
      • Create calling widget for Teams voice apps using React
      • Create calling widget for Teams voice apps using JavaScript
    • Enable audio conferencing
    • Enable breakout rooms
    • Enable Together Mode
    • Control media access
• Job Router
  • Overview
  • Pricing
  • Set classification policies
  • Matched jobs to workers
  • Configure worker capacity
  • Manage distribution modes
  • Set exception policies
  • Set Job Router rules
  • About Job Router events
  • View Job Router logs
  • View Job Router metrics
  • Samples and tutorials
    • Submit a job for queuing and routing
    • Classify a job
    • Accept or decline a job
    • Manage queues
    • Get wait time and job position
    • Escalate a job
    • Schedule a job
    • Target a preferred worker
    • Customize worker ranking for best worker mode
    • Integrate Azure OpenAI with Job Router
    • Subscribe to Job Router events
    • Azure function rule engine
  • References
    • Job Router JavaScript
    • Job Router .NET
    • Job Router Java
    • Job Router Python
• Artificial Intelligence
  • Overview
  • Microsoft Copilot Studio
  • Copilot in the Azure portal
  • Client raw audio and video
  • Samples and tutorials
    • Add a bot to your chat app
    • Client background effects
    • Client noise enhancement and effects
• UI Library
  • Overview
  • UI Library use cases
  • Design with UI Library Design Kit
  • Use mobile UI Library for voice and video
    • Use UI components for voice and video
    • Configure default orientation
    • Configure closed captions
    • Configure theming
    • Customize the button bar
    • Customize the title and subtitle
    • Disable end call confirmation
    • Enable audio only mode
    • Enable picture-in-picture
    • Enable skip the setup screen
    • Subscribe to events
    • Inject participant view data
    • Integrate CallKit
    • Integrate TelecomManager
    • Set up localization
    • Set up one-to-one calling and push notifications
    • Troubleshooting
  • Get users ready for calls with UI Library
    • Call readiness overview
    • 1. Ensure user is on a supported browser
    • 2. Request camera and microphone permissions
    • 3. Set up microphone and camera before a call
  • References
    • Web 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 Scenarios
  • Virtual appointments
    • Overview
    • Plan user experience
    • Govern meeting experience
    • Teams controls
    • Closed captions
    • Pricing
    • Enable interoperability with Teams
    • Enable virtual appointments
  • Build a virtual event platform
  • Contact center
  • Embed chat in Teams custom app
  • References
    • Overview
    • Azure CLI
    • REST API
    • Azure Resource Manager
      • Azure Resource Manager JavaScript
      • Azure Resource Manager .NET
      • Azure Resource Manager Java
      • Azure Resource Manager Python
    • Common Azure API client libraries
      • Common JavaScript
      • Common .NET
      • Common Android/Java
      • Common iOS
• Troubleshooting
  • Troubleshooting in Azure Communication Services
  • Troubleshooting response codes
• Help and support
  • Help and support options
  • Azure Advisor
  • Azure Metrics
• Resources
  • Release notes
  • Learn modules
  • Samples index
  • Azure Communication Services blog
  • Phone number management
    • Argentina
    • Australia
    • Austria
    • Belgium
    • Brazil
    • Canada
    • Chile
    • China
    • Colombia
    • Czech Republic
    • Denmark
    • Estonia
    • Finland
    • France
    • Germany
    • Hong Kong SAR
    • Indonesia
    • Ireland
    • Israel
    • Italy
    • Japan
    • Latvia
    • Lithuania
    • Luxembourg
    • Malaysia
    • Mexico
    • Netherlands
    • New Zealand
    • Norway
    • Philippines
    • Poland
    • Portugal
    • Saudi Arabia
    • Singapore
    • Slovakia
    • Slovenia
    • South Africa
    • South Korea
    • Spain
    • Sweden
    • Switzerland
    • Taiwan
    • Thailand
    • United Arab Emirates
    • United Kingdom
    • United States