Email - Get Send Status

Obtiene el estado de un mensaje enviado anteriormente.

GET {endpoint}/emails/{messageId}/status?api-version=2021-10-01-preview

Parámetros de identificador URI

Name In Required Type Description
endpoint
path True
  • string

El recurso de comunicación, por ejemplo. https://my-resource.communication.azure.com

messageId
path True
  • string

Identificador de mensaje generado por el sistema (GUID) devuelto desde una llamada anterior para enviar correo electrónico

api-version
query True
  • string

Versión de la API que se va a invocar.

Encabezado de la solicitud

Name Required Type Description
Authorization True
  • string

Cadena de autenticación que contiene una firma generada mediante el esquema HMAC-SHA256.

Respuestas

Name Type Description
200 OK

El estado del mensaje se recuperó correctamente.

Headers

  • Retry-After: integer
Other Status Codes

Error

Headers

  • x-ms-error-code: string

Seguridad

Authorization

Cadena de autenticación que contiene una firma generada mediante el esquema HMAC-SHA256.

Type: apiKey
In: header

Ejemplos

Get Message Status

Sample Request

GET https://contoso.westus.communications.azure.com/emails/F9168C5E-CEB2-4faa-B6BF-329BF39FA1E4/status?api-version=2021-10-01-preview

Sample Response

Retry-After: 100
{
  "messageId": "F9168C5E-CEB2-4faa-B6BF-329BF39FA1E4",
  "status": "queued"
}

Definiciones

CommunicationError

Error de Communication Services.

CommunicationErrorResponse

Error de Communication Services.

SendStatus

Tipo que indica el estado de una solicitud.

SendStatusResult

Estado de un mensaje de correo electrónico que se envió anteriormente.

CommunicationError

Error de Communication Services.

Name Type Description
code
  • string

Código de error.

details

Más detalles sobre los errores específicos que provocaron este error.

innererror

Error interno si existe.

message
  • string

El mensaje de error.

target
  • string

Destino del error.

CommunicationErrorResponse

Error de Communication Services.

Name Type Description
error

Error de Communication Services.

SendStatus

Tipo que indica el estado de una solicitud.

Name Type Description
dropped
  • string

No se pudo procesar el mensaje y se quitó.

outForDelivery
  • string

El mensaje se ha procesado y ahora está fuera de servicio para su entrega.

queued
  • string

El mensaje ha pasado validaciones básicas y se ha puesto en cola para su procesamiento.

SendStatusResult

Estado de un mensaje de correo electrónico que se envió anteriormente.

Name Type Description
messageId
  • string

Identificador generado por el sistema de un mensaje de correo electrónico enviado.

status

Tipo que indica el estado de una solicitud.