SDKs e APIs REST
Os recursos dos Serviços de Comunicação do Azure são organizados conceitualmente em áreas discretas com base em sua área funcional. A maioria das áreas apresenta SDKs disponibilizadas inteiramente em software livre programados com base em APIs REST publicadas que você pode usar diretamente pela Internet. O SDK de chamada usa interfaces de rede proprietárias e tem código-fonte fechado no momento.
Nas tabelas abaixo, resumimos essas áreas e a disponibilidade de APIs REST e bibliotecas de SDK. Indicamos se as APIs e os SDKs destinam-se a clientes de usuário final ou ambientes de serviço confiável. As APIs, assim como SMS, não devem ser acessadas diretamente por dispositivos de usuário final em ambientes de baixa confiança.
O desenvolvimento de aplicativos de Chamada e Chat pode ser acelerado pela Biblioteca de interface do usuário dos Serviços de Comunicação do Azure. A biblioteca de interface do usuário personalizável fornece componentes de interface do usuário de código aberto para aplicativos Web e móveis e um tema do Microsoft Teams.
Criar uma prática para usar o SDK mais recente
Navegadores e sistemas operacionais estão em constante evolução para dar suporte aos aprimoramentos mais recentes e corrigir bugs existentes. Usar o SDK mais recente dos Serviços de Comunicação do Azure pode ajudar você a obter a melhor experiência geral do usuário final para o seu aplicativo quando usado com navegadores atualizados e atualizações do sistema operacional. O SDK dos Serviços de Comunicação do Azure mais atualizado oferece muitos benefícios, como melhor desempenho, segurança, compatibilidade, qualidade e usabilidade. A atualização permite que você acesse os recursos e atualizações mais recentes que são adicionados regularmente ao navegador e ao sistema operacional. Os SDKs dos Serviços de Comunicação do Azure são atualizados com frequência (aproximadamente a cada 6 semanas até uma vez por trimestre). É recomendável que você crie um processo para garantir que você esteja sempre atualizado com os SDKs mais recentes.
SDKs
| Assembly | Protocolos | Ambiente | Funcionalidades |
|---|---|---|---|
| Azure Resource Manager | REST | Serviço | Provisionar e gerenciar recursos dos Serviços de Comunicação |
| Comum | N/D | Cliente e serviço | Fornece tipos de base para outros SDKs |
| Identidade | REST | Serviço | Gerenciar usuários, tokens de acesso |
| Telefones | REST | Serviço | Adquirir e gerenciar números de telefone |
| SMS | REST | Serviço | Enviar e receber mensagens SMS |
| REST | Serviço | Enviar e obter status de mensagens de email | |
| Chat | REST com sinalização proprietária | Cliente e serviço | Adicionar chat de texto em tempo real a aplicativos |
| Chamando | Transporte proprietário | Cliente | Voz, vídeo, compartilhamento de tela e outros recursos de comunicação em tempo real |
| Automação de chamada | REST | Serviço | Criar fluxos de trabalho de chamada personalizados para chamadas PSTN e VoIP |
| Roteador de Trabalhos | REST | Serviço | Otimizar o gerenciamento de interações do cliente nos diversos aplicativos |
| Salas | REST | Serviço | Criar e gerenciar salas de comunicação estruturadas |
| Biblioteca de interface do usuário | N/D | Cliente | Componentes de interface do usuário prontos para produção para aplicativos de chat e chamada |
| Mensagens avançadas | REST | Serviço | Enviar e receber mensagens do WhatsApp Business |
Idiomas e locais de publicação
Locais de publicação de pacotes de SDK individuais:
| Área | JavaScript | .NET | Python | Java SE | iOS | Android | Outro |
|---|---|---|---|---|---|---|---|
| Azure Resource Manager | npm | NuGet | PyPi | Maven | - | - | Go por meio do GitHub |
| Comum | npm | NuGet | N/D | Maven | GitHub | Maven | - |
| Identidade | npm | NuGet | PyPi | Maven | - | - | - |
| Números de telefone | npm | NuGet | PyPi | Maven | - | - | - |
| Chat | npm | NuGet | PyPi | Maven | GitHub | Maven | - |
| SMS | npm | NuGet | PyPi | Maven | - | - | - |
| npm | NuGet | PyPi | Maven | - | - | - | |
| Chamando | npm | NuGet | - | - | CocoaPods | Maven | - |
| Automação de chamada | npm | NuGet | PyPi | Maven | |||
| Roteador de Trabalhos | npm | NuGet | PyPi | Maven | |||
| Salas | npm | NuGet | PyPi | Maven | - | - | - |
| Biblioteca de interface do usuário | npm | - | - | - | GitHub | GitHub | GitHub, Storybook |
| Mensagens avançadas | npm | NuGet | PyPi | Maven | - | - | - |
| Documentação de referência | docs | docs | docs | docs | docs | docs | - |
Detalhes de suporte da plataforma SDK
Suporte para Android chamando SDK
- Suporte para API do Android Nível 21 ou superior
- Suporte para Java 7 ou superior
- Suporte para Android Studio 2.0
Suporte à plataforma Android
O ecossistema do Android é extenso, abrangendo várias versões e plataformas especializadas projetadas para diversos tipos de dispositivos. A próxima tabela lista as plataformas Android com suporte no momento:
| Dispositivos | Descrição | Suporte |
|---|---|---|
| Telefones e tablets | Dispositivos padrão que executam o Android Comercial. | Suporte total com a resolução de vídeo. |
Observação
Só damos suporte a chamadas de vídeo em telefones e tablets. Para casos de uso envolvendo vídeos em dispositivos ou plataformas não padrão (como óculos inteligentes ou dispositivos personalizados), sugerimos entrar em contato conosco no início do processo de desenvolvimento para ajudar a determinar a abordagem de integração mais adequada.
Caso você encontre problemas durante a implementação, recomendamos que visite o guia de resolução de problemas.
Suporte para iOS chamando SDK
- Suporte para iOS 10.0 + no momento da compilação e iOS 12.0 + em tempo de execução
- Xcode 12.0+
- Suporte para iPadOS 13.0+
.NET
A chamada dá suporte às seguintes plataformas:
- UWP com .NET Native ou C++/WinRT
- Windows 10/11 10.0.17763 - 10.0.22621.0
- Windows Server 2019/2022 10.0.17763 - 10.0.22621.0
- WinUI3 com .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 os outros pacotes dos Serviços de Comunicação se destinam ao .NET Standard 2.0, que dá suporte às seguintes plataformas:
- Suporte via .NET Framework 4.6.1
- Windows 10, 8.1, 8 e 7
- Windows Server 2012 R2, 2012 e 2008 R2 SP1
- Suporte via .NET Core 2.0:
- Windows 10 (1607+), 7 SP1+, 8.1
- Windows Server 2008 R2 SP1+
- Mac OS X 10.12+
- Várias versões/distribuições do Linux
- UWP 10.0.16299 (RS3) setembro de 2017
- Unity 2018.1
- Mono 5.4
- Xamarin iOS 10.14
- Xamarin Mac 3.8
Tamanho do pacote de SDK
| . | Tamanho compactado (MB) | Tamanho descompactado (MB) |
|---|---|---|
| SDK do iOS | ARM64 – 17,1 MB | ARM64 – 61,1 MB |
| SDK do Android | x86 – 13,3 MB | x86 – 33,75 MB |
| x86_64 – 13,3 MB | x86_64 – 35,75 MB | |
| ARM64-v8a – 13,1 MB | ARM64-v8a – 37,02 MB | |
| armeabi-v7a – 11,4 MB | armeabi-v7a – 23,97 MB |
Se você quiser melhorar seu aplicativo, sugerimos ler o artigo melhores práticas. Ele fornece recomendações e uma lista de verificação a serem revisadas antes de lançar seu aplicativo.
APIs REST
As APIs dos Serviços de Comunicação estão documentadas juntamente com outras APIs REST do Azure. Esta documentação informa como estruturar as mensagens HTTP e oferece orientação para uso do Postman. A documentação da interface REST também é publicada no formato Swagger no GitHub. Você pode encontrar limites para APIs individuais na página de limites de serviço.
Expectativas de estabilidade da API
Importante
Esta seção fornece diretrizes sobre APIs REST e SDKs marcados como estáveis. As APIs marcadas como pré-lançamento, versão preliminar ou beta podem ser alteradas ou preteridas sem aviso prévio.
No futuro, podemos desativar versões dos SDKs dos Serviços de Comunicação e podemos introduzir alterações interruptivas em nossas APIs REST e SDKs lançados. Os Serviços de Comunicação do Azure geralmente seguem duas políticas de suporte para desativar versões de serviço:
- Você é notificado pelo menos três anos antes de ser obrigado a alterar o código devido a uma alteração na interface dos Serviços de Comunicação. Todas as APIs REST e APIs do SDK documentadas geralmente desfrutam de um aviso de pelo menos três anos antes do encerramento das interfaces.
- Você é notificado pelo menos um ano antes de precisar atualizar os assemblies do SDK para a versão secundária mais recente. Essas atualizações necessárias não devem exigir nenhuma alteração de código porque fazem parte da mesma versão principal. Usar o SDK mais recente é especialmente importante para as bibliotecas de chamada e chat, que oferecem componentes em tempo real que geralmente exigem atualizações de segurança e desempenho. É altamente recomendável manter os SDKs dos Serviços de Comunicação atualizados.
Exemplos de desativação de API e SDK
Você integrou a versão v24 da API REST do SMS ao seu aplicativo. A Comunicação do Azure lança a v25.
Você receberá um aviso de três anos antes que essas APIs parem de funcionar e você seja obrigado a atualizar para v25. Essa atualização pode exigir uma alteração de código.
Você integrou a versão v2.02 do SDK de Chamada ao seu aplicativo. A Comunicação do Azure lança a v2.05.
Talvez seja necessário atualizar para a versão v2.05 do SDK de Chamada até 12 meses após o lançamento da v2.05. A atualização deve ser uma substituição do artefato sem a necessidade de uma alteração de código porque a v2.05 faz parte da versão principal v2 e não tem alterações interruptivas.
Próximas etapas
Para obter mais informações, consulte as seguintes visões gerais do SDK:
- Visão geral do SDK de Chamada
- Visão geral do SDK de Automação de Chamadas
- Visão geral do SDK do Roteador de Trabalhos
- Visão geral do SDK de Chat
- Visão geral do SDK de SMS
- Visão geral do SDK de Email
- Visão geral do SDK de Mensagens Avançadas
Para começar com o Serviços de Comunicação do Azure: