Email - Get Send Status

Mendapatkan status pesan yang dikirim sebelumnya.

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

Parameter URI

Name In Required Type Description
endpoint
path True
  • string

Sumber daya komunikasi, misalnya https://my-resource.communication.azure.com

messageId
path True
  • string

Id pesan yang dihasilkan sistem (GUID) dikembalikan dari panggilan sebelumnya untuk mengirim email

api-version
query True
  • string

Versi API yang akan dipanggil.

Header Permintaan

Name Required Type Description
Authorization True
  • string

String autentikasi yang berisi tanda tangan yang dihasilkan menggunakan skema HMAC-SHA256.

Respons

Name Type Description
200 OK

Status pesan berhasil diambil.

Headers

  • Retry-After: integer
Other Status Codes

Kesalahan

Headers

  • x-ms-error-code: string

Keamanan

Authorization

String autentikasi yang berisi tanda tangan yang dihasilkan menggunakan skema HMAC-SHA256.

Type: apiKey
In: header

Contoh

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

Definisi

CommunicationError

Kesalahan Communication Services.

CommunicationErrorResponse

Kesalahan Communication Services.

SendStatus

Jenis yang menunjukkan status permintaan.

SendStatusResult

Status pesan email yang dikirim sebelumnya.

CommunicationError

Kesalahan Communication Services.

Name Type Description
code
  • string

Kode kesalahan.

details

Detail lebih lanjut tentang kesalahan tertentu yang menyebabkan kesalahan ini.

innererror

Kesalahan dalam jika ada.

message
  • string

Pesan kesalahan.

target
  • string

Target kesalahan.

CommunicationErrorResponse

Kesalahan Communication Services.

Name Type Description
error

Kesalahan Communication Services.

SendStatus

Jenis yang menunjukkan status permintaan.

Name Type Description
dropped
  • string

Pesan tidak dapat diproses dan dihilangkan.

outForDelivery
  • string

Pesan telah diproses dan sekarang keluar untuk pengiriman.

queued
  • string

Pesan telah melewati validasi dasar dan telah diantrekan untuk diproses lebih lanjut.

SendStatusResult

Status pesan email yang dikirim sebelumnya.

Name Type Description
messageId
  • string

Id yang dihasilkan sistem dari pesan email yang dikirim.

status

Jenis yang menunjukkan status permintaan.