Opt Outs - Remove

Serviço:

Communication

Versão da API:

2026-01-23

Remova os números de telefone da lista de exclusões.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
endpoint	path	True	string (url)	O recurso de comunicação, por exemplo, https://my-resource.communication.azure.com
api-version	query	True	string	Versão da API a invocar.

Corpo do Pedido

Name	Necessário	Tipo	Description
from	True	string minLength: 1	O identificador do remetente (normalmente número de telefone no formato E.164) que pertence à conta autenticada.
recipients	True	OptOutRecipient[]	Um único número de destinatário de exclusão.

Respostas

Name	Tipo	Description
200 OK	OptOutResponse	Sucesso
400 Bad Request	BadRequestErrorResponse	Pedido Incorreto
401 Unauthorized	StandardErrorResponse	Não autorizado

Exemplos

Opt In

Pedido de amostra

HTTP

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

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

Resposta da amostra

Código de estado:

200

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

Código de estado:

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

Código de estado:

401

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

Definições

Name	Description
BadRequestErrorResponse	Resposta de erro de solicitação incorreta que pode representar erros de validação e erros de API padrão.
ErrorDetail	Informações detalhadas do erro.
OptOutRecipient	Um único número de destinatário de exclusão.
OptOutRequest	Um pedido de exclusão.
OptOutResponse	Resposta a um pedido de autoexclusão. Valide os itens retornados na resposta para ver quais destinatários foram adicionados ou removidos com êxito da lista de exclusões.
OptOutResponseItem
StandardErrorResponse	Formato padrão de resposta a erros.

BadRequestErrorResponse

Object

Resposta de erro de solicitação incorreta que pode representar erros de validação e erros de API padrão.

Name	Tipo	Description
error	ErrorDetail	Informações detalhadas do erro (para erros de API padrão).
errors	object	Dicionário de erros de validação específicos de campo (para erros de validação).
status	integer (int32)	O código de status HTTP (para erros de validação).
title	string	Um resumo curto e legível por humanos do tipo de problema (para erros de validação).
traceId	string	O identificador de rastreamento para a solicitação (para erros de validação).
type	string	Uma referência de URI que identifica o tipo de problema (para erros de validação).

ErrorDetail

Object

Informações detalhadas do erro.

Name	Tipo	Description
code	string	O código de erro.
innerError	object	Detalhes adicionais do erro.
message	string	A mensagem de erro.

OptOutRecipient

Object

Um único número de destinatário de exclusão.

Name	Tipo	Description
to	string minLength: 1	O número de telefone do destinatário (no formato E.164).

OptOutRequest

Object

Um pedido de exclusão.

Name	Tipo	Description
from	string minLength: 1	O identificador do remetente (normalmente número de telefone no formato E.164) que pertence à conta autenticada.
recipients	OptOutRecipient[]	Um único número de destinatário de exclusão.

OptOutResponse

Object

Resposta a um pedido de autoexclusão. Valide os itens retornados na resposta para ver quais destinatários foram adicionados ou removidos com êxito da lista de exclusões.

Name	Tipo	Description
value	OptOutResponseItem[]

OptOutResponseItem

Object

Name	Tipo	Description
errorMessage	string	Mensagem de erro opcional em caso de erros 4xx/5xx.
httpStatusCode	integer (int32)
isOptedOut	boolean	Sinalizador opcional especificando se o número foi Opted out de receber mensagens
to	string minLength: 1	O número de telefone do destinatário (no formato E.164).

StandardErrorResponse

Object

Formato padrão de resposta a erros.

Name	Tipo	Description
error	ErrorDetail	Informações detalhadas do erro.