SDK's en REST API's
Azure Communication Services mogelijkheden zijn conceptueel ingedeeld in acht gebieden. In de meeste gebieden zijn volledig opensource-SDK's geprogrammeerd op basis van gepubliceerde REST API's die u rechtstreeks via internet kunt gebruiken. De aanroepen van SDK maakt gebruik van eigen netwerkinterfaces en is gesloten bron.
In de onderstaande tabellen geven we een overzicht van deze gebieden en de beschikbaarheid van REST API's en SDK-bibliotheken. We zien ook of API's en SDK's zijn bedoeld voor eindgebruikers-clients of vertrouwde serviceomgevingen. API's en SDK's zoals SMS mogen niet rechtstreeks worden gebruikt door apparaten van eindgebruikers in omgevingen met een lage vertrouwensrelatie.
De ontwikkeling van webgebaseerde aanroep- en chattoepassingen kan worden versneld door gebruikersinterfacebibliotheken Azure Communication Services gebruiken. De UI-bibliotheek biedt ui-onderdelen die gereed zijn voor productie die u in uw toepassingen kunt neerzetten.
REST-API’s
Communication Services API's worden samen met andere Azure REST API's in docs.microsoft.com. Deze documentatie laat u zien hoe u uw HTTP-berichten kunt structureren en biedt richtlijnen voor het gebruik van Postman. Rest-interfacedocumentatie wordt ook aangeboden in Swagger-indeling op GitHub.
SDK's
| Assembly | Protocollen | Omgeving | Functies |
|---|---|---|---|
| Azure Resource Manager | REST | Service | Resources inrichten en Communication Services beheren |
| Algemeen | N.v.t. | Client & Service | Biedt basistypen voor andere SDK's |
| Identiteit | REST | Service | Gebruikers beheren, toegangstokens |
| Telefoonnummers | REST | Service | Telefoonnummers verkrijgen en beheren |
| Sms | REST | Service | Sms-berichten verzenden en ontvangen |
| Chat | REST met eigen signalering | Client & Service | Realtime tekstchat toevoegen aan uw toepassingen |
| Aanroepen | Eigendomstransport | Client | Spraak, video, scherm delen en andere realtime communicatie |
| Server aanroepen | REST | Service | Aanroepen maken en beheren, audio afspelen en opname configureren |
| Network Traversal | REST | Service | Toegang tot TURN-servers voor gegevenstransport op laag niveau |
| UI-bibliotheek | N.v.t. | Client | Gebruikersinterfaceonderdelen die gereed zijn voor productie voor chat- en aanroep-apps |
Talen en publicatielocaties
Publicatielocaties voor afzonderlijke SDK-pakketten worden hieronder beschreven.
| Gebied | Javascript | .NET | Python | Java SE | iOS | Android | Anders |
|---|---|---|---|---|---|---|---|
| Azure Resource Manager | npm | NuGet | PyPi | Maven | - | - | Go via GitHub |
| Algemeen | npm | NuGet | N.v.t. | Maven | GitHub | Maven | - |
| Identiteit | npm | NuGet | PyPi | Maven | - | - | - |
| Telefoon getallen | npm | NuGet | PyPi | Maven | - | - | - |
| Chat | npm | NuGet | PyPi | Maven | GitHub | Maven | - |
| Sms | npm | NuGet | PyPi | Maven | - | - | - |
| Aanroepen | npm | NuGet | - | - | GitHub | Maven | - |
| Automatisering aanroepen | NuGet | Maven | |||||
| Network Traversal | npm | NuGet | PyPi | Maven | - | - | - |
| UI-bibliotheek | npm | - | - | - | - | - | GitHub, Storybook |
| Referentiedocumentatie | docs | docs | - | docs | docs | docs | - |
De toewijzing tussen gebruiksvriendelijke assemblynamen en naamruimten is:
| Assembly | Naamruimten |
|---|---|
| Azure Resource Manager | Azure.ResourceManager.Communication |
| Algemeen | Azure.Communication.Common |
| Identiteit | Azure.Communication.Identity |
| Telefoonnummers | Azure.Communication.PhoneNumbers |
| Sms | Azure.Communication.SMS |
| Chat | Azure.Communication.Chat |
| Aanroepen | Azure.Communication.Calling |
| Server aanroepen | Azure.Communication.CallingServer |
| Network Traversal | Azure.Communication.NetworkTraversal |
| UI-bibliotheek | Azure.Communication.Calling |
REST API vertragingen
Bepaalde REST API's en bijbehorende SDK-methoden hebben beperkingslimieten waar u rekening mee moet houden. Als u deze limieten overschrijdt, wordt er een 429 - Too Many Requests foutbericht weergegeven. Deze limieten kunnen worden verhoogd via een aanvraag voor Ondersteuning voor Azure.
| API | Vertragen |
|---|---|
| Alle API's voor het zoektelefoonnummerplan | 4 aanvragen per dag |
| Abonnement op telefoonnummer aanschaffen | 1 aankoop per maand |
| SMS verzenden | 200 aanvragen per minuut |
Ondersteuningsdetails voor SDK-platform
iOS en Android
- Communication Services iOS SDK's zijn gericht op iOS versie 13+ en Xcode 11+.
- Android Java SDK's zijn gericht op Android API niveau 21+ en Android Studio 4.0+
.NET
Met uitzondering van aanroepen, Communication Services pakketten gericht op .NET Standard 2.0, die ondersteuning biedt voor de onderstaande platforms.
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
Het oproeppakket ondersteunt het bouwen van UWP-apps met systeemeigen .NET of C++/WinRT op:
- Windows 10 10.0.17763
- Windows Server 2019 10.0.17763
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 pre-release, 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 uit bedrijf nemen en kunnen we belangrijke wijzigingen aanbrengen in onze REST API's en uitgebrachte SDK's. Azure Communication Services volgt doorgaans twee ondersteuningsbeleidsregels voor het terugschakelen van serviceversies:
- U krijgt ten minste drie jaar een melding voordat u code moet wijzigen vanwege een Communication Services interfacewijziging. Alle gedocumenteerde REST API's en SDK-API's krijgen doorgaans een waarschuwing van ten minste drie jaar voordat interfaces buiten gebruik worden gesteld.
- U ontvangt ten minste één jaar een melding voordat u SDK-assemblies moet bijwerken naar de nieuwste secundaire versie. Voor deze vereiste updates mogen geen codewijzigingen nodig zijn, omdat ze zich in dezelfde hoofdversie hebben. Het gebruik van de nieuwste SDK is vooral belangrijk voor de aanroep- en chatbibliotheken die in realtime onderdelen gebruiken waarvoor vaak beveiligings- en prestatie-updates nodig zijn. We raden u ten zeerste aan om al uw Communication Services SDK's bijgewerkt te houden.
Voorbeelden van het uit bedrijf nemen van API's en SDK's
U hebt de versie v24 van de sms-REST API in uw toepassing. Azure Communication brengt v25 uit.
U krijgt een waarschuwing van drie jaar voordat deze API's niet meer werken en worden gedwongen om bij te werken naar v25. Voor deze update is mogelijk een codewijziging vereist.
U hebt de versie v2.02 van de SDK voor oproepen geïntegreerd in uw toepassing. Azure Communication brengt v2.05 uit.
Mogelijk moet u binnen 12 maanden na de release van v2.05 bijwerken naar de versie v2.05 van de SDK voor oproepen. Dit moet een eenvoudige vervanging van het artefact zijn zonder dat er een codewijziging nodig is, omdat v2.05 zich in de hoofdversie van v2 en geen belangrijke wijzigingen heeft.
Volgende stappen
Zie de volgende SDK-overzichten voor meer informatie:
Ga als volgende te werk om aan de slag Azure Communication Services: