Opt Outs - Remove

Servicio:

Communication

Versión de la API:

2026-01-23

Elimine los números de teléfono de la lista de exclusión.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
endpoint	path	True	string (url)	Recurso de comunicación, por ejemplo, https://my-resource.communication.azure.com
api-version	query	True	string	Versión de la API que se va a invocar.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
from	True	string minLength: 1	El identificador del remitente (normalmente el número de teléfono en formato E.164) que es propiedad de la cuenta autenticada.
recipients	True	OptOutRecipient[]	Un único número de destinatario de exclusión.

Respuestas

Nombre	Tipo	Description
200 OK	OptOutResponse	Success
400 Bad Request	BadRequestErrorResponse	Solicitud incorrecta
401 Unauthorized	StandardErrorResponse	No autorizado

Ejemplos

Opt In

Solicitud de ejemplo

HTTP

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

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

Respuesta de muestra

status code:

200

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

status code:

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

status code:

401

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

Definiciones

Nombre	Description
BadRequestErrorResponse	Respuesta de error de solicitud incorrecta que puede representar errores de validación y errores de API estándar.
ErrorDetail	Información detallada del error.
OptOutRecipient	Un único número de destinatario de exclusión.
OptOutRequest	Una solicitud de exclusión.
OptOutResponse	Respuesta a una solicitud de exclusión. Valide los elementos devueltos en la respuesta para ver qué destinatarios se agregaron o eliminaron correctamente de la lista de exclusión.
OptOutResponseItem
StandardErrorResponse	Formato de respuesta de error estándar.

BadRequestErrorResponse

Object

Respuesta de error de solicitud incorrecta que puede representar errores de validación y errores de API estándar.

Nombre	Tipo	Description
error	ErrorDetail	Información detallada del error (para errores estándar de API).
errors	object	Diccionario de errores de validación específicos del campo (para errores de validación).
status	integer (int32)	El código de estado HTTP (para errores de validación).
title	string	Un resumen breve y legible del tipo de problema (para errores de validación).
traceId	string	El identificador de seguimiento de la solicitud (para errores de validación).
type	string	Una referencia de URI que identifica el tipo de problema (para errores de validación).

ErrorDetail

Object

Información detallada del error.

Nombre	Tipo	Description
code	string	Código de error.
innerError	object	Detalles adicionales del error.
message	string	El mensaje de error.

OptOutRecipient

Object

Un único número de destinatario de exclusión.

Nombre	Tipo	Description
to	string minLength: 1	El número de teléfono del destinatario (en formato E.164).

OptOutRequest

Object

Una solicitud de exclusión.

Nombre	Tipo	Description
from	string minLength: 1	El identificador del remitente (normalmente el número de teléfono en formato E.164) que es propiedad de la cuenta autenticada.
recipients	OptOutRecipient[]	Un único número de destinatario de exclusión.

OptOutResponse

Object

Respuesta a una solicitud de exclusión. Valide los elementos devueltos en la respuesta para ver qué destinatarios se agregaron o eliminaron correctamente de la lista de exclusión.

Nombre	Tipo	Description
value	OptOutResponseItem[]

OptOutResponseItem

Object

Nombre	Tipo	Description
errorMessage	string	Mensaje de error opcional en caso de errores 4xx/5xx.
httpStatusCode	integer (int32)
isOptedOut	boolean	Marca opcional que especifica si el número se excluyó de la recepción de mensajes
to	string minLength: 1	El número de teléfono del destinatario (en formato E.164).

StandardErrorResponse

Object

Formato de respuesta de error estándar.

Nombre	Tipo	Description
error	ErrorDetail	Información detallada del error.