You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/communication-services/concepts/sdk-options.md
+19-17Lines changed: 19 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,15 +7,15 @@ manager: chpalm
7
7
services: azure-communication-services
8
8
9
9
ms.author: chpalm
10
-
ms.date: 10/10/2022
10
+
ms.date: 04/16/2024
11
11
ms.topic: conceptual
12
12
ms.service: azure-communication-services
13
13
---
14
14
# SDKs and REST APIs
15
15
16
-
Azure Communication Services capabilities are conceptually organized into discrete areas based on their functional area. Most areas have fully open-sourced SDKs programmed against published REST APIs that you can use directly over the Internet. The Calling SDK uses proprietary network interfaces and is closed-source.
16
+
Azure Communication Services capabilities are conceptually organized into discrete areas based on their functional area. Most areas have fully open-source SDKs programmed against published REST APIs that you can use directly over the Internet. The Calling SDK uses proprietary network interfaces and is closed-source.
17
17
18
-
In the tables below we summarize these areas and availability of REST APIs and SDK libraries. We note if APIs and SDKs are intended for end-user clients or trusted service environments. APIs such as SMS should not be directly accessed by end-user devices in low trust environments.
18
+
In the tables below we summarize these areas and availability of REST APIs and SDK libraries. We note if APIs and SDKs are intended for end-user clients or trusted service environments. APIs such as SMS shouldn't be directly accessed by end-user devices in low trust environments.
19
19
20
20
Development of Calling and Chat applications can be accelerated by the [Azure Communication Services UI library](./ui-library/ui-library-overview.md). The customizable UI library provides open-source UI components for Web and mobile apps, and a Microsoft Teams theme.
21
21
@@ -36,10 +36,11 @@ Development of Calling and Chat applications can be accelerated by the [Azure C
36
36
| Network Traversal |[REST](./network-traversal.md)| Service| Access TURN servers for low-level data transport |
37
37
| Rooms |[REST](/rest/api/communication/rooms/operation-groups)| Service| Create and manage structured communication rooms |
38
38
| UI Library | N/A | Client | Production-ready UI components for chat and calling apps |
39
+
| Advanced Messaging |[REST](/rest/api/communication/advancedmessaging/operation-groups)| Service | Send and receive WhatsApp Business messages |
39
40
40
41
### Languages and publishing locations
41
42
42
-
Publishing locations for individual SDK packages are detailed below.
43
+
Publishing locations for individual SDK packages:
43
44
44
45
| Area | JavaScript | .NET | Python | Java SE | iOS | Android | Other|
@@ -76,7 +77,7 @@ Publishing locations for individual SDK packages are detailed below.
76
77
77
78
#### .NET
78
79
79
-
Calling supports the platforms listed below.
80
+
Calling supports the following platforms:
80
81
81
82
- UWP with .NET Native or C++/WinRT
82
83
- Windows 10/11 10.0.17763 - 10.0.22621.0
@@ -85,7 +86,7 @@ Calling supports the platforms listed below.
85
86
- Windows 10/11 10.0.17763.0 - net6.0-windows10.0.22621.0
86
87
- Windows Server 2019/2022 10.0.17763.0 - net6.0-windows10.0.22621.0
87
88
88
-
All other Communication Services packages target .NET Standard 2.0, which supports the platforms listed below.
89
+
All other Communication Services packages target .NET Standard 2.0, which supports the following platforms:
89
90
90
91
- Support via .NET Framework 4.6.1
91
92
- Windows 10, 8.1, 8 and 7
@@ -103,14 +104,14 @@ All other Communication Services packages target .NET Standard 2.0, which suppor
103
104
104
105
## REST APIs
105
106
106
-
Communication Services APIs are documented alongside other [Azure REST APIs](/rest/api/azure/). This documentation will tell you how to structure your HTTP messages and offers guidance for using [Postman](../tutorials/postman-tutorial.md). REST interface documentation is also published in Swagger format on [GitHub](https://github.com/Azure/azure-rest-api-specs). You can find throttling limits for individual APIs on [service limits page](./service-limits.md).
107
+
Communication Services APIs are documented alongside other [Azure REST APIs](/rest/api/azure/). This documentation tells you how to structure your HTTP messages and offers guidance for using [Postman](../tutorials/postman-tutorial.md). REST interface documentation is also published in Swagger format on [GitHub](https://github.com/Azure/azure-rest-api-specs). You can find throttling limits for individual APIs on [service limits page](./service-limits.md).
107
108
108
109
## API stability expectations
109
110
110
111
> [!IMPORTANT]
111
112
> This section provides guidance on REST APIs and SDKs marked **stable**. APIs marked pre-release, preview, or beta may be changed or deprecated **without notice**.
112
113
113
-
In the future we may retire versions of the Communication Services SDKs, and we may introduce breaking changes to our REST APIs and released SDKs. Azure Communication Services will *generally*follow two supportability policies for retiring service versions:
114
+
In the future we may retire versions of the Communication Services SDKs, and we may introduce breaking changes to our REST APIs and released SDKs. Azure Communication Services *generally*follows two supportability policies for retiring service versions:
114
115
115
116
- You'll be notified at least three years before being required to change code due to a Communication Services interface change. All documented REST APIs and SDK APIs generally enjoy at least three years warning before interfaces are decommissioned.
116
117
- You'll be notified at least one year before having to update SDK assemblies to the latest minor version. These required updates shouldn't require any code changes because they're in the same major version. Using the latest SDK is especially important for the Calling and Chat libraries that real-time components that often require security and performance updates. We strongly encourage you to keep all your Communication Services SDKs updated.
@@ -123,7 +124,7 @@ You'll get three years warning before these APIs stop working and are forced to
123
124
124
125
**You've integrated the v2.02 version of the Calling SDK into your application. Azure Communication releases v2.05.**
125
126
126
-
You may be required to update to the v2.05 version of the Calling SDK within 12 months of the release of v2.05. This should be a simple replacement of the artifact without requiring a code change because v2.05 is in the v2 major version and has no breaking changes.
127
+
You may be required to update to the v2.05 version of the Calling SDK within 12 months of the release of v2.05. The update should be a simple replacement of the artifact without requiring a code change because v2.05 is in the v2 major version and has no breaking changes.
127
128
128
129
## Next steps
129
130
@@ -135,6 +136,7 @@ For more information, see the following SDK overviews:
![prmerger-automator[bot]](https://avatars.githubusercontent.com/u/22479449?v=4&size=40){kind=avatar}
0 commit comments