Email - Get Send Status

Возвращает состояние отправленного ранее сообщения.

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

Параметры URI

Name In Required Type Description
endpoint
path True
  • string

Ресурс связи, например https://my-resource.communication.azure.com

messageId
path True
  • string

Идентификатор созданного системой сообщения (GUID), возвращенный из предыдущего вызова для отправки сообщения электронной почты

api-version
query True
  • string

Версия ВЫЗЫВАемого API.

Заголовок запроса

Name Required Type Description
Authorization True
  • string

Строка проверки подлинности, содержащая подпись, созданную с помощью схемы HMAC-SHA256.

Ответы

Name Type Description
200 OK

Состояние сообщения успешно получено.

Headers

  • Retry-After: integer
Other Status Codes

Error

Headers

  • x-ms-error-code: string

Безопасность

Authorization

Строка проверки подлинности, содержащая подпись, созданную с помощью схемы HMAC-SHA256.

Type: apiKey
In: header

Примеры

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

Определения

CommunicationError

Ошибка Служб коммуникации.

CommunicationErrorResponse

Ошибка Служб коммуникации.

SendStatus

Тип, указывающий состояние запроса.

SendStatusResult

Состояние отправленного ранее сообщения электронной почты.

CommunicationError

Ошибка Служб коммуникации.

Name Type Description
code
  • string

Код ошибки.

details

Дополнительные сведения о конкретных ошибках, которые привели к этой ошибке.

innererror

Внутренняя ошибка, если она есть.

message
  • string

Сообщение об ошибке.

target
  • string

Целевой объект ошибки.

CommunicationErrorResponse

Ошибка Служб коммуникации.

Name Type Description
error

Ошибка Служб коммуникации.

SendStatus

Тип, указывающий состояние запроса.

Name Type Description
dropped
  • string

Сообщение не удалось обработать и удалить.

outForDelivery
  • string

Сообщение обработано и теперь готово к доставке.

queued
  • string

Сообщение прошло основные проверки и было помещено в очередь для дальнейшей обработки.

SendStatusResult

Состояние отправленного ранее сообщения электронной почты.

Name Type Description
messageId
  • string

Системный идентификатор отправленного сообщения электронной почты.

status

Тип, указывающий состояние запроса.