Opt Outs - Remove

Dienst:

Communication

API-Version:

2026-01-23

Entfernen Sie Telefonnummern aus der Optout-Liste.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	True	string (url)	Die Kommunikationsressource, z. B. https://my-resource.communication.azure.com
api-version	query	True	string	Version der API, die aufgerufen werden soll.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
from	True	string minLength: 1	Die Kennung des Absenders (in der Regel Telefonnummer im E.164-Format), die sich im Besitz des authentifizierten Kontos befindet.
recipients	True	OptOutRecipient[]	Eine einzige Opt-out-Empfängernummer.

Antworten

Name	Typ	Beschreibung
200 OK	OptOutResponse	Success
400 Bad Request	BadRequestErrorResponse	Ungültige Anforderung
401 Unauthorized	StandardErrorResponse	Nicht autorisiert

Beispiele

Opt In

Beispielanforderung

HTTP

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

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

Beispiel für eine Antwort

Statuscode:

200

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

Statuscode:

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
  }
}

Statuscode:

401

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

Definitionen

Name	Beschreibung
BadRequestErrorResponse	Ungültige Anforderungsfehlerantwort, die sowohl Validierungsfehler als auch Standard-API-Fehler darstellen kann.
ErrorDetail	Detailinformationen zum Fehler.
OptOutRecipient	Eine einzige Opt-out-Empfängernummer.
OptOutRequest	Eine Opt-out-Anfrage.
OptOutResponse	Antwort auf eine Opt-out-Anfrage. Überprüfen Sie die zurückgegebenen Elemente in der Antwort, um zu sehen, welche Empfänger erfolgreich zur Opt-out-Liste hinzugefügt oder daraus entfernt wurden.
OptOutResponseItem
StandardErrorResponse	Standardformat für die Fehlerantwort.

BadRequestErrorResponse

Objekt

Ungültige Anforderungsfehlerantwort, die sowohl Validierungsfehler als auch Standard-API-Fehler darstellen kann.

Name	Typ	Beschreibung
error	ErrorDetail	Fehlerdetailinformationen (für Standard-API-Fehler).
errors	object	Wörterbuch der feldspezifischen Validierungsfehler (für Validierungsfehler).
status	integer (int32)	Der HTTP-Statuscode (für Validierungsfehler).
title	string	Eine kurze, für Menschen lesbare Zusammenfassung des Problemtyps (für Validierungsfehler).
traceId	string	Die Ablaufverfolgungskennung für die Anforderung (für Validierungsfehler).
type	string	Eine URI-Referenz, die den Problemtyp identifiziert (für Validierungsfehler).

ErrorDetail

Objekt

Detailinformationen zum Fehler.

Name	Typ	Beschreibung
code	string	Der Fehlercode.
innerError	object	Zusätzliche Fehlerdetails.
message	string	Die Fehlermeldung.

OptOutRecipient

Objekt

Eine einzige Opt-out-Empfängernummer.

Name	Typ	Beschreibung
to	string minLength: 1	Die Telefonnummer des Empfängers (im E.164-Format).

OptOutRequest

Objekt

Eine Opt-out-Anfrage.

Name	Typ	Beschreibung
from	string minLength: 1	Die Kennung des Absenders (in der Regel Telefonnummer im E.164-Format), die sich im Besitz des authentifizierten Kontos befindet.
recipients	OptOutRecipient[]	Eine einzige Opt-out-Empfängernummer.

OptOutResponse

Objekt

Antwort auf eine Opt-out-Anfrage. Überprüfen Sie die zurückgegebenen Elemente in der Antwort, um zu sehen, welche Empfänger erfolgreich zur Opt-out-Liste hinzugefügt oder daraus entfernt wurden.

Name	Typ	Beschreibung
value	OptOutResponseItem[]

OptOutResponseItem

Objekt

Name	Typ	Beschreibung
errorMessage	string	Optionale Fehlermeldung bei 4xx/5xx-Fehlern.
httpStatusCode	integer (int32)
isOptedOut	boolean	Optionales Flag, das angibt, ob die Nummer vom Empfang von Nachrichten abgemeldet wurde
to	string minLength: 1	Die Telefonnummer des Empfängers (im E.164-Format).

StandardErrorResponse

Objekt

Standardformat für die Fehlerantwort.

Name	Typ	Beschreibung
error	ErrorDetail	Detailinformationen zum Fehler.