Opt Outs - Remove

Servizio:

Communication

Versione API:

2026-01-23

Rimuovi i numeri di telefono dall'elenco delle opzioni di rifiuto.

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

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	L'identificatore del mittente (in genere il numero di telefono in formato E.164) di proprietà dell'account autenticato.
recipients	True	OptOutRecipient[]	Un unico numero di destinatario per il rifiuto.

Risposte

Nome	Tipo	Descrizione
200 OK	OptOutResponse	Success
400 Bad Request	BadRequestErrorResponse	Richiesta non valida
401 Unauthorized	StandardErrorResponse	Non autorizzata

Esempio

Opt In

Esempio di richiesta

HTTP

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

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

Codice di stato:

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

Codice di stato:

401

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

Definizioni

Nome	Descrizione
BadRequestErrorResponse	Risposta di errore di richiesta non valida che può rappresentare sia errori di convalida che errori API standard.
ErrorDetail	Informazioni dettagliate sull'errore.
OptOutRecipient	Un unico numero di destinatario per il rifiuto.
OptOutRequest	Una richiesta di rifiuto.
OptOutResponse	Risposta per una richiesta di rifiuto. Convalida gli elementi restituiti nella risposta per vedere quali destinatari sono stati aggiunti o rimossi correttamente dall'elenco di rifiuto esplicito.
OptOutResponseItem
StandardErrorResponse	Formato standard di risposta agli errori.

BadRequestErrorResponse

Object

Risposta di errore di richiesta non valida che può rappresentare sia errori di convalida che errori API standard.

Nome	Tipo	Descrizione
error	ErrorDetail	Informazioni dettagliate sull'errore (per gli errori API standard).
errors	object	Dizionario degli errori di convalida specifici del campo (per gli errori di convalida).
status	integer (int32)	Il codice di stato HTTP (per gli errori di convalida).
title	string	Un breve riassunto leggibile del tipo di problema (per gli errori di convalida).
traceId	string	Identificatore di traccia per la richiesta (per errori di convalida).
type	string	Riferimento URI che identifica il tipo di problema (per gli errori di convalida).

ErrorDetail

Object

Informazioni dettagliate sull'errore.

Nome	Tipo	Descrizione
code	string	Codice di errore.
innerError	object	Ulteriori dettagli sull'errore.
message	string	Messaggio di errore.

OptOutRecipient

Object

Un unico numero di destinatario per il rifiuto.

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

OptOutRequest

Object

Una richiesta di rifiuto.

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

OptOutResponse

Object

Risposta per una richiesta di rifiuto. Convalida 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 opzionale in caso di errori 4xx/5xx.
httpStatusCode	integer (int32)
isOptedOut	boolean	Flag facoltativo che specifica se il numero è stato escluso dalla ricezione dei messaggi
to	string minLength: 1	Il numero di telefono del destinatario (in formato E.164).

StandardErrorResponse

Object

Formato standard di risposta agli errori.

Nome	Tipo	Descrizione
error	ErrorDetail	Informazioni dettagliate sull'errore.