Email - Get Send Status

Service:

Communication

API Version:

2021-10-01-preview

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	SendStatusResult	Message status was successfully retrieved. Headers Retry-After: integer
Other Status Codes	CommunicationErrorResponse	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

HTTP

GET https://contoso.westus.communications.azure.com/emails/F9168C5E-CEB2-4faa-B6BF-329BF39FA1E4/status?api-version=2021-10-01-preview

Sample response

Status code:

200

Retry-After: 100

{
  "messageId": "F9168C5E-CEB2-4faa-B6BF-329BF39FA1E4",
  "status": "queued"
}

Definitions

Name	Description
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

Object

The Communication Services error.

Name	Type	Description
code	string	The error code.
details	CommunicationError[]	Further details about specific errors that led to this error.
innererror	CommunicationError	The inner error if any.
message	string	The error message.
target	string	The error target.

CommunicationErrorResponse

Object

The Communication Services error.

Name	Type	Description
error	CommunicationError	The Communication Services error.

SendStatus

Enumeration

The type indicating the status of a request.

Value	Description
queued	The message has passed basic validations and has been queued to be processed further.
outForDelivery	The message has been processed and is now out for delivery.
dropped	The message could not be processed and was dropped.

SendStatusResult

Object

Status of an email message that was sent previously.

Name	Type	Description
messageId	string	System generated id of an email message sent.
status	SendStatus	The type indicating the status of a request.