Email - Get Send Status

Gets the status of a message sent previously.

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

URI Parameters

Name In Required Type Description
endpoint
path True
  • string

The communication resource, for example https://my-resource.communication.azure.com

messageId
path True
  • string

System generated message id (GUID) returned from a previous call to send email

api-version
query True
  • string

Version of API to invoke.

Request Header

Name Required Type Description
Authorization True
  • string

An authentication string containing a signature generated using HMAC-SHA256 scheme.

Responses

Name Type Description
200 OK

Message status was successfully retrieved.

Headers

  • Retry-After: integer
Other Status Codes

Error

Headers

  • x-ms-error-code: string

Security

Authorization

An authentication string containing a signature generated using HMAC-SHA256 scheme.

Type: apiKey
In: header

Examples

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

Definitions

CommunicationError

The Communication Services error.

CommunicationErrorResponse

The Communication Services error.

SendStatus

The type indicating the status of a request.

SendStatusResult

Status of an email message that was sent previously.

CommunicationError

The Communication Services error.

Name Type Description
code
  • string

The error code.

details

Further details about specific errors that led to this error.

innererror

The inner error if any.

message
  • string

The error message.

target
  • string

The error target.

CommunicationErrorResponse

The Communication Services error.

Name Type Description
error

The Communication Services error.

SendStatus

The type indicating the status of a request.

Name Type Description
dropped
  • string

The message could not be processed and was dropped.

outForDelivery
  • string

The message has been processed and is now out for delivery.

queued
  • string

The message has passed basic validations and has been queued to be processed further.

SendStatusResult

Status of an email message that was sent previously.

Name Type Description
messageId
  • string

System generated id of an email message sent.

status

The type indicating the status of a request.