Opt Outs - Remove

Dienst:

Communication

API-Version:

2025-05-29-preview

Entfernen Sie Telefonnummern aus der Liste der Optouts.

POST {endpoint}/sms/optouts:remove?api-version=2025-05-29-preview

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	Der Bezeichner des Absenders (in der Regel Telefonnummer im E.164-Format), der sich im Besitz des authentifizierten Kontos befindet.
recipients	True	OptOutRecipient[]	Eine einzelne Empfängernummer abmelden.

Antworten

Name	Typ	Beschreibung
200 OK	OptOutResponse	Erfolg

Beispiele

Opt In

Beispielanforderung

HTTP

POST {endpoint}/sms/optouts:remove?api-version=2025-05-29-preview

{
  "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"
    }
  ]
}

Definitionen

Name	Beschreibung
OptOutRecipient	Eine einzelne Empfängernummer abmelden.
OptOutRequest	Eine Abmeldeanforderung.
OptOutResponse	Antwort auf eine Abmeldungsanforderung. Überprüfen Sie die zurückgegebenen Elemente in der Antwort, um zu sehen, welche Empfänger erfolgreich hinzugefügt oder aus der Liste der Abmelden entfernt wurden.
OptOutResponseItem

OptOutRecipient

Objekt

Eine einzelne Empfängernummer abmelden.

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

OptOutRequest

Objekt

Eine Abmeldeanforderung.

Name	Typ	Beschreibung
from	string minLength: 1	Der Bezeichner des Absenders (in der Regel Telefonnummer im E.164-Format), der sich im Besitz des authentifizierten Kontos befindet.
recipients	OptOutRecipient[]	Eine einzelne Empfängernummer abmelden.

OptOutResponse

Objekt

Antwort auf eine Abmeldungsanforderung. Überprüfen Sie die zurückgegebenen Elemente in der Antwort, um zu sehen, welche Empfänger erfolgreich hinzugefügt oder aus der Liste der Abmelden 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 Kennzeichen, das angibt, ob die Nummer vom Empfangen von Nachrichten abgemeldet wurde
to	string minLength: 1	Die Telefonnummer des Empfängers (im E.164-Format).