Opt Outs - Remove

Usługa:

Communication

Wersja interfejsu API:

2026-01-23

Usuń numery telefonów z listy rezygnacji.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
endpoint	path	True	string (url)	Zasób komunikacji, na przykład https://my-resource.communication.azure.com
api-version	query	True	string	Wersja interfejsu API do wywołania.

Treść żądania

Nazwa	Wymagane	Typ	Opis
from	True	string minLength: 1	Identyfikator nadawcy (zazwyczaj numer telefonu w formacie E.164), którego właścicielem jest uwierzytelnione konto.
recipients	True	OptOutRecipient[]	Pojedynczy numer odbiorcy, z którego można zrezygnować.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	OptOutResponse	Powodzenie
400 Bad Request	BadRequestErrorResponse	Nieprawidłowe żądanie
401 Unauthorized	StandardErrorResponse	Brak autoryzacji

Przykłady

Opt In

Przykładowe żądanie

HTTP

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

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

Przykładowa odpowiedź

Kod stanu:

200

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

Kod stanu:

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

Kod stanu:

401

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

Definicje

Nazwa	Opis
BadRequestErrorResponse	Nieprawidłowa odpowiedź na błąd żądania, która może reprezentować zarówno błędy walidacji, jak i standardowe błędy interfejsu API.
ErrorDetail	Szczegółowe informacje o błędzie.
OptOutRecipient	Pojedynczy numer odbiorcy, z którego można zrezygnować.
OptOutRequest	Wniosek o rezygnację.
OptOutResponse	Odpowiedź na wniosek o rezygnację. Sprawdź poprawność zwróconych elementów w odpowiedzi, aby zobaczyć, którzy adresaci zostali pomyślnie dodani lub usunięci z listy rezygnacji.
OptOutResponseItem
StandardErrorResponse	Standardowy format odpowiedzi na błąd.

BadRequestErrorResponse

Objekt

Nieprawidłowa odpowiedź na błąd żądania, która może reprezentować zarówno błędy walidacji, jak i standardowe błędy interfejsu API.

Nazwa	Typ	Opis
error	ErrorDetail	Szczegółowe informacje o błędach (w przypadku standardowych błędów interfejsu API).
errors	object	Słownik błędów walidacji specyficznych dla pola (dla błędów walidacji).
status	integer (int32)	Kod stanu HTTP (w przypadku błędów sprawdzania poprawności).
title	string	Krótkie, czytelne dla człowieka podsumowanie typu problemu (w przypadku błędów walidacji).
traceId	string	Identyfikator śledzenia dla żądania (w przypadku błędów walidacji).
type	string	Odwołanie do identyfikatora URI identyfikujące typ problemu (w przypadku błędów sprawdzania poprawności).

ErrorDetail

Objekt

Szczegółowe informacje o błędzie.

Nazwa	Typ	Opis
code	string	Kod błędu.
innerError	object	Dodatkowe informacje o błędach.
message	string	Komunikat o błędzie.

OptOutRecipient

Objekt

Pojedynczy numer odbiorcy, z którego można zrezygnować.

Nazwa	Typ	Opis
to	string minLength: 1	Numer telefonu odbiorcy (w formacie E.164).

OptOutRequest

Objekt

Wniosek o rezygnację.

Nazwa	Typ	Opis
from	string minLength: 1	Identyfikator nadawcy (zazwyczaj numer telefonu w formacie E.164), którego właścicielem jest uwierzytelnione konto.
recipients	OptOutRecipient[]	Pojedynczy numer odbiorcy, z którego można zrezygnować.

OptOutResponse

Objekt

Odpowiedź na wniosek o rezygnację. Sprawdź poprawność zwróconych elementów w odpowiedzi, aby zobaczyć, którzy adresaci zostali pomyślnie dodani lub usunięci z listy rezygnacji.

Nazwa	Typ	Opis
value	OptOutResponseItem[]

OptOutResponseItem

Objekt

Nazwa	Typ	Opis
errorMessage	string	Opcjonalny komunikat o błędzie w przypadku błędów 4xx/5xx.
httpStatusCode	integer (int32)
isOptedOut	boolean	Opcjonalna flaga określająca, czy numer został wyłączony z otrzymywania wiadomości
to	string minLength: 1	Numer telefonu odbiorcy (w formacie E.164).

StandardErrorResponse

Objekt

Standardowy format odpowiedzi na błąd.

Nazwa	Typ	Opis
error	ErrorDetail	Szczegółowe informacje o błędzie.