Opt Outs - Check
Compruebe el estado de exclusión de un número de teléfono de destinatario con un número de teléfono del remitente.
POST {endpoint}/sms/optouts:check?api-version=2025-05-29-preview
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 |
Identificador del remitente (normalmente número de teléfono en formato E.164) que es propiedad de la cuenta autenticada. |
recipients | True |
Un único número de destinatario de exclusión. |
Respuestas
Nombre | Tipo | Description |
---|---|---|
200 OK |
Éxito |
Ejemplos
Opt Check
Solicitud de ejemplo
POST {endpoint}/sms/optouts:check?api-version=2025-05-29-preview
{
"from": "+18001234567",
"recipients": [
{
"to": "+15555555551"
},
{
"to": "+15555555552"
},
{
"to": "+123"
},
{
"to": "+15555555553"
}
]
}
Respuesta de muestra
{
"value": [
{
"to": "+15555555551",
"isOptedOut": true,
"httpStatusCode": 200
},
{
"to": "+15555555552",
"isOptedOut": false,
"httpStatusCode": 200
},
{
"to": "+123",
"httpStatusCode": 400,
"errorMessage": "Invalid recipient phone number format"
},
{
"to": "+15555555553",
"httpStatusCode": 500,
"errorMessage": "Internal Server Error"
}
]
}
Definiciones
Nombre | Description |
---|---|
Opt |
Un único número de destinatario de exclusión. |
Opt |
Una solicitud de exclusión. |
Opt |
Respuesta para una solicitud de exclusión. Valide los elementos devueltos en la respuesta para ver qué destinatarios se agregaron o quitaron correctamente de la lista de exclusión. |
Opt |
OptOutRecipient
Un único número de destinatario de exclusión.
Nombre | Tipo | Description |
---|---|---|
to |
string minLength: 1 |
Número de teléfono del destinatario (en formato E.164). |
OptOutRequest
Una solicitud de exclusión.
Nombre | Tipo | Description |
---|---|---|
from |
string minLength: 1 |
Identificador del remitente (normalmente número de teléfono en formato E.164) que es propiedad de la cuenta autenticada. |
recipients |
Un único número de destinatario de exclusión. |
OptOutResponse
Respuesta para una solicitud de exclusión. Valide los elementos devueltos en la respuesta para ver qué destinatarios se agregaron o quitaron correctamente de la lista de exclusión.
Nombre | Tipo | Description |
---|---|---|
value |
OptOutResponseItem
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 optó por no recibir mensajes |
to |
string minLength: 1 |
Número de teléfono del destinatario (en formato E.164). |