Opt Outs - Remove

Service:

Communication

Version d'API:

2026-01-23

Supprimez les numéros de téléphone de la liste des désabonnements.

POST {endpoint}/sms/optouts:remove?api-version=2026-01-23

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
endpoint	path	True	string (url)	Ressource de communication, par exemple https://my-resource.communication.azure.com
api-version	query	True	string	Version de l’API à appeler.

Corps de la demande

Nom	Obligatoire	Type	Description
from	True	string minLength: 1	L’identifiant de l’expéditeur (généralement un numéro de téléphone au format E.164) qui appartient au compte authentifié.
recipients	True	OptOutRecipient[]	Un seul numéro de destinataire d’opt-out.

Réponses

Nom	Type	Description
200 OK	OptOutResponse	Success
400 Bad Request	BadRequestErrorResponse	Demande incorrecte
401 Unauthorized	StandardErrorResponse	Non autorisé

Exemples

Opt In

Exemple de requête

HTTP

POST {endpoint}/sms/optouts:remove?api-version=2026-01-23

{
  "from": "+18001234567",
  "recipients": [
    {
      "to": "+15555555551"
    },
    {
      "to": "+123"
    },
    {
      "to": "+15555555553"
    }
  ]
}

Exemple de réponse

Code d’état:

200

{
  "value": [
    {
      "to": "+15555555551",
      "httpStatusCode": 200
    },
    {
      "to": "+123",
      "httpStatusCode": 400,
      "errorMessage": "Invalid recipient phone number format"
    },
    {
      "to": "+15555555553",
      "httpStatusCode": 500,
      "errorMessage": "Internal Server Error"
    }
  ]
}

Code d’état:

400

{
  "error": {
    "code": "InvalidApiVersion",
    "message": "The HTTP resource that matches the request URI 'https://global.sms.int.communication.microsoft.com/sms/optouts:remove' does not support the API version '2024-12-10w-preview'.",
    "innerError": null
  }
}

Code d’état:

401

{
  "error": {
    "code": "Unauthorized",
    "message": ""
  }
}

Définitions

Nom	Description
BadRequestErrorResponse	Réponse d’erreur Bad Request qui peut représenter à la fois des erreurs de validation et des erreurs d’API standard.
ErrorDetail	Informations détaillées sur l’erreur.
OptOutRecipient	Un seul numéro de destinataire d’opt-out.
OptOutRequest	Une demande d’opt-out.
OptOutResponse	Réponse à une demande de retrait. Validez les éléments renvoyés dans la réponse pour voir quels destinataires ont été ajoutés ou supprimés de la liste des désinscriptions.
OptOutResponseItem
StandardErrorResponse	Format standard de réponse d’erreur.

BadRequestErrorResponse

Object

Réponse d’erreur Bad Request qui peut représenter à la fois des erreurs de validation et des erreurs d’API standard.

Nom	Type	Description
error	ErrorDetail	Informations détaillées sur l’erreur (pour les erreurs d’API standard).
errors	object	Dictionnaire des erreurs de validation spécifiques à un champ (pour les erreurs de validation).
status	integer (int32)	Le code d’état HTTP (pour les erreurs de validation).
title	string	Un résumé court et lisible du type de problème (pour les erreurs de validation).
traceId	string	L’identifiant de trace de la demande (pour les erreurs de validation).
type	string	Référence d’URI qui identifie le type de problème (pour les erreurs de validation).

ErrorDetail

Object

Informations détaillées sur l’erreur.

Nom	Type	Description
code	string	Code d’erreur.
innerError	object	Détails supplémentaires sur l’erreur.
message	string	Message d’erreur.

OptOutRecipient

Object

Un seul numéro de destinataire d’opt-out.

Nom	Type	Description
to	string minLength: 1	Le numéro de téléphone du destinataire (au format E.164).

OptOutRequest

Object

Une demande d’opt-out.

Nom	Type	Description
from	string minLength: 1	L’identifiant de l’expéditeur (généralement un numéro de téléphone au format E.164) qui appartient au compte authentifié.
recipients	OptOutRecipient[]	Un seul numéro de destinataire d’opt-out.

OptOutResponse

Object

Réponse à une demande de retrait. Validez les éléments renvoyés dans la réponse pour voir quels destinataires ont été ajoutés ou supprimés de la liste des désinscriptions.

Nom	Type	Description
value	OptOutResponseItem[]

OptOutResponseItem

Object

Nom	Type	Description
errorMessage	string	Message d’erreur facultatif en cas d’erreurs 4xx/5xx.
httpStatusCode	integer (int32)
isOptedOut	boolean	Indicateur facultatif spécifiant si le numéro a été désabonné de la réception des messages
to	string minLength: 1	Le numéro de téléphone du destinataire (au format E.164).

StandardErrorResponse

Object

Format standard de réponse d’erreur.

Nom	Type	Description
error	ErrorDetail	Informations détaillées sur l’erreur.