Skip to content

Commit d816ab1

Browse files
authored
Create Opt-Out-Api.md
1 parent 0eb5264 commit d816ab1

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
title: SMS Opt-Out Management API for Azure Communication Services
3+
titleSuffix: An Azure Communication Services concept document
4+
description: Provides an overview of the SMS Opt-Out Management API
5+
author: dbasantes
6+
services: azure-communication-services
7+
8+
ms.author: dbasantes
9+
ms.date: 12/04/2024
10+
ms.topic: conceptual
11+
ms.service: azure-communication-services
12+
ms.subservice: sms
13+
---
14+
# Opt-Out management overview
15+
The Opt-Out Management API enables Azure Communication Services customers to manage opt-out requests for SMS messages. It provides a self-service platform for businesses to handle opt-out requests, ensuring compliance with regulations and protecting customer privacy.
16+
Currently, opt-out handling includes configuring responses to mandatory opt-out keywords, such as STOP/START/HELP. The responses are stored and the list of opted-out numbers is maintained in the Azure Communication Services Opt-Out database. This database management is automatic.
17+
The Opt-Out database contains entries added when a recipient sends an opt-out keyword. An entry includes the fields: Sender, Recipient, and Country. If a recipient opts back in, the corresponding entry is deleted.
18+
To learn more about how opt-out is handled at Azure Communication Services, read our [FAQ](https://learn.microsoft.com/en-us/azure/communication-services/concepts/sms/sms-faq#how-does-azure-communication-services-handle-opt-outs-for-short-codes.md) page.
19+
20+
## Opt-Out management API
21+
We are extending opt-out management by enabling ACS customers to manage the Opt-Out database via an API. This API provide the ability to add, remove, or check opt-out entries, effectively overriding the automatic management.
22+
Key features included:
23+
24+
- **Maintaining an Opt-Out List:** The API maintains a centralized list of opt-out requests, enabling businesses to easily add, remove, and check for individuals who have opted out of SMS communications.
25+
- **Enforcing Opt-Out Preferences:** The API integrates with the opt-out list to ensure that preferences are respected. No SMS messages should be sent to individuals who have opted out.
26+
27+
## Next steps
28+
29+
Let's get started with the [SMS Opt-out API quickstart](https://github.com/dbasantes/azure-docs-pr/new/main/articles/communication-services/quickstarts/sms/opt-out-api-quickstart.md)

0 commit comments

Comments
 (0)