SDK's en REST API's
De mogelijkheden van Azure Communication Services zijn conceptueel ingedeeld in afzonderlijke gebieden op basis van hun functionele gebied. De meeste gebieden hebben volledig opensource-SDK's die zijn geprogrammeerd op gepubliceerde REST API's die u rechtstreeks via internet kunt gebruiken. De Calling SDK maakt gebruik van eigen netwerkinterfaces en is gesloten bron.
In de onderstaande tabellen geven we een overzicht van deze gebieden en beschikbaarheid van REST API's en SDK-bibliotheken. We weten of API's en SDK's zijn bedoeld voor eindgebruikersclients of vertrouwde serviceomgevingen. API's zoals SMS moeten niet rechtstreeks worden geopend door apparaten van eindgebruikers in omgevingen met weinig vertrouwen.
De ontwikkeling van bel- en chattoepassingen kan worden versneld door de ui-bibliotheek van Azure Communication Services. De aanpasbare UI-bibliotheek biedt opensource-UI-onderdelen voor web- en mobiele apps en een Microsoft Teams-thema.
SDK's
| Assembly | Protocollen | Omgeving | Functies |
|---|---|---|---|
| Azure Resource Manager | REST | Service | Communication Services-resources inrichten en beheren |
| Gemeenschappelijk | N.v.t. | Client & Service | Biedt basistypen voor andere SDK's |
| Identiteit | REST | Service | Gebruikers, toegangstokens beheren |
| Telefoonnummers | REST | Service | Telefoonnummers verkrijgen en beheren |
| Sms | REST | Service | Sms-berichten verzenden en ontvangen |
| E-mailen | REST | Service | E-mailberichten verzenden en status ophalen |
| Chat | REST met eigen signalering | Client & Service | Realtime tekstchat toevoegen aan uw toepassingen |
| Bellen | Eigendom transport | Klant | Spraak, video, scherm delen en andere realtime communicatie |
| Gespreksautomatisering | REST | Service | Aangepaste belwerkstromen bouwen voor PSTN- en VoIP-aanroepen |
| Taakrouter | REST | Service | Het beheer van klantinteracties in verschillende toepassingen optimaliseren |
| Kamers | REST | Service | Gestructureerde communicatieruimten maken en beheren |
| UI-bibliotheek | N.v.t. | Klant | Onderdelen van de gebruikersinterface die gereed zijn voor productie voor chatten en aanroepen |
| Geavanceerde berichten | REST | Service | WhatsApp Business-berichten verzenden en ontvangen |
Talen en publicatielocaties
Publicatielocaties voor afzonderlijke SDK-pakketten:
| Gebied | JavaScript | .NET | Python | Java SE | iOS | Android | Overige |
|---|---|---|---|---|---|---|---|
| Azure Resource Manager | npm | NuGet | PyPi | Maven | - | - | Go via GitHub |
| Gemeenschappelijk | npm | NuGet | N.v.t. | Maven | GitHub | Maven | - |
| Identiteit | npm | NuGet | PyPi | Maven | - | - | - |
| Telefoonnummers | npm | NuGet | PyPi | Maven | - | - | - |
| Chat | npm | NuGet | PyPi | Maven | GitHub | Maven | - |
| Sms | npm | NuGet | PyPi | Maven | - | - | - |
| E-mailen | npm | NuGet | PyPi | Maven | - | - | - |
| Bellen | npm | NuGet | - | - | CocoaPods | Maven | - |
| Gespreksautomatisering | npm | NuGet | PyPi | Maven | |||
| Taakrouter | npm | NuGet | PyPi | Maven | |||
| Kamers | npm | NuGet | PyPi | Maven | - | - | - |
| UI-bibliotheek | npm | - | - | - | GitHub | GitHub | GitHub, Storybook |
| Geavanceerde berichten | npm | NuGet | PyPi | Maven | - | - | - |
| Referentiedocumentatie | docs | docs | docs | docs | docs | docs | - |
Details van sdk-platformondersteuning
Android Calling SDK-ondersteuning
- Ondersteuning voor Android-API-niveau 21 of hoger
- Ondersteuning voor Java 7 of hoger
- Ondersteuning voor Android Studio 2.0
- Android Auto (AAOS) en IoT-apparaten met Android worden momenteel niet ondersteund
Ondersteuning voor aanroepende SDK voor iOS
- Ondersteuning voor iOS 10.0+ tijdens de build en iOS 12.0+ tijdens runtime
- Xcode 12.0+
- Ondersteuning voor iPadOS 13.0+
.NET
Bellen ondersteunt de volgende platforms:
- UWP met systeemeigen .NET of C++/WinRT
- Windows 10/11 10.0.17763 - 10.0.22621.0
- Windows Server 2019/2022 10.0.17763 - 10.0.22621.0
- WinUI3 met .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
Alle andere Communication Services-pakketten zijn bedoeld voor .NET Standard 2.0, die ondersteuning biedt voor de volgende platformen:
- Ondersteuning via .NET Framework 4.6.1
- Windows 10, 8.1, 8 en 7
- Windows Server 2012 R2, 2012 en 2008 R2 SP1
- Ondersteuning via .NET Core 2.0:
- Windows 10 (1607+), 7 SP1+, 8.1
- Windows Server 2008 R2 SP1+
- Max OS X 10.12+
- Linux meerdere versies/distributies
- UWP 10.0.16299 (RS3) september 2017
- Unity 2018.1
- Mono 5.4
- Xamarin iOS 10.14
- Xamarin Mac 3.8
SDK-pakketgrootte
| SDK | Gecomprimeerde grootte (MB) | Niet-gecomprimeerde grootte (MB) |
|---|---|---|
| iOS-SDK | ARM64 - 17,1 MB | ARM64 - 61,1 MB |
| Android-SDK | 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 |
Als u uw app wilt verbeteren, raden we u aan het artikel Aanbevolen procedures te lezen. Het biedt aanbevelingen en een controlelijst om te controleren voordat uw app wordt uitgebracht.
REST-API's
Communication Services-API's worden samen met andere Azure REST API's gedocumenteerd. In deze documentatie wordt uitgelegd hoe u uw HTTP-berichten structureert en richtlijnen biedt voor het gebruik van Postman. Rest-interfacedocumentatie wordt ook gepubliceerd in Swagger-indeling op GitHub. U vindt beperkingslimieten voor afzonderlijke API's op de pagina servicelimieten.
VERWACHTINGEN VOOR API-stabiliteit
Belangrijk
Deze sectie bevat richtlijnen voor REST API's en SDK's die als stabiel zijn gemarkeerd. API's die als voorlopige versie, preview of bèta zijn gemarkeerd, kunnen zonder kennisgeving worden gewijzigd of afgeschaft.
In de toekomst kunnen we versies van de Communication Services SDK's buiten gebruik stellen en kunnen we belangrijke wijzigingen in onze REST API's en uitgebrachte SDK's introduceren. Azure Communication Services volgt over het algemeen twee ondersteuningsbeleidsregels voor het buiten gebruik stellen van serviceversies:
- U ontvangt ten minste drie jaar een melding voordat u code moet wijzigen vanwege een wijziging in de Communication Services-interface. Alle gedocumenteerde REST API's en SDK-API's hebben over het algemeen ten minste drie jaar waarschuwing voordat interfaces buiten gebruik worden gesteld.
- U ontvangt ten minste één jaar een melding voordat u SDK-assembly's moet bijwerken naar de nieuwste secundaire versie. Voor deze vereiste updates zijn geen codewijzigingen vereist, omdat ze zich in dezelfde primaire versie bevinden. Het gebruik van de nieuwste SDK is vooral belangrijk voor de aanroepen en chatbibliotheken die realtime-onderdelen vereisen die vaak beveiligingsupdates en prestatie-updates vereisen. We raden u sterk aan om al uw Communication Services-SDK's bijgewerkt te houden.
Voorbeelden van het buiten gebruik stellen van API en SDK
U hebt de v24-versie van de SMS REST API geïntegreerd in uw toepassing. Azure Communication brengt v25 uit.
U krijgt drie jaar waarschuwing voordat deze API's niet meer werken en moeten worden bijgewerkt naar v25. Voor deze update is mogelijk een codewijziging vereist.
U hebt de versie v2.02 van de Aanroepende SDK geïntegreerd in uw toepassing. Azure Communication brengt v2.05 uit.
Mogelijk moet u binnen 12 maanden na de release van v2.05 de v2.05-versie van de Aanroepende SDK bijwerken. De update moet een vervanging van het artefact zijn zonder dat er een codewijziging is vereist, omdat v2.05 zich in de primaire versie van v2 bevindt en geen wijzigingen bevat die fouten veroorzaken.
Volgende stappen
Zie de volgende SDK-overzichten voor meer informatie:
- Overzicht van aanroepende SDK
- Overzicht van De Automation SDK voor aanroepen
- Overzicht van taakrouter-SDK
- Overzicht van chat-SDK
- Overzicht van SMS SDK
- Overzicht van e-mail-SDK
- Overzicht van Advanced Messaging SDK
Aan de slag met Azure Communication Services:
- Een Azure Communication Services-resource maken
- Tokens voor gebruikerstoegang genereren