Een registratie maken
Hiermee maakt u een nieuwe registratie. Met deze methode wordt een registratie-id gegenereerd, die u vervolgens kunt gebruiken om deze registratie op te halen, bij te werken en te verwijderen.
Aanvraag
Methode | Aanvraag-URI | HTTP-versie |
---|---|---|
POST | https://{namespace}.servicebus.windows.net/{NotificationHub}/registrations/?api-version=2015-01 |
HTTP/1.1 |
Aanvraagheaders
In de volgende tabel worden vereiste en optionele aanvraagheaders beschreven.
Aanvraagheader | Beschrijving |
---|---|
Content-Type | application/atom+xml;type=entry;charset=utf-8 |
Autorisatie | SAS-token gegenereerd zoals opgegeven in Shared Access Signature Authentication met Service Bus. |
x-ms-version | 2015-01 |
Aanvraagbody
Atom-vermelding met de beschrijving die is ingesloten in de inhoud. Hier volgen enkele voorbeelden.
Systeemeigen registratie voor Windows Notification Service:
<?xml version="1.0" encoding="utf-8"?>
<entry xmlns="http://www.w3.org/2005/Atom">
<content type="application/xml">
<WindowsRegistrationDescription xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.microsoft.com/netservices/2010/10/servicebus/connect">
<Tags>myTag, myOtherTag</Tags>
<ChannelUri>{ChannelUri}</ChannelUri>
</WindowsRegistrationDescription>
</content>
</entry>
Notitie
Het element Tags is optioneel.
Sjabloonregistratie voor Windows Notification Service:
<?xml version="1.0" encoding="utf-8"?>
<entry xmlns="http://www.w3.org/2005/Atom">
<content type="application/xml">
<WindowsTemplateRegistrationDescription xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.microsoft.com/netservices/2010/10/servicebus/connect">
<Tags>myTag, myOtherTag</Tags>
<ChannelUri>{ChannelUri}</ChannelUri>
<BodyTemplate><![CDATA[{Template for the body}]]></BodyTemplate>
<WnsHeaders>
<WnsHeader>
<Header>X-WNS-Type</Header>
<Value>wns/tile</Value>
</WnsHeader>
<WnsHeader>
<Header>X-WNS-Tag</Header>
<Value>myTag</Value>
</WnsHeader>
</WnsHeaders>
</WindowsTemplateRegistrationDescription>
</content>
</entry>
Notitie
Het element BodyTemplate is verplicht, net als de X-WNS-Type-header.
Systeemeigen registratie voor Apple Push Notification Service:
<?xml version="1.0" encoding="utf-8"?>
<entry xmlns="http://www.w3.org/2005/Atom">
<content type="application/xml">
<AppleRegistrationDescription xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.microsoft.com/netservices/2010/10/servicebus/connect">
<Tags>myTag, myOtherTag</Tags>
<DeviceToken>{DeviceToken}</DeviceToken>
</AppleRegistrationDescription>
</content>
</entry>
Notitie
Het element Tags is optioneel.
Sjabloonregistratie voor Apple Push Notification Service:
<?xml version="1.0" encoding="utf-8"?>
<entry xmlns="http://www.w3.org/2005/Atom">
<content type="application/xml">
<AppleTemplateRegistrationDescription xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.microsoft.com/netservices/2010/10/servicebus/connect">
<Tags>myTag, myOtherTag</Tags>
<DeviceToken>{DeviceToken}</DeviceToken>
<BodyTemplate><![CDATA[{Template for the body}]]></BodyTemplate>
<Expiry>{Template for Expiry in }</Expiry>
</AppleTemplateRegistrationDescription>
</content>
</entry>
Notitie
Het element BodyTemplate is verplicht. Verloop is optioneel.
Systeemeigen registratie voor Firebase Cloud Messaging:
// FcmV1Registration
<?xml version="1.0" encoding="utf-8"?>
<entry xmlns="http://www.w3.org/2005/Atom">
<content type="application/xml">
<FcmV1RegistrationDescription xmlns:i="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://schemas.microsoft.com/netservices/2010/10/servicebus/connect">
<Tags>myTag, myOtherTag</Tags>
<FcmV1RegistrationId>{deviceToken}</FcmV1RegistrationId>
</FcmV1RegistrationDescription>
</content>
</entry>
Systeemeigen registratie voor Google Cloud Messaging:
<?xml version="1.0" encoding="utf-8"?>
<entry xmlns="http://www.w3.org/2005/Atom">
<content type="application/xml">
<GcmRegistrationDescription xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.microsoft.com/netservices/2010/10/servicebus/connect">
<Tags>myTag, myOtherTag</Tags>
<GcmRegistrationId>{GCM Registration Id}</GcmRegistrationId>
</GcmRegistrationDescription>
</content>
</entry>
Notitie
Het element Tags is optioneel.
Sjabloonregistratie voor Firebase Cloud Messaging:
// FcmV1TemplateRegistration
<?xml version="1.0" encoding="utf-8"?>
<entry xmlns="http://www.w3.org/2005/Atom">
<content type="application/xml">
<FcmV1TemplateRegistrationDescription xmlns:i="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://schemas.microsoft.com/netservices/2010/10/servicebus/connect">
<Tags>myTag, myOtherTag</Tags>
<FcmV1RegistrationId>{deviceToken}</FcmV1RegistrationId>
<BodyTemplate><![CDATA[ {BodyTemplate}]]></BodyTemplate>
</FcmV1TemplateRegistrationDescription>
</content>
</entry>
Sjabloonregistratie voor Google Cloud Messaging:
<?xml version="1.0" encoding="utf-8"?>
<entry xmlns="http://www.w3.org/2005/Atom">
<content type="application/xml">
<GcmTemplateRegistrationDescription xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.microsoft.com/netservices/2010/10/servicebus/connect">
<Tags>myTag, myOtherTag</Tags>
<GcmRegistrationId>{GCM Registration Id}</GcmRegistrationId>
<BodyTemplate><![CDATA[ {BodyTemplate}]]></BodyTemplate>
</GcmTemplateRegistrationDescription>
</content>
</entry>
Notitie
Het element BodyTemplate is verplicht.
Systeemeigen registratie voor Microsoft Push Notification Service:
<?xml version="1.0" encoding="utf-8"?>
<entry xmlns="http://www.w3.org/2005/Atom">
<content type="application/xml">
<MpnsRegistrationDescription xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.microsoft.com/netservices/2010/10/servicebus/connect">
<Tags>myTag, myOtherTag</Tags>
<ChannelUri>{ChannelUri}</ChannelUri>
</MpnsRegistrationDescription>
</content>
</entry>
Notitie
Het element Tags is optioneel.
Sjabloonregistratie voor Microsoft Push Notification Service:
<?xml version="1.0" encoding="utf-8"?>
<entry xmlns="http://www.w3.org/2005/Atom">
<content type="application/xml">
<MpnsTemplateRegistrationDescription xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.microsoft.com/netservices/2010/10/servicebus/connect">
<Tags>myTag, myOtherTag</Tags>
<ChannelUri>{ChannelUri}</ChannelUri>
<BodyTemplate><![CDATA[{Template for the body}]]></BodyTemplate>
<MpnsHeaders>
<MpnsHeader>
<Header>X-WindowsPhone-Target</Header>
<Value>toast</Value>
</MpnsHeader>
<MpnsHeader>
<Header>X-NotificationClass</Header>
<Value>[batching interval]</Value>
</MpnsHeader>
</MpnsHeaders>
</MpnsTemplateRegistrationDescription>
</content>
</entry>
Notitie
Het element BodyTemplate is verplicht, net als de X-WindowsPhone-Target-header.
Antwoord
Het antwoord bevat een HTTP-statuscode en een set antwoordheaders.
Antwoordcodes
Code | Description |
---|---|
201 | De registratie is gemaakt. |
400 | Ongeldige aanvraagbody. De registratie kan niet worden gemaakt omdat de aanvraag onjuist is ingedeeld. |
401 | Autorisatiefout. De toegangssleutel is onjuist. |
403 | Quotum overschreden; te veel registraties in deze naamruimte. De registratie is niet gemaakt. |
403 | Aanvraag geweigerd omdat het aantal registratiebewerkingen te hoog is. |
Zie Status- en foutcodes voor meer informatie over statuscodes.
Antwoordheaders
Antwoordheader | Description |
---|---|
Inhoudstype | application/atom+xml;type=entry;charset=utf-8 |
ETag | {zwakke ETag} |
Hoofdtekst van de reactie
Als dit is gelukt, wordt een gevalideerde Atom-vermelding geretourneerd. Het bevat alleen-lezen elementen zoals ETag, RegistrationId en ExpirationTime. Bijvoorbeeld:
<entry>
<id>https://{tenant}.servicebus.windows.net/{NotificationHub}/registrations/{registrationId}</id>
<title type="text"> /{NotificationHub}/registrations/{registrationId}</title>
<updated>2012-08-17T17:32:00Z</updated>
<metadata:etag>{weak Etag}</metadata:etag>
<content type="application/xml">
<WindowsRegistrationDescription xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.microsoft.com/netservices/2010/10/servicebus/connect">
<ETag>{ETag}</ETag>
<ExpirationTime>2012-07-16T19:20+01:00</ExpirationTime>
<RegistrationId>{RegistrationId}</RegistrationId>
<Tags>myTag, myOtherTag</Tags>
<ChannelUri>{ChannelUri}</ChannelUri>
</WindowsRegistrationDescription>
</content>
</entry>