Email - Get Send Status

Obtém o estado de uma mensagem enviada anteriormente.

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

Parâmetros do URI

Name In Required Type Description
endpoint
path True
  • string

O recurso de comunicação, por exemplo https://my-resource.communication.azure.com

messageId
path True
  • string

Id de mensagem gerada pelo sistema (GUID) devolvido de uma chamada anterior para enviar e-mail

api-version
query True
  • string

Versão da API para invocar.

Cabeçalho do Pedido

Name Required Type Description
Authorization True
  • string

Uma cadeia de autenticação contendo uma assinatura gerada através do esquema HMAC-SHA256.

Respostas

Name Type Description
200 OK

O estado da mensagem foi recuperado com sucesso.

Headers

  • Retry-After: integer
Other Status Codes

Erro

Headers

  • x-ms-error-code: string

Segurança

Authorization

Uma cadeia de autenticação contendo uma assinatura gerada através do esquema HMAC-SHA256.

Type: apiKey
In: header

Exemplos

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

Definições

CommunicationError

O erro dos Serviços de Comunicação.

CommunicationErrorResponse

O erro dos Serviços de Comunicação.

SendStatus

O tipo que indica o estado de um pedido.

SendStatusResult

Estado de uma mensagem de e-mail enviada anteriormente.

CommunicationError

O erro dos Serviços de Comunicação.

Name Type Description
code
  • string

O código de erro.

details

Mais detalhes sobre erros específicos que levaram a este erro.

innererror

O erro interno, se houver.

message
  • string

A mensagem de erro.

target
  • string

O alvo do erro.

CommunicationErrorResponse

O erro dos Serviços de Comunicação.

Name Type Description
error

O erro dos Serviços de Comunicação.

SendStatus

O tipo que indica o estado de um pedido.

Name Type Description
dropped
  • string

A mensagem não pôde ser processada e foi retirada.

outForDelivery
  • string

A mensagem foi processada e está agora fora para entrega.

queued
  • string

A mensagem passou validações básicas e foi processada para ser processada mais aprofundadamente.

SendStatusResult

Estado de uma mensagem de e-mail enviada anteriormente.

Name Type Description
messageId
  • string

O sistema gerou identificação de uma mensagem de e-mail enviada.

status

O tipo que indica o estado de um pedido.