Criar registro
Cria um novo registro. Este método gera uma ID de registro, que pode ser usada subsequentemente para recuperar, atualizar e excluir esse registro.
Solicitação
Método | URI de solicitação | Versão de HTTP |
---|---|---|
POST | https://{namespace}.ServiceBus.Windows.NET/{NotificationHub}/Registrations/?API-Version=2015-01 | HTTP/1.1 |
Cabeçalhos de solicitação
A tabela a seguir descreve os cabeçalhos de solicitação obrigatórios e opcionais.
Cabeçalho de solicitação | Descrição |
---|---|
Content-Type | application/atom+xml;type=entry;charset=utf-8 |
Autorização | Token gerado conforme especificado autenticação SAS com Barramento do Serviço, ou Barramento do Serviço autenticação e autorização com Access Control do Active Directory do Microsoft Azure (também conhecido como Access Control Service ou ACS). |
x-ms-version | 2015-01 |
Corpo da solicitação
A entrada do Atom com a descrição inserida no conteúdo. Seguem alguns exemplos.
Registro nativo para o 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="https://schemas.microsoft.com/netservices/2010/10/servicebus/connect"> <Tags>myTag, myOtherTag</Tags> <ChannelUri>{ChannelUri}</ChannelUri> </WindowsRegistrationDescription> </content> </entry>
Dica
O Tags
elemento é opcional.
Registro de modelo para o 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="https://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>
Dica
O BodyTemplate
elemento é obrigatório, como o X-WNS-Type
cabeçalho.
Registro nativo para o Serviço de Notificação de Push da Apple:
<?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="https://schemas.microsoft.com/netservices/2010/10/servicebus/connect"> <Tags>myTag, myOtherTag</Tags> <DeviceToken>{DeviceToken}</DeviceToken> </AppleRegistrationDescription> </content> </entry>
Dica
O Tags
elemento é opcional.
Registro de modelo para o Serviço de Notificação de Push da Apple:
<?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="https://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>
Dica
O BodyTemplate
elemento é obrigatório.Expiry
é opcional.
Registro nativo para Sistema de Mensagens na Nuvem do Google:
<?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="https://schemas.microsoft.com/netservices/2010/10/servicebus/connect"> <Tags>myTag, myOtherTag</Tags> <GcmRegistrationId>{GCM Registration Id}</GcmRegistrationId> </GcmRegistrationDescription> </content> </entry>
Dica
O Tags
elemento é opcional.
Registro de modelo para Sistema de Mensagens na Nuvem do Google:
<?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="https://schemas.microsoft.com/netservices/2010/10/servicebus/connect"> <Tags>myTag, myOtherTag</Tags> <GcmRegistrationId>{GCM Registration Id}</GcmRegistrationId> <BodyTemplate><![CDATA[ {BodyTemplate}]]></BodyTemplate> </GcmTemplateRegistrationDescription> </content> </entry>
Dica
O BodyTemplate
elemento é obrigatório.
Registro nativo para o Serviço de Notificação Push da Microsoft:
<?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="https://schemas.microsoft.com/netservices/2010/10/servicebus/connect"> <Tags>myTag, myOtherTag</Tags> <ChannelUri>{ChannelUri}</ChannelUri> </MpnsRegistrationDescription> </content> </entry>
Dica
O Tags
elemento é opcional.
Registro de modelo para o Serviço de Notificação Push da Microsoft:
<?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="https://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>
Dica
O BodyTemplate
elemento é obrigatório, como o X-WindowsPhone-Target
cabeçalho.
Resposta
A resposta inclui um código de status HTTP e um conjunto de cabeçalhos de resposta.
Códigos de resposta
Código | Descrição |
---|---|
201 | Registro criado com sucesso. |
400 | Corpo da solicitação inválido. O registro não pode ser criado devido a uma solicitação com defeito. |
401 | Falha de autorização. A tecla de acesso estava incorreta. |
403 | Cota excedida; há registros demais nesse namespace. Registro não criado. |
403 | Solicitação rejeitada, pois a classificação de operações de registro é alta demais. |
Para obter informações sobre códigos de status, consulte Status e códigos de erro.
Cabeçalhos de resposta
Cabeçalho de resposta | Descrição |
---|---|
Content-type | application/atom+xml;type=entry;charset=utf-8 |
ETag | {weak ETag} |
Corpo da resposta
Ao ser bem-sucedido, uma entrada Atom validada é retornada. Isso inclui elementos somente leitura, como ETag
, RegistrationId
, e ExpirationTime
. Por exemplo:
<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="https://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>