Skip to content

Commit bfa40a2

Browse files
azure-sdkazure-sdk
committed
Update docs metadata
1 parent 3c7364e commit bfa40a2

File tree

2 files changed

+39
-30
lines changed

2 files changed

+39
-30
lines changed

‎docs-ref-services/latest/communication-sms-readme.md‎

Lines changed: 29 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,33 @@
1-
---
2-
title: Azure Communication SMS Package client library for Python
3-
keywords: Azure, python, SDK, API, azure-communication-sms, communication
4-
ms.date: 06/08/2021
5-
ms.topic: reference
6-
ms.devlang: python
7-
ms.service: azure-communication-services
8-
---
9-
# Azure Communication SMS Package client library for Python - version 1.0.1
1+
---
2+
title: Azure Communication SMS Package client library for Python
3+
keywords: Azure, python, SDK, API, azure-communication-sms, communication
4+
ms.date: 10/03/2024
5+
ms.topic: reference
6+
ms.devlang: python
7+
ms.service: communication
8+
---
9+
# Azure Communication SMS Package client library for Python - version 1.1.0
1010

1111

1212
This package contains a Python SDK for Azure Communication Services for SMS.
13-
Read more about Azure Communication Services [here](https://docs.microsoft.com/azure/communication-services/overview)
13+
Read more about Azure Communication Services [here](/azure/communication-services/overview)
1414

15-
[Source code](https://github.com/Azure/azure-sdk-for-python/blob/azure-communication-sms_1.0.1/sdk/communication/azure-communication-sms) | [Package (Pypi)](https://pypi.org/project/azure-communication-sms/) | [API reference documentation](https://github.com/Azure/azure-sdk-for-python/blob/azure-communication-sms_1.0.1/sdk/communication/azure-communication-sms) | [Product documentation](https://docs.microsoft.com/azure/communication-services/quickstarts/telephony-sms/send?pivots=programming-language-python)
15+
[Source code](https://github.com/Azure/azure-sdk-for-python/blob/azure-communication-sms_1.1.0/sdk/communication/azure-communication-sms)
16+
| [Package (Pypi)](https://pypi.org/project/azure-communication-sms/)
17+
| [Package (Conda)](https://anaconda.org/microsoft/azure-communication/)
18+
| [API reference documentation](https://github.com/Azure/azure-sdk-for-python/blob/azure-communication-sms_1.1.0/sdk/communication/azure-communication-sms)
19+
| [Product documentation](/azure/communication-services/quickstarts/telephony-sms/send?pivots=programming-language-python)
1620

21+
## _Disclaimer_
1722

23+
_Azure SDK Python packages support for Python 2.7 has ended 01 January 2022. For more information and questions, please refer to https://github.com/Azure/azure-sdk-for-python/issues/20691_
1824

1925
## Getting started
2026

2127
### Prerequisites
2228

23-
- Python 2.7, or 3.6 or later is required to use this package.
24-
- A deployed Communication Services resource. You can use the [Azure Portal](https://docs.microsoft.com/azure/communication-services/quickstarts/create-communication-resource?tabs=windows&pivots=platform-azp) or the [Azure PowerShell](https://docs.microsoft.com/powershell/module/az.communication/new-azcommunicationservice) to set it up.
29+
- Python 3.7 or later is required to use this package.
30+
- A deployed Communication Services resource. You can use the [Azure Portal](/azure/communication-services/quickstarts/create-communication-resource?tabs=windows&pivots=platform-azp) or the [Azure PowerShell](/powershell/module/az.communication/new-azcommunicationservice) to set it up.
2531
- You must have a phone number configured that is associated with an Azure subscription
2632

2733
### Install the package
@@ -51,7 +57,7 @@ The following section provides several code snippets covering some of the most c
5157
To initialize the SMS Client, the connection string can be used to instantiate.
5258
Alternatively, you can also use Active Directory authentication using DefaultAzureCredential.
5359

54-
```Python
60+
```python
5561
from azure.communication.sms import SmsClient
5662
from azure.identity import DefaultAzureCredential
5763

@@ -68,7 +74,7 @@ sms_client = SmsClient(endpoint, DefaultAzureCredential())
6874

6975
Once the client is initialized, the `send` method can be invoked:
7076

71-
```Python
77+
```python
7278
from azure.communication.sms import SendSmsOptions
7379

7480
sms_responses = sms_client.send(
@@ -89,7 +95,7 @@ sms_responses = sms_client.send(
8995

9096
Once the client is initialized, the `send` method can be invoked:
9197

92-
```Python
98+
```python
9399
from azure.communication.sms import SendSmsOptions
94100

95101
sms_responses = sms_client.send(
@@ -108,15 +114,15 @@ sms_responses = sms_client.send(
108114

109115

110116
## Troubleshooting
111-
SMS operations will throw an exception if the request to the server fails. The SMS client will raise exceptions defined in [Azure Core](https://github.com/Azure/azure-sdk-for-python/blob/azure-communication-sms_1.0.1/sdk/core/azure-core/README.md). Exceptions will not be thrown if the error is caused by an individual message, only if something fails with the overall request. Please use the successful flag to validate each individual result to verify if the message was sent.
117+
SMS operations will throw an exception if the request to the server fails. The SMS client will raise exceptions defined in [Azure Core](https://github.com/Azure/azure-sdk-for-python/blob/azure-communication-sms_1.1.0/sdk/core/azure-core/README.md). Exceptions will not be thrown if the error is caused by an individual message, only if something fails with the overall request. Please use the successful flag to validate each individual result to verify if the message was sent.
112118

113-
```Python
119+
```python
114120
try:
115121
sms_responses = sms_client.send(
116122
from_="<leased-phone-number>",
117123
to=["<to-phone-number-1>", "<to-phone-number-2>", "<to-phone-number-3>"],
118124
message="Hello World via SMS")
119-
125+
120126
for sms_response in sms_responses:
121127
if (sms_response.successful):
122128
print("Message with message id {} was successful sent to {}"
@@ -135,7 +141,7 @@ except Exception as ex:
135141

136142
### More sample code
137143

138-
Please take a look at the [samples](https://github.com/Azure/azure-sdk-for-python/tree/azure-communication-sms_1.0.1/sdk/communication/azure-communication-sms/samples) directory for detailed examples of how to use this library to send an sms.
144+
Please take a look at the [samples](https://github.com/Azure/azure-sdk-for-python/tree/azure-communication-sms_1.1.0/sdk/communication/azure-communication-sms/samples) directory for detailed examples of how to use this library to send an sms.
139145

140146
## Provide Feedback
141147

@@ -153,7 +159,6 @@ This project has adopted the [Microsoft Open Source Code of Conduct](https://ope
153159
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
154160

155161
<!-- LINKS -->
156-
[azure_core]: https://github.com/Azure/azure-sdk-for-python/blob/azure-communication-sms_1.0.1/sdk/core/azure-core/README.md
157-
[handle_sms_events]: https://docs.microsoft.com/azure/communication-services/quickstarts/telephony-sms/handle-sms-events
158-
[next_steps]:https://docs.microsoft.com/azure/communication-services/quickstarts/telephony-sms/send?pivots=programming-language-python
159-
162+
[azure_core]: https://github.com/Azure/azure-sdk-for-python/blob/azure-communication-sms_1.1.0/sdk/core/azure-core/README.md
163+
[handle_sms_events]: /azure/communication-services/quickstarts/telephony-sms/handle-sms-events
164+
[next_steps]:/azure/communication-services/quickstarts/telephony-sms/send?pivots=programming-language-python

‎metadata/latest/azure-communication-sms.json‎

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"Name": "azure-communication-sms",
3-
"Version": "1.0.1",
3+
"Version": "1.1.0",
44
"DevVersion": null,
55
"DirectoryPath": "sdk/communication/azure-communication-sms",
66
"ServiceDirectory": "communication",
@@ -10,15 +10,19 @@
1010
"SdkType": "client",
1111
"IsNewSdk": true,
1212
"ArtifactName": "azure-communication-sms",
13-
"ReleaseStatus": "2021-06-08",
13+
"ReleaseStatus": "2024-10-03",
14+
"IncludedForValidation": false,
15+
"AdditionalValidationPackages": [
16+
""
17+
],
18+
"Namespaces": [
19+
"azure.communication.sms"
20+
],
1421
"DocsCiConfigProperties": {
1522
"extension_config": {
1623
"autodoc_default_options": {
1724
"inherited-members": 1
1825
}
1926
}
20-
},
21-
"Namespaces": [
22-
"azure.communication.sms"
23-
]
27+
}
2428
}

0 commit comments

Comments
 (0)