Email - Get Send Status

Obtient l’état d’un message envoyé précédemment.

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

Paramètres URI

Name In Required Type Description
endpoint
path True
  • string

Ressource de communication, par exemple https://my-resource.communication.azure.com

messageId
path True
  • string

ID de message généré par le système retourné à partir d’un appel précédent pour envoyer un e-mail

api-version
query True
  • string

Version de l’API à appeler.

En-tête de la demande

Name Required Type Description
Authorization True
  • string

Chaîne d’authentification contenant une signature générée à l’aide du schéma HMAC-SHA256.

Réponses

Name Type Description
200 OK

L’état du message a été récupéré avec succès.

Headers

  • Retry-After: integer
Other Status Codes

Erreur

Headers

  • x-ms-error-code: string

Sécurité

Authorization

Chaîne d’authentification contenant une signature générée à l’aide du schéma HMAC-SHA256.

Type: apiKey
In: header

Exemples

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

Définitions

CommunicationError

Erreur Communication Services.

CommunicationErrorResponse

Erreur Communication Services.

SendStatus

Type indiquant l’état d’une requête.

SendStatusResult

État d’un message électronique qui a été envoyé précédemment.

CommunicationError

Erreur Communication Services.

Name Type Description
code
  • string

Code d'erreur.

details

Plus d’informations sur les erreurs spécifiques qui ont conduit à cette erreur.

innererror

Erreur interne le cas échéant.

message
  • string

Message d’erreur.

target
  • string

Cible d’erreur.

CommunicationErrorResponse

Erreur Communication Services.

Name Type Description
error

Erreur Communication Services.

SendStatus

Type indiquant l’état d’une requête.

Name Type Description
dropped
  • string

Le message n’a pas pu être traité et a été supprimé.

outForDelivery
  • string

Le message a été traité et est maintenant en attente de remise.

queued
  • string

Le message a passé des validations de base et a été mis en file d’attente pour être traité plus loin.

SendStatusResult

État d’un message électronique qui a été envoyé précédemment.

Name Type Description
messageId
  • string

ID généré par le système d’un message électronique envoyé.

status

Type indiquant l’état d’une requête.