Delivery Reports - Get

Tjänst:

Communication

API-version:

2026-01-23

Hämtar leveransrapport för ett specifikt utgående meddelande.

GET {endpoint}/deliveryReports/{outgoingMessageId}?api-version=2026-01-23

URI-parametrar

Name	I	Obligatorisk	Typ	Description
endpoint	path	True	string (url)	Kommunikationsresursen, till exempel https://my-resource.communication.azure.com
outgoingMessageId	path	True	string	Identifieraren för det utgående meddelandet.
api-version	query	True	string	Version av API som ska anropas.

Svar

Name	Typ	Description
200 OK	DeliveryReport	Success
404 Not Found	ErrorResponse	Hittades inte - Det gick inte att hitta leveransrapporten för det här meddelandet

Exempel

GetDeliveryReport

Exempelbegäran

HTTP

GET {endpoint}/deliveryReports/abc123-message-id?api-version=2026-01-23

Exempelsvar

Statuskod:

200

{
  "deliveryStatus": "Delivered",
  "deliveryStatusDetails": "2000: No Error",
  "deliveryAttempts": [
    {
      "timestamp": "2025-08-12T14:40:00Z",
      "segmentsSucceeded": 2,
      "segmentsFailed": 0
    },
    {
      "timestamp": "2025-08-12T14:35:00Z",
      "segmentsSucceeded": 1,
      "segmentsFailed": 1
    }
  ],
  "receivedTimestamp": "2025-08-12T14:40:00Z",
  "tag": "customer-tag",
  "messageId": "abc123-message-id",
  "from": "+1234567890",
  "to": "+0987654321"
}

Statuskod:

404

{
  "type": "https://tools.ietf.org/html/rfc9110#section-15.5.5",
  "title": "Not Found",
  "status": 404,
  "traceId": "00-2af30328cf055ed1e74ed7c8004cafd2-450fe826b51b7bfe-00"
}

Definitioner

Name	Description
DeliveryAttempt	Uppgifter om ett leveransförsök.
DeliveryReport	Leveransrapport för ett utgående SMS-meddelande.
ErrorResponse	Felsvar för misslyckade begäranden.

DeliveryAttempt

Objekt

Uppgifter om ett leveransförsök.

Name	Typ	Description
segmentsFailed	integer (int32) minimum: 0	Antal meddelandesegment som inte kunde levereras.
segmentsSucceeded	integer (int32) minimum: 0	Antal meddelandesegment som har levererats.
timestamp	string (date-time)	Tidsstämpeln för leveransförsöket.

DeliveryReport

Objekt

Leveransrapport för ett utgående SMS-meddelande.

Name	Typ	Description
deliveryAttempts	DeliveryAttempt[]	Matris med leveransförsök som gjorts för det här meddelandet.
deliveryStatus	enum: Delivered Failed	Meddelandets leveransstatus.
deliveryStatusDetails	string	Detaljerad information om leveransstatus.
from	string	Avsändarens telefonnummer i E.164-format.
messageId	string	Identifieraren för det utgående meddelandet.
messagingConnectPartnerMessageId	string	Meddelande-ID som genereras av Messaging Connect Partner. Finns endast för leveransrapporter som skapats under Messaging Connect-flödet.
receivedTimestamp	string (date-time)	Tidsstämpeln när leveransrapporten togs emot.
tag	string	Anpassad tagg som anges när meddelandet skickas.
to	string	Mottagarens telefonnummer i E.164-format.

ErrorResponse

Objekt

Felsvar för misslyckade begäranden.

Name	Typ	Description
status	integer (int32)	HTTP-statuskoden.
title	string	En kort, läsbar sammanfattning av problemtypen.
traceId	string	Spårningsidentifieraren för begäran.
type	string	En URI-referens som identifierar problemtypen.