Email - Get Send Status

Získá stav zprávy odeslané dříve.

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

Parametry identifikátoru URI

Name In Required Type Description
endpoint
path True
  • string

Komunikační prostředek, například https://my-resource.communication.azure.com

messageId
path True
  • string

Id (GUID) generované systémem vrácené z předchozího volání pro odesílání e-mailů

api-version
query True
  • string

Verze rozhraní API pro vyvolání

Hlavička požadavku

Name Required Type Description
Authorization True
  • string

Ověřovací řetězec obsahující podpis vygenerovaný pomocí schématu HMAC-SHA256

Odpovědi

Name Type Description
200 OK

Stav zprávy byl úspěšně načten.

Headers

  • Retry-After: integer
Other Status Codes

Chyba

Headers

  • x-ms-error-code: string

Zabezpečení

Authorization

Ověřovací řetězec obsahující podpis vygenerovaný pomocí schématu HMAC-SHA256

Type: apiKey
In: header

Příklady

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

Definice

CommunicationError

Chyba Komunikační služby.

CommunicationErrorResponse

Chyba Komunikační služby.

SendStatus

Typ označující stav požadavku.

SendStatusResult

Stav e-mailové zprávy, která byla odeslána dříve

CommunicationError

Chyba Komunikační služby.

Name Type Description
code
  • string

Kód chyby

details

Další podrobnosti o konkrétníchchybách

innererror

Vnitřní chyba, pokud existuje.

message
  • string

Chybová zpráva

target
  • string

Cíl chyby.

CommunicationErrorResponse

Chyba Komunikační služby.

Name Type Description
error

Chyba Komunikační služby.

SendStatus

Typ označující stav požadavku.

Name Type Description
dropped
  • string

Zprávu nelze zpracovat a byla ukončena.

outForDelivery
  • string

Zpráva byla zpracována a je nyní k doručení.

queued
  • string

Zpráva prošla základními ověřeními a byla zařazena do fronty pro další zpracování.

SendStatusResult

Stav e-mailové zprávy, která byla odeslána dříve

Name Type Description
messageId
  • string

Systém vygeneroval ID odeslané e-mailové zprávy.

status

Typ označující stav požadavku.