SDK y API REST

Las funcionalidades de Azure Communication Services se organizan conceptualmente en áreas discretas en función de su área funcional. La mayoría de las áreas tienen SDK de código abierto totalmente programados con las API de REST publicadas que puede usar directamente a través de Internet. Calling SDK usa interfaces de red propietarias y tiene formato de código cerrado.

En las tablas siguientes se resumen estas áreas y la disponibilidad de las API REST y las bibliotecas del SDK. Observamos si las API y los SDK están diseñados para clientes de usuario final o entornos de servicio de confianza. Los dispositivos de usuario final de entornos de confianza baja no deben acceder directamente a las API, como SMS.

El desarrollo de aplicaciones de llamadas y chat basadas en web puede acelerarse con la biblioteca de interfaz de usuario de Azure Communication Services. La biblioteca de interfaz de usuario personalizable proporciona componentes de interfaz de usuario de código abierto para aplicaciones web y móviles, y un tema de Microsoft Teams personalizado.

SDK

Ensamblado Protocolos Entorno Funcionalidades
Azure Resource Manager REST Service Aprovisiona y administra recursos de Communication Services.
Comunes N/D Cliente y servicio Proporciona tipos base para otros SDK
Identidad REST Service Administración de usuarios y tokens de acceso
Números de teléfono REST Service Adquisición y administración de números de teléfono
SMS REST Service Enviar y recibir mensajes SMS
Email REST Service Envío y obtención del estado en los mensajes de correo electrónico
Chat REST con señalización propietaria Cliente y servicio Incorpora chat de texto en tiempo real a las aplicaciones.
Llamar Transporte propietario Remoto Permite usar la voz, el vídeo, el uso compartido de pantalla y otras comunicaciones en tiempo real.
Automatización de llamadas REST Service Creación de flujos de trabajo de llamadas personalizados para llamadas RTC y VoIP
Enrutador de trabajos REST Service Optimización de la administración de interacciones de clientes en varias aplicaciones
Network Traversal REST Service Permite acceder a servidores TURN para el transporte de datos de bajo nivel.
Salas REST Service Creación y administración de salas de comunicación estructuradas
Biblioteca de interfaz de usuario N/D Remoto Componentes de interfaz de usuario listos para producción para aplicaciones de chat y de llamadas

Idiomas y ubicaciones de publicación

A continuación se detallan las ubicaciones de publicación para los paquetes de SDK individuales.

Área JavaScript .NET Python Java SE iOS Android Otros
Azure Resource Manager npm NuGet PyPi Maven - - Go a través de GitHub
Comunes npm NuGet N/D Maven GitHub Maven -
Identidad npm NuGet PyPi Maven - - -
Números de teléfono npm NuGet PyPi Maven - - -
Chat npm NuGet PyPi Maven GitHub Maven -
SMS npm NuGet PyPi Maven - - -
Email npm NuGet PyPi Maven - - -
Llamar npm NuGet - - CocoaPods Maven -
Automatización de llamadas npm NuGet PyPi Maven
Enrutador de trabajos npm NuGet PyPi Maven
Network Traversal npm NuGet PyPi Maven - - -
Salas npm NuGet PyPi Maven - - -
Biblioteca de interfaz de usuario npm - - - GitHub GitHub GitHub, Storybook
Mensajería avanzada - NuGet - - - - -
Documentación de referencia Documentación Documentación Documentación Documentación Documentación Documentación -

Detalles de compatibilidad de la plataforma de SDK

Compatibilidad con el SDK de llamada de Android

  • Compatibilidad con Android API Nivel 21 o superior
  • Compatibilidad con Java 7 o posterior
  • Compatibilidad con Android Studio 2.0
  • Actualmente no se admiten Android Auto (AAOS) y dispositivos IoT que ejecuten Android

Compatibilidad con el SDK de llamada de iOS

  • Compatibilidad con iOS 10.0+ en tiempo de compilación y iOS 12.0+ en tiempo de ejecución
  • Xcode 12.0+
  • Compatibilidad con iPadOS 13.0+

.NET

Las llamadas admiten las plataformas que se enumeran a continuación.

  • UWP con .NET Native o C++/WinRT
    • Windows 10/11 10.0.17763 - 10.0.22621.0
    • Windows Server 2019/2022 10.0.17763 - Windows Server 10.0.22621.0
  • WinUI3 con .NET 6
    • Windows 10/11 10.0.17763.0 - net6.0-windows10.0.22621.0
    • Windows Server 2019/2022 10.0.17763.0 : net6.0-windows10.0.22621.0

Todos los demás paquetes de Communication Services tienen como destino .NET Standard 2.0, que admite las plataformas que se enumeran a continuación.

  • Compatibilidad mediante .NET Framework 4.6.1
    • Windows 10, 8.1, 8 y 7
    • Windows Server 2012 R2, 2012 y 2008 R2 SP1
  • Compatibilidad mediante .NET Core 2.0:
    • Windows 10 (1607+), 7 SP1+, 8.1
    • Windows Server 2008 R2 SP1 y versiones posteriores
    • Max OS X 10.12+
    • Varias versiones o distribuciones de Linux
    • UWP 10.0.16299 (RS3) septiembre 2017
    • Unity 2018.1
    • Mono 5.4
    • Xamarin iOS 10.14
    • Xamarin Mac 3.8

API de REST

Las API de Communication Services están documentadas junto con otras API REST de Azure. Esta documentación le indicará cómo estructurar los mensajes HTTP y ofrece instrucciones para el uso de Postman. La documentación de la interfaz de REST también se ofrece en formato Swagger en GitHub. Puede encontrar límites para las API individuales en la página de límites de servicio.

Expectativas de estabilidad de API

Importante

En esta sección se proporcionan instrucciones sobre las API DE REST y los SDK marcados como estables. Las API marcadas como versión preliminar o beta se pueden cambiar o dejar de usar sin previo aviso.

En el futuro, es posible que retiremos las versiones de los SDK de Communication Services y que introduzcamos cambios importantes en nuestras API de REST y SDK publicados. Azure Communication Services generalmente sigue dos directivas de compatibilidad para retirar versiones de servicio:

  • Se le notificará con una antelación de al menos tres años cuando sea necesario cambiar el código debido a un cambio en la interfaz de Communication Services. Todas las API de REST documentadas y las API de los SDK generalmente disfrutan de un período de al menos tres años de advertencia antes de que se retiren las interfaces.
  • Se le notificará al menos un año antes de que tenga que actualizar los ensamblados de los SDK a la versión secundaria más reciente. Estas actualizaciones necesarias no deben requerir ningún cambio en el código porque están en la misma versión principal. El uso del SDK más reciente es sumamente importante para las bibliotecas de Calling y Chat que usan componentes en tiempo real que a menudo requieren actualizaciones de seguridad y rendimiento. Le recomendamos encarecidamente que mantenga actualizados todos los SDK de Communication Services.

Ejemplos de retirada de API y SDK

Ha integrado la versión 24 de la API de REST de SMS en la aplicación. Versiones de Azure Communication v25.

Recibirá una advertencia tres años antes de que estas API dejen de funcionar y sea obligatorio actualizarlas a la v25. Es posible que esta actualización requiera un cambio de código.

Ha integrado la versión v2.02 del SDK de llamada en la aplicación. Versiones de Azure Communication v2.05.

Es posible que se le pida que actualice a la versión v2.05 de los SDK de llamadas en un plazo de 12 meses a partir de la publicación de la v2.05. Debe ser un reemplazo sencillo del artefacto sin necesidad de un cambio de código porque la v2.05 está en la versión principal v2 y no tiene cambios importantes.

Pasos siguientes

Para obtener más información, consulte la siguiente información general de los SDK:

Para empezar a trabajar con Azure Communication Services: