SDK:er och REST API:er
Azure Communication Services är konceptuellt ordnade i åtta områden. De flesta områden har fullständigt öppen källkod-SDK:er programmerade mot publicerade REST API:er som du kan använda direkt via Internet. Anrops-SDK:n använder egna nätverksgränssnitt och är stängd källa.
I tabellerna nedan sammanfattar vi dessa områden och tillgängligheten för REST-API:er och SDK-bibliotek. Vi noterar också om API:er och SDK:er är avsedda för slutanvändarens klienter eller betrodda tjänstmiljöer. API:er och SDK:er som SMS bör inte användas direkt av slutanvändarenheterna i miljöer med lågt förtroende.
Utvecklingen av webbaserade samtals- och chattprogram kan påskyndas genom att Azure Communication Services användargränssnittsbibliotek. Ui-biblioteket innehåller produktionsklara UI-komponenter som du kan släppa i dina program.
REST API:er
Communication Services-API:er dokumenteras tillsammans med andra Azure REST API:er i docs.microsoft.com. Den här dokumentationen visar hur du strukturerar dina HTTP-meddelanden och ger vägledning om hur du använder Postman. Dokumentation om REST-gränssnittet finns också i Swagger-format på GitHub.
SDK:er
| Sammansättning | Protokoll | Miljö | Funktioner |
|---|---|---|---|
| Azure Resource Manager | REST | Tjänst | Etablera och hantera Communication Services resurser |
| Common | Ej tillämpligt | Klienttjänst & tjänst | Tillhandahåller bastyper för andra SDK:er |
| Identitet | REST | Tjänst | Hantera användare, åtkomsttoken |
| Telefonnummer | REST | Tjänst | Hämta och hantera telefonnummer |
| SMS | REST | Tjänst | Skicka och ta emot SMS |
| Chatt | REST med upphovsrättsskyddad signalering | Klienttjänst & tjänst | Lägga till textchatt i realtid i dina program |
| Ringer | Upphovsrättsskyddad transport | Client | Röst, video, skärmdelning och annan realtidskommunikation |
| Anropa server | REST | Tjänst | Göra och hantera anrop, spela upp ljud och konfigurera inspelning |
| Network Traversal | REST | Tjänst | Få åtkomst till TURN-servrar för datatransport på låg nivå |
| Gränssnittsbibliotek | Ej tillämpligt | Client | Produktionsklara gränssnittskomponenter för chatt- och samtalsappar |
Språk och publiceringsplatser
Publiceringsplatser för enskilda SDK-paket beskrivs nedan.
| Område | JavaScript | .NET | Python | Java SE | iOS | Android | Övrigt |
|---|---|---|---|---|---|---|---|
| Azure Resource Manager | npm | NuGet | PyPi | Maven | - | - | Gå via GitHub |
| Common | npm | NuGet | Ej tillämpligt | Maven | GitHub | Maven | - |
| Identitet | npm | NuGet | PyPi | Maven | - | - | - |
| Telefon tal | npm | NuGet | PyPi | Maven | - | - | - |
| Chatt | npm | NuGet | PyPi | Maven | GitHub | Maven | - |
| SMS | npm | NuGet | PyPi | Maven | - | - | - |
| Ringer | npm | NuGet | - | - | GitHub | Maven | - |
| Anropa Automation | NuGet | Maven | |||||
| Network Traversal | npm | NuGet | PyPi | Maven | - | - | - |
| Gränssnittsbibliotek | npm | - | - | - | - | - | GitHub, Storybook |
| Referensdokumentation | Docs | Docs | - | Docs | Docs | Docs | - |
Mappningen mellan egna sammansättningsnamn och namnrymder är:
| Sammansättning | Namnrymder |
|---|---|
| Azure Resource Manager | Azure.ResourceManager.Communication |
| Common | Azure.Communication.Common |
| Identitet | Azure.Communication.Identity |
| Telefonnummer | Azure.Communication.PhoneNumbers |
| SMS | Azure.Communication.SMS |
| Chatt | Azure.Communication.Chat |
| Ringer | Azure.Communication.Calling |
| Anropa server | Azure.Communication.CallingServer |
| Network Traversal | Azure.Communication.NetworkTraversal |
| Gränssnittsbibliotek | Azure.Communication.Calling |
REST API begränsningar
Vissa REST API:er och motsvarande SDK-metoder har begränsningar som du bör tänka på. Om dessa begränsningar överskrids utlöses ett 429 - Too Many Requests felsvar. Dessa gränser kan ökas genom en begäran om att Azure Support.
| API | Begränsning |
|---|---|
| Alla API:er för plan för söktelefonnummer | 4 begäranden/dag |
| Plan för inköpsordernummer | 1 köp per månad |
| Skicka SMS | 200 begäranden/minut |
Supportinformation för SDK-plattformen
iOS och Android
- Communication Services iOS-SDK:er är mål för iOS version 13+ och Xcode 11+.
- Android Java-API:er är mål för Android API-nivå 21+ Android Studio 4.0+
.NET
Förutom Anrop, Communication Services paketen .NET Standard 2.0, som stöder de plattformar som anges nedan.
Support via .NET Framework 4.6.1
- Windows 10, 8.1, 8 och 7
- Windows Server 2012 R2, 2012 och 2008 R2 SP1
Stöd via .NET Core 2.0:
- Windows 10 (1607+), 7 SP1+, 8.1
- Windows Server 2008 R2 SP1+
- Max OS X 10.12+
- Linux flera versioner/distributioner
- UWP 10.0.16299 (RS3) september 2017
- Unity 2018.1
- Mono 5.4
- Xamarin iOS 10.14
- Xamarin Mac 3.8
Calling-paketet har stöd för UWP-appar som .NET Native eller C++/WinRT på:
- Windows 10 10.0.17763
- Windows Server 2019 10.0.17763
API-stabilitetsförväntningar
Viktigt
Det här avsnittet innehåller vägledning om REST-API:er och SDK:er som markerats som stabila. API:er som markerats som förhandsversion, förhandsversion eller betaversion kan ändras eller bli inaktuella utan föregående meddelande.
I framtiden kan vi dra tillbaka versioner av Communication Services-API:er och vi kan införa större ändringar i våra REST-API:er och utgivna SDK:er. Azure Communication Services vanligtvis två supportprinciper för att ta bort tjänstversioner:
- Du meddelas minst tre år innan du måste ändra koden på grund av en ändring Communication Services gränssnittet. Alla dokumenterade REST API:er och SDK-API:er har vanligtvis minst tre års varning innan gränssnitt inaktiveras.
- Du meddelas minst ett år innan du måste uppdatera SDK-sammansättningar till den senaste delversionen. De här nödvändiga uppdateringarna bör inte kräva några kodändringar eftersom de är i samma huvudversion. Att använda den senaste SDK:n är särskilt viktigt för biblioteken För samtal och chatt som realtidskomponenter som ofta kräver säkerhets- och prestandauppdateringar. Vi rekommenderar starkt att du håller alla Communication Services-SDK:er uppdaterade.
Exempel på avställning av API och SDK
Du har integrerat v24-versionen av SMS-REST API i ditt program. Azure Communication släpper v25.
Du får tre års varning innan dessa API:er slutar fungera och tvingas att uppdatera till v25. Den här uppdateringen kan kräva en kodändring.
Du har integrerat v2.02-versionen av Anropa SDK i ditt program. Azure Communication släpper v2.05.
Du kan behöva uppdatera till v2.05-versionen av anropande SDK inom 12 månader efter lanseringen av v2.05. Detta bör vara en enkel ersättning av artefakten utan att kräva en kodändring eftersom v2.05 är i huvudversionen v2 och inte har några större ändringar.
Nästa steg
Mer information finns i följande SDK-översikter:
Så här kommer du igång med Azure Communication Services: