Opt Outs - Remove

Servizio:

Communication

Versione API:

2025-05-29-preview

Rimuovere i numeri di telefono dall'elenco di optout.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
endpoint	path	True	string (url)	Risorsa di comunicazione, ad esempio https://my-resource.communication.azure.com
api-version	query	True	string	Versione dell'API da richiamare.

Corpo della richiesta

Nome	Necessario	Tipo	Descrizione
from	True	string minLength: 1	Identificatore del mittente (in genere numero di telefono in formato E.164) di proprietà dell'account autenticato.
recipients	True	OptOutRecipient[]	Un singolo numero di destinatario di rifiuto esplicito.

Risposte

Nome	Tipo	Descrizione
200 OK	OptOutResponse	Successo

Esempio

Opt In

Esempio di richiesta

HTTP

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

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

Risposta di esempio

Codice di stato:

200

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

Definizioni

Nome	Descrizione
OptOutRecipient	Un singolo numero di destinatario di rifiuto esplicito.
OptOutRequest	Richiesta di rifiuto esplicito.
OptOutResponse	Risposta per una richiesta di rifiuto esplicito. Convalidare gli elementi restituiti nella risposta per vedere quali destinatari sono stati aggiunti o rimossi correttamente dall'elenco di rifiuto esplicito.
OptOutResponseItem

OptOutRecipient

Object

Un singolo numero di destinatario di rifiuto esplicito.

Nome	Tipo	Descrizione
to	string minLength: 1	Numero di telefono del destinatario (in formato E.164).

OptOutRequest

Object

Richiesta di rifiuto esplicito.

Nome	Tipo	Descrizione
from	string minLength: 1	Identificatore del mittente (in genere numero di telefono in formato E.164) di proprietà dell'account autenticato.
recipients	OptOutRecipient[]	Un singolo numero di destinatario di rifiuto esplicito.

OptOutResponse

Object

Risposta per una richiesta di rifiuto esplicito. Convalidare gli elementi restituiti nella risposta per vedere quali destinatari sono stati aggiunti o rimossi correttamente dall'elenco di rifiuto esplicito.

Nome	Tipo	Descrizione
value	OptOutResponseItem[]

OptOutResponseItem

Object

Nome	Tipo	Descrizione
errorMessage	string	Messaggio di errore facoltativo in caso di errori 4xx/5xx.
httpStatusCode	integer (int32)
isOptedOut	boolean	Flag facoltativo che specifica se il numero è stato rifiutato esplicitamente dalla ricezione di messaggi
to	string minLength: 1	Numero di telefono del destinatario (in formato E.164).