Email - Get Send Status

Pobiera stan wysłanej wcześniej wiadomości.

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

Parametry identyfikatora URI

Name In Required Type Description
endpoint
path True
  • string

Zasób komunikacji, na przykład https://my-resource.communication.azure.com

messageId
path True
  • string

Identyfikator komunikatu wygenerowanego przez system (GUID) zwrócony z poprzedniego wywołania w celu wysłania wiadomości e-mail

api-version
query True
  • string

Wersja interfejsu API do wywołania.

Nagłówek żądania

Name Required Type Description
Authorization True
  • string

Ciąg uwierzytelniania zawierający podpis wygenerowany przy użyciu schematu HMAC-SHA256.

Odpowiedzi

Name Type Description
200 OK

Stan komunikatu został pomyślnie pobrany.

Headers

  • Retry-After: integer
Other Status Codes

Błąd

Headers

  • x-ms-error-code: string

Zabezpieczenia

Authorization

Ciąg uwierzytelniania zawierający podpis wygenerowany przy użyciu schematu HMAC-SHA256.

Type: apiKey
In: header

Przykłady

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

Definicje

CommunicationError

Błąd usług komunikacyjnych.

CommunicationErrorResponse

Błąd usług komunikacyjnych.

SendStatus

Typ wskazujący stan żądania.

SendStatusResult

Stan wysłanej wcześniej wiadomości e-mail.

CommunicationError

Błąd usług komunikacyjnych.

Name Type Description
code
  • string

Kod błędu.

details

Dalsze szczegółowe informacje o konkretnych błędach, które doprowadziły do tego błędu.

innererror

Wewnętrzny błąd, jeśli istnieje.

message
  • string

Komunikat o błędzie.

target
  • string

Element docelowy błędu.

CommunicationErrorResponse

Błąd usług komunikacyjnych.

Name Type Description
error

Błąd usług komunikacyjnych.

SendStatus

Typ wskazujący stan żądania.

Name Type Description
dropped
  • string

Nie można przetworzyć komunikatu i został porzucony.

outForDelivery
  • string

Wiadomość została przetworzona i jest teraz dostępna do dostarczenia.

queued
  • string

Komunikat przeszedł podstawowe weryfikacje i został w kolejce do dalszego przetwarzania.

SendStatusResult

Stan wysłanej wcześniej wiadomości e-mail.

Name Type Description
messageId
  • string

System wygenerował identyfikator wysłanej wiadomości e-mail.

status

Typ wskazujący stan żądania.