Értesítési üzenet telemetriájának lekérése
Ez az API további telemetriaadatokat biztosít a kimenő leküldéses értesítések kész állapotáról. Úgy tervezték, hogy segítsen monitorozni a központról küldött leküldéses értesítéseket. Az API által használt értesítési azonosító lekérhető az értesítés küldéséhez használt REST API válaszában szereplő HTTP-hely fejlécből.
Ez az üzenetenkénti telemetriai funkció ütemezett értesítésekhez is elérhető.
Ez az API csak standard szintű értesítési központokhoz érhető el.
Kérés
Metódus | Kérés URI-ja | HTTP-verzió |
---|---|---|
GET | https://{namespace}.servicebus.windows.net/{NotificationHub}/messages/{notification message ID}?api-version=2016-07 |
HTTP/1.1 |
Kérésfejlécek
Az alábbi táblázat a szükséges és nem kötelező kérelemfejléceket ismerteti.
Kérelem fejléce | Leírás |
---|---|
Engedélyezés | A Service Bus használatával történő közös hozzáférésű aláírás-hitelesítésben megadott módon létrehozott SAS-jogkivonat. |
x-ms-version | 2016-07 (2015-01-ig vagy újabb verzióig támogatott) |
A kérés törzse
Nincsenek.
Reagálás
A válasz tartalmaz egy HTTP-állapotkódot és egy válaszfejléceket. A válasz törzse sikeres lesz.
Válaszkódok
Code | Description |
---|---|
200 | Az üzenet telemetriai adatainak lekérése sikerült. A telemetriai adatok részleges válaszként jelenhetnek meg attól függően, hogy hány eszközt céloz meg az elküldött értesítés, és hogy az üzenet milyen mértékben halad a rendszerünkben feldolgozás céljából. |
400 | Az üzenettelemetria nem kérhető le, mert a kérés helytelenül lett formázva. |
401 | Engedélyezési hiba. A hozzáférési kulcs helytelen volt. |
403 | A kérelem elutasítva, mert ez a funkció nincs engedélyezve az SKU-hoz. Frissítsen Standard verzióra. |
404 | A telemetria nem létezik. Ez a hiba akkor fordulhat elő, ha az értesítési azonosító érvénytelen. |
Az állapotkódokkal kapcsolatos információkért lásd: Állapot- és hibakódok.
Válaszfejlécek
Válaszfejléc | Description |
---|---|
Tartalomtípus | application/xml; charset=utf-8 |
Választörzs
A válasz törzse egy NotificationDetails dokumentum, amely a következő elemekből áll:
Elem | Leírás |
---|---|
NotificationId | Az értesítési üzenetet azonosító kérésnek átadott azonosító. |
Hely | Az üzenet URI-ja |
Állapot | Az üzenet állapotát jelzi. Az állapot a következő értékek egyike lehet:
|
EnqueueTime | Azt jelzi, hogy mikor fogadták el az üzenetet. |
StartTime | Azt jelzi, hogy az értesítési központ szolgáltatás mikor kezdett dolgozni az értesítésen. |
EndTime | Azt jelzi, hogy mikor fejeződött be az értesítési központ szolgáltatása az értesítésen. |
NotificationBody | Az eredeti értesítési üzenet törzse. |
TargetPlatforms | Azt jelzi, hogy mely platformokon jelennek meg az értesítési célok. A következő értékeket tartalmazhatja vesszővel tagolt sztringként:
|
ApnsOutcomeCounts | Ez az elem jelen van az Apple Push Notification Service-nek küldött értesítéseknél. Eredménypéldányok gyűjteményét tartalmazza. |
MpnsOutcomeCounts | Ez az elem jelen van a Microsoft Push Notification Service-nek küldött értesítéseknél. Eredménypéldányok gyűjteményét tartalmazza. |
WnsOutcomeCounts | Ez az elem jelen van a Windows értesítési szolgáltatásnak küldött értesítéseknél. Eredménypéldányok gyűjteményét tartalmazza. |
GcmOutcomeCounts | Ez az elem jelen van a Google Cloud Messagingnek küldött értesítéseknél. Eredménypéldányok gyűjteményét tartalmazza. |
AdmOutcomeCounts | Ez az elem jelen van az Amazon Device Messaging szolgáltatásnak küldött értesítések esetében. Eredménypéldányok gyűjteményét tartalmazza. |
Eredmény | Ezeknek a példányoknak a gyűjteménye alkotja a fenti számokat az egyes platformértesítési szolgáltatásokhoz. Minden eredmény az Eredmények szakaszban említett névvel ellátott számok egyike lehet. |
PnsErrorDetailsUri | Ehhez az API-hoz és az értesítési üzenetet küldő API-hoz Api-Version 2016-07-Api-Version kell használni. A PNS-hiba részletei csak a társított küldési művelet befejezése után érhetők el teljes mértékben. Lekéri az URI-t egy olyan blobhoz, amely az egyes érintett PNS által visszaadott hibákat tartalmazza. Ha egy PNS nem jelentett hibát, ez a tag nem szerepel a válaszban. A blob olvasásához használhatja az Azure Storage API-t. További információkért lásd: Ismerkedés az Azure Blob Storage .NET-tel vagy az Azure Storage Services REST API-val – Referencia A PNS lehetséges hibái a következők:
|
Eredmények
Name | Darabszám leírása |
---|---|
AbandonedNotificationMessages | Az időtúllépés miatt elvetett leküldéses szolgáltatásnak küldött kérések száma. |
BadChannel | A leküldéses szolgáltatással való kommunikáció nem sikerült, mert a csatorna érvénytelen volt. |
ChannelDisconnected | A leküldési szolgáltatás megszakadt. |
ChannelThrottled | A leküldéses szolgáltatás szabályozás miatt megtagadta a hozzáférést. |
Csökkent | A leküldéses szolgáltatás azt jelzi, hogy az üzenet el lett dobva. |
ExpiredChannel | A leküldéses szolgáltatással való kommunikáció meghiúsult, mert a csatorna lejárt. |
Érvénytelen hitelesítő adatok | A leküldéses szolgáltatásban való hitelesítéshez használt hitelesítő adatok sikertelenek. |
InvalidNotificationSize | A leküldéses kérelem túl nagy. |
NoTargets | Azoknak a kéréseknek a száma, amelyekhez nem érkezett elküldhető üzenet. |
PnsInterfaceError | A leküldéses szolgáltatási szerződés kommunikációja nem sikerült. |
PnsServerError | A leküldéses szolgáltatás azt jelezte, hogy hiba történt az oldalukon. |
PnsUnavailable | A leküldéses szolgáltatás nem érhető el. |
PnsUnreachable | A leküldéses szolgáltatás nem válaszolt. |
Kihagyva | Duplikált regisztrációk száma (ugyanaz a PNS-leíró található, különböző regisztrációs azonosító). |
Siker | Sikerült elküldeni a kérést néhány eszköznek. |
Gázadagoló | A leküldéses szolgáltatás szabályozás miatt megtagadta a hozzáférést. |
UnknownError | Ismeretlen hiba történt. |
WrongToken | A PNS-leírót a PNS nem ismerte fel érvényes leíróként. |
Íme egy példa telemetria a WNS-nek küldött értesítésből:
<NotificationDetails xmlns="http://schemas.microsoft.com/netservices/2010/10/servicebus/connect" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<NotificationId>{Your message id}</NotificationId>
<Location>sb://{Your namespace}.servicebus.windows.net/{your hub name}/messages/{your message id}?api-version=2015-04</Location>
<State>Completed</State>
<EnqueueTime>2015-11-02T21:19:43Z</EnqueueTime>
<StartTime>2015-11-02T21:19:43.9926996Z</StartTime>
<EndTime>2015-11-02T21:19:43.9926996Z</EndTime>
<NotificationBody><?xml version="1.0" encoding="utf-16"?><toast><visual><binding template="ToastText01"><text id="1">Hello from a .NET App!</text></binding></visual></toast></NotificationBody>
<TargetPlatforms>windows</TargetPlatforms>
<WnsOutcomeCounts>
<Outcome>
<Name>Success</Name>
<Count>3</Count>
</Outcome>
<Outcome>
<Name>WrongToken</Name>
<Count>1</Count>
</Outcome>
</WnsOutcomeCounts>
<PnsErrorDetailsUri>{Blob uri}</PnsErrorDetailsUri>
</NotificationDetails>
Lásd még:
Sablonértesítés küldése
APNS natív értesítés küldése
Natív GCM-értesítés küldése
MPNS-natív értesítés küldése
Natív WNS-értesítés küldése