Ottenere i dati di telemetria di notifica messaggio

  • Articolo

 

Questa API fornisce ulteriori dati di telemetria per gli stati finiti delle notifiche push in uscita. È progettato per le notifiche push monitoraggio inviate da un hub. L'ID di notifica può essere recuperato dall'intestazione del percorso HTTP nella risposta a qualsiasi richiesta di invio.

Richiesta

Metodo

URI della richiesta

Versione HTTP

GET

id del messaggio https://{Namespace}.ServiceBus.Windows.NET/{NotificationHub}/Messages/{Notification}? api-version = 2015-04

HTTP/1.1

Intestazioni della richiesta

Nella seguente tabella vengono descritte le intestazioni di richiesta obbligatorie e facoltative.

Intestazione della richiesta

Descrizione

Autorizzazione

Token generato come specificato nell'autenticazione della firma di accesso condiviso con Bus di servizio oppure nell'autenticazione e nell'autorizzazione di Bus di servizio con Microsoft Azure Active Directory Access Control (anche noto come Servizio di controllo di accesso o ACS).

x-ms-version

2015-04 (supportato da 2015-01 o versione successiva)

Corpo della richiesta

Nessuna.

Risposta

Nella risposta sono inclusi un codice di stato HTTP e un set di intestazioni per la risposta. Corpo della risposta viene restituito in caso di riuscita.

Codici di risposta

Codice

Descrizione

200

I dati di telemetria di messaggio è stato recuperato correttamente. I dati di telemetria possono essere una risposta parziale, a seconda del numero di dispositivi di destinazione del messaggio di notifica che è stato inviato.

400

Impossibile recuperare i dati di telemetria di messaggio perché la richiesta non è corretto.

401

Errore di autorizzazione. Chiave di accesso non corretta.

403

Richiesta rifiutata perché questa funzionalità non è abilitata per il SKU. Eseguire l'aggiornamento a Standard.

404

I dati di telemetria non esiste. È possibile perché l'ID della notifica non è valido o perché il messaggio non è avanzato fino in elaborazione. Se si riceve un codice 404, attendere e riprovare dopo 10 secondi. Questo stato può continuare fino a 30 minuti.

Per informazioni sui codici di stato, vedere Codici ed errori di stato.

Intestazioni della risposta

Intestazione della risposta

Descrizione

Content-type

applicazione/xml; charset = utf-8

Corpo della risposta

Il corpo della risposta sarà un NotificationDetails documento costituito dagli elementi seguenti.

Elemento

Descrizione

ID

L'ID passato per la richiesta che identifica il messaggio di notifica.

Location

URI per il messaggio

State

Indica lo stato di avanzamento di messaggio. Lo stato può essere uno dei valori seguenti:

  • Accodati: Messaggio è stato accettato ma l'elaborazione non è ancora iniziato.

  • Elaborazione: Si è iniziata l'elaborazione dei messaggi.

  • Completato: È stata completata l'elaborazione dei messaggi.

  •  Abbandonata: L'elaborazione dei messaggi è stata abbandonata. Ciò si verifica quando
    non è stato possibile elaborare il messaggio nell'intervallo di tempo accettabile.
    Per impostazione predefinita, questo è 30 minuti.

  • Sconosciuto: L'elaborazione dei messaggi è in uno stato sconosciuto.

EnqueueTime

Indica il tempo che il messaggio è stato accettato.

StartTime

Indica quando il servizio di hub di notifica iniziato a lavorare sulla notifica.

EndTime

Indica quando il servizio di hub di notifica ha terminato di lavoro per la notifica.

NotificationBody

Corpo del messaggio di notifica originale.

TargetPlatforms

Indica quali piattaforme di destinazione della notifica. Può contenere
stringa delimitata dai valori seguenti come una virgola:

  • Windows

  • Apple

  • GCM

  • windowsphone

  • adm

  • baidu

  • template

  • windowstemplate

  • appletemplate

  • gcmtemplate

  • windowsphonetemplate

  • admtemplate

  • baidutemplate

ApnsOutcomeCounts

Questo elemento sono presente per le notifiche inviate al servizio di notifica Push di Apple.
Contiene una raccolta di istanze del risultato.

MpnsOutcomeCounts

Questo elemento sono presente per le notifiche inviate al servizio di notifica Push Microsoft.
Contiene una raccolta di istanze del risultato.

WnsOutcomeCounts

Questo elemento sono presente per le notifiche inviate al servizio di notifica di Windows.
Contiene una raccolta di istanze del risultato.

GcmOutcomeCounts

Questo elemento sono presente per le notifiche inviate a Google Cloud Messaging.
Contiene una raccolta di istanze del risultato.

AdmOutcomeCounts

Questo elemento sono presente per le notifiche inviate all'Amazon Device Messaging.
Contiene una raccolta di istanze del risultato.

Risultato

Una raccolta di queste istanze costituiscono i conteggi sopra per ogni servizio di notifica della piattaforma. Ogni risultato può essere uno dei seguenti denominati conteggi.

Nome

Descrizione di conteggio

AbandonedNotificationMessages

Numero di inviare richieste per effettuare il push del servizio che sono stati eliminati a causa di un timeout.

BadChannel

Comunicazione con il servizio push non riuscita perché il canale non valido.

ChannelDisconnected

Servizio disconnesso push.

ChannelThrottled

Servizio negato l'accesso a causa di limitazione delle richieste di push.

Eliminato

Servizio di push indica che il messaggio è stato eliminato.

ExpiredChannel

Comunicazione con il servizio push non riuscita perché il canale scaduto.

InvalidCredentials

Credenziali utilizzate per autenticare il servizio push non riuscito.

InvalidNotificationFormat

Richiesta di push è stato formattato in modo non corretto per il servizio di push.

InvalidNotificationSize

Richiesta di push è troppo grande.

NoTargets

Numero di richieste trovato nulla da inviare.

PnsInterfaceError

Push comunicazione contratto di servizio non è riuscita.

PnsServerError

Servizio di push indicato che si è verificato un errore sul relativo lato.

PnsUnavailable

Servizio di push non è disponibile.

PnsUnreachable

Servizio di push è stato non risponda.

Ignorato

Numero di registrazioni duplicate (ID di registrazione trovato, diversi di handle PNS stesso).

Success

Inviata la richiesta a un certo numero di dispositivi.

Limitato

Servizio negato l'accesso a causa di limitazione delle richieste di push.

UnknownError

Si è verificato un errore sconosciuto.

WrongToken

L'handle PNS non è stato riconosciuto dal PNS come un handle valido.

Di seguito è telemetria di esempio da inviare una notifica a WNS.

<NotificationDetails xmlns="https://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>&lt;?xml version="1.0" encoding="utf-16"?&gt;&lt;toast&gt;&lt;visual&gt;&lt;binding template="ToastText01"&gt;&lt;text id="1"&gt;Hello from a .NET App!&lt;/text&gt;&lt;/binding&gt;&lt;/visual&gt;&lt;/toast&gt;</NotificationBody> <TargetPlatforms>windows</TargetPlatforms> <WnsOutcomeCounts> <Outcome> <Name>Success</Name> <Count>3</Count> </Outcome> <Outcome> <Name>WrongToken</Name> <Count>1</Count> </Outcome> </WnsOutcomeCounts> </NotificationDetails>

Vedere anche

Inviare una notifica nativa di GCM
Inviare una notifica modello
Inviare una notifica nativa di WNS
Inviare una notifica nativa di APNS
Inviare una notifica nativa di MPNS