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
* Python 2.7, or 3.5 or later is required to use this package.
26
-
* You must have an [Azure subscription](https://azure.microsoft.com/free/)
27
-
* You must have a phone number configured that is associated with an Azure subscription
28
25
29
-
## Install the package
26
+
## Getting started
27
+
28
+
### Prerequisites
29
+
30
+
- Python 2.7, or 3.5 or later is required to use this package.
31
+
- 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.
32
+
- You must have a phone number configured that is associated with an Azure subscription
33
+
34
+
### Install the package
30
35
31
36
Install the Azure Communication SMS client library for Python with [pip](https://pypi.org/project/pip/):
32
37
33
38
```bash
34
-
pip install azure-communication-sms --pre
39
+
pip install azure-communication-sms
35
40
```
36
41
37
-
# Key concepts
42
+
##Key concepts
38
43
39
44
Azure Communication SMS package is used to do following:
40
-
- Send an SMS
45
+
- Send SMS Messages
41
46
42
-
# Examples
47
+
##Examples
43
48
44
49
The following section provides several code snippets covering some of the most common Azure Communication Services tasks, including:
-`leased-phone-number`: an SMS enabled phone number associated with your communication service
71
-
-`to-phone-number`: the phone number you wish to send a message to
72
-
-`send_sms_options`: an optional parameter that you can use to configure Delivery Reporting. This is useful for scenarios where you want to emit events when SMS messages are delivered.
86
+
-`from_phone_number`: An SMS enabled phone number associated with your communication service.
87
+
-`to_phone_numbers`: The phone numbers you wish to send a message to.
88
+
-`message`: The message that you want to send.
89
+
-`enable_delivery_report`: An optional parameter that you can use to configure delivery reporting. This is useful for scenarios where you want to emit events when SMS messages are delivered.
90
+
-`tag`: An optional parameter that you can use to configure custom tagging.
91
+
92
+
93
+
## Troubleshooting
94
+
The Azure Communication Service Identity client will raise exceptions defined in [Azure Core](https://github.com/Azure/azure-sdk-for-python/blob/azure-communication-sms_1.0.0b6/sdk/core/azure-core/README.md).
95
+
96
+
## Next steps
97
+
### More sample code
98
+
99
+
Please take a look at the [samples](https://github.com/Azure/azure-sdk-for-python/tree/azure-communication-sms_1.0.0b6/sdk/communication/azure-communication-sms/samples) directory for detailed examples of how to use this library to send an sms.
73
100
74
-
#Troubleshooting
101
+
## Provide Feedback
75
102
76
-
Running into issues? This section should contain details as to what to do there.
103
+
If you encounter any bugs or have suggestions, please file an issue in the [Issues](https://github.com/Azure/azure-sdk-for-python/issues) section of the project
77
104
78
-
#Next steps
105
+
## Contributing
79
106
80
-
More sample code should go here, along with links out to the appropriate example tests.
107
+
This project welcomes contributions and suggestions. Most contributions require you to agree to a
108
+
Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.
81
109
82
-
# Contributing
110
+
When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the
111
+
PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.
83
112
84
-
If you encounter any bugs or have suggestions, please file an issue in the [Issues](<https://github.com/Azure/azure-sdk-for-python/issues>) section of the project.
113
+
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
114
+
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.
0 commit comments