# Tipos de notificação Cada notificação enviada pelo Messaging Gateway tem um formato comum, dependendo do tipo de notificação. A estrutura da mensagem de notificação também é descrita na [documentação da AsyncAPI](https://docs.equinix.com/pt-BR/api-catalog/emgv1.md) . Todas as mensagens enviadas pela Equinix têm os seguintes componentes: ``` { "Task": {     "Header attribute 1": "",     "Header attribute 2": "",     "Header attribute 3": "",     ...     "Body": {     "Body attribute 1": "",     "Body attribute 2": "",     "Body attribute 3": "",     ...     } }, "Signature": "Base 64 encrypted signature" } ``` Esses atributos de cabeçalho são aplicáveis ​​a todos os tipos de pedido . * `ID` - `String` `(Guid)` - O identificador exclusivo da mensagem. A Equinix enviará um valor exclusivo para cada mensagem. * `Source``String``(Guid)` - - Um valor exclusivo para identificar o remetente da mensagem. Esse valor será compartilhado com o cliente durante o processo de integração. * `Verb``String` - - Atualização. Isso indica que há uma atualização da Equinix. * `Resource``String` - - Nome do produto Equinix para o qual a notificação está sendo enviada. * `ContentType` - `String` - "application/json" * `CreateTimeUTC` - `String` - Indica a data e a hora em que a notificação é enviada pela Equinix. * `Version` - `String` - A versão do esquema de notificação. Os atributos do corpo variam para cada tipo de notificação. ## Notificações de cobrança As notificações de cobrança são notificações quase em tempo real acionadas quando o pedido do cliente é fechado e a cobrança é iniciada pela Equinix. Essas notificações serão acionadas para todos os pedidos de clientes enviados por meio de canais off-line e on-line. Os revendedores também receberão notificações de cobrança quando a cobrança começar para pedidos feitos pelos clientes. Notificação de amostra: ``` { "Task": {     "Id": "la83ef18-5e36-4a2d-9d80-490ee217d004",     "Source": "3e095d30-40ff-11e9-8959-5be078353003",     "Verb": "Update",     "Resource": "CrossConnnect",     "ContentType": "application/json",     "CreationTimeUTC": "2021-06-16T19:57:21.326Z",     "Version": "1.0",     "Body": {     "RequestorId": "",     "ServicerId": "1-205346710865",     "State": "Closed",     "Description": "Order Number:1-205346710865 billing notification",     "LineDetails": [         {         "Id": "1-3N5W5LYZ",         "Ibx": "DC1",         "Status": "Billed",         "BilledLines": [             "1-2N5W4JAS",             "1-2N5W4K87",             "1-2N5W3M21",             "1-2N5235N2"         ]         }     ]     } }, "Signature": "RWNobwp7CiAgIklkIjogIjM1MGFlZjcwLTc4MWItMTFlOSogIH0KfQ==" } ``` As notificações de cobrança têm os seguintes atributos de corpo: * `Body``Object` - - Um objeto contendo os detalhes da notificação. Os atributos dentro do objeto variam com base no recurso e no verbo. * `RequestorId` - `String` - Número de referência do cliente para a manutenção (se houver). * `ServicerId` - `String` - Indica o ID exclusivo fornecido pela Equinix para o pedido enviado. * `State``String` - - Indica o estado atual do pedido. Valor suportado - "Fechado". * `Description` - `Object` - Resumo do ticket do Sistema de Cobrança. * `LineDetails``Array` - - Um array de objetos contendo os detalhes dos itens de linha faturados e do data center: * `Id` - ID da linha de cobrança exclusiva. * `Ibx` - Nome do data center/IBX. * `Status` - Valor suportado "Faturado". * `BilledLines` - `Array[String]` Lista de itens de linha faturados ## Notificações de Fabric O Messaging Gateway oferece suporte a notificações do Fabric para os fluxos de trabalho abaixo: * Porta de Equinix Fabric para cima/baixo * Conexão virtual do Equinix Fabric ativa/desativada Notificação de amostra: ``` { "Task": {     "Id": "bf9f2707-d612-4d63-9958-4c8b1fcf3cc0",     "Source": "3e095d30-40ff-11e9-8959-5be078353003",     "Verb": "Update",     "Resource": "DataCenter.Network.Port",     "ContentType": "application/json",     "Version": "1.0",     "Body": {      "timestamp":"2020-05-21T10:20:00Z",     "type":"PORT_OPSTATUS_NOTIFICATION",     "uuid":"11c954fb-8e8b-4515-97d7-cc80129a0985",     "description":"Port is not operational. Connections on this port might be affected.",     "data":{         "type":"XF_PORT",         "uuid":"a867f685-41b0-1b07-6de0-320a5c00abdd",         "name":"L2-DEV-USER01-DC5-CX-10G-SECONDARY-NOKIA-02",         "href":"https://api.equinix.com/fabric/v4/ports/a867f685-41b0-1b07-6de0-320a5c00abdd",         "operation":{             "operationalStatus":"DOWN",             "opStatusChangedAt":"2020-05-21T10:20:00Z",             "maintenanceMode":false         },         "embedded":{             "connections":{                 "href":[                 "https://api.equinix.com/fabric/v4/connections/8822de74-805f-4f63-b52d-93bcbf2a1d1b",                 "https://api.equinix.com/fabric/v4/connections/8f20bea9-a5b9-47e5-88e6-a899584ebb90"                 ]             }         }     }     } }, "Signature": "RWNobwp7CiAgIklkIjogIjM1MGFlZjcwLTc4MWItMTFlOSogIH0KfQ==" } ``` As notificações de Fabric têm os seguintes atributos de corpo: * `Body``Object` - - Um objeto contendo os detalhes da notificação. Os atributos dentro do objeto variam com base no recurso e no verbo. * `type``String` - - Indica o tipo de notificação. `PORT_OPSTATUS_NOTIFICATION` Indica que a porta Fabric está em manutenção no momento. `CONNECTION_OPSTATUS_NOTIFICATION` A conexão virtual do Fabric indicada está em manutenção no momento. * `uuid` - `String` - Indica o ID exclusivo fornecido pela Equinix para a manutenção. * `description` - `String` - Resumo do ticket de um Técnico Equinix. * `data``Object` - - Um objeto contendo os detalhes da porta do cliente. * `type``String` - - Indica o tipo de porta. `XF_PORT` Indica a porta Equinix Fabric. `EVPL_VC` Indica a conexão virtual Equinix Fabric. * `uuid` - `String` - Indica o ID exclusivo da porta do cliente. * `name` - `String` - Indica o nome da porta do cliente. * `href``String` - - Link para obter mais detalhes da porta do cliente. * `operation``Object` - - Um objeto contendo os detalhes relacionados ao status da porta do cliente. * `operationalStatus` - `String` - Indica o status atual da porta do cliente. * `opStatusChangedAt` - `String` - Indica a data e a hora em que o status da porta do cliente foi monitorado pela última vez. * `maintenanceMode` - `Boolean` - Indica se é uma manutenção planejada ou não planejada. * `embedded``Object` - - Um objeto contendo os detalhes das conexões virtuais ativas nesta porta do cliente. * `connections``Object` - - Um objeto que contém a lista das conexões virtuais ativas nesta porta do cliente. * `href` - `Array[String]` - Um array contendo a lista das conexões virtuais ativas nesta porta do cliente. ## IBX Notificações As notificações IBX são notificações quase em tempo real para qualquer manutenção planejada e não planejada do data center Equinix IBX. Essas notificações também são acionadas para quaisquer incidentes e avisos no data center Equinix IBX. O Messaging Gateway suporta as seguintes variantes de notificações IBX: * Notificações de manutenção do IBX * Notificações de incidentes do IBX * Notificações de consultoria do IBX * Notificações de incidentes de segurança IBX Notificação de amostra: ``` { "Task": {     "Id": "370da978-b9bd-4030-b012-9dc97e2fdf98",     "Source": "3e095d30-40ff-11e9-8959-5be078353003",     "Verb": "Update",     "Resource": "DataCenter.Maintenance",     "ContentType": "application/json",     "CreationTimeUTC": "2021-06-09T07:42:45.396Z",     "Version": "1.0",     "Body": {     "RequestorId": "97ae4427-70cb-4162-bf52-c3c7f9d7b2d8",     "ServicerId": "5-204454471282",     "State": "CONFIRMED",     "Description": "Equinix Test Maintenance",     "Sequence": "2",     "StartDateTime": "2021-03-29T17:33:00",     "EndDateTime": "2021-03-31T18:00:00",     "AccountNumber": "123456",     "Impact": "NON_SERVICE_IMPACTING",     "ProdID": "DataCenter Notification https://developer.equinix.com",     "Organizer": "Equinix Customer Support https://www.equinix.com/contact-us/customer-support",     "Assets": []     } }, "Signature": "RWNobwp7CiAgIklkIjogIjM1MGFlZjcwLTc4MWItMTFlOSogIH0KfQ== " } ``` As notificações IBX têm os seguintes atributos de corpo: * `Body``Object` - - Um objeto contendo os detalhes da notificação. Os atributos dentro do objeto variam com base no recurso e no verbo. * `RequestorId` - `String` - Número de referência do cliente para a manutenção (se houver). * `ServicerId` - `String` - Indica o ID exclusivo fornecido pela Equinix para a manutenção/incidente do data center. * `State` - `String` - Estado atual do ticket Valores suportados: * `CONFIRMED` - A manutenção/incidente do data center está confirmada. * `IN-PROCESS` - Manutenção/incidente do data center atualmente em andamento. * `COMPLETED` - A manutenção/incidente do data center foi concluída. * `CANCELLED` - A manutenção/incidente do data center foi cancelada. * `Description` - `Object` - Resumo do ticket de um Técnico Equinix. * `Sequence` - `Number` - Incrementando o número para as notificações relacionadas. O número começa em 0. * `StartDateTime``String` - - Indica a data de início e a hora da manutenção. * `EndDateTime` - `String` - Indica a data e a hora de término da manutenção. Este valor será sempre preenchido para o Recurso do tipo"data center. Manutenção" Este valor só será preenchido para o Estado como `COMPLETED` para os Tipos de Recurso - `DataCenter.Incident`, `DataCenter.SecurityIncident` e `DataCenter.Advisory`. * `AccountNumber` - `String` - Indica o número da conta do Cliente relacionado à atividade de manutenção. * `Impact` - `String` - Indica o nível/gravidade do impacto para o cliente devido à atividade de manutenção ou incidente. Valores suportados: * `SERVICE_IMPACTING` - indica a atividade ou incidente que afeta seus serviços. * `NON_SERVICE_IMPACTING` - indica a atividade ou incidente que não interrompe seus serviços, como quando os servidores de backup mantêm as coisas funcionando apesar dos reparos. * `ProdID` - `String` - Indica o link para consultar mais informações sobre a atividade de manutenção. * `Organizer``String` - - Indica o nome do organizador de manutenção. [Equinix Customer Support](https://www.equinix.com/contact-us/customer-support). * `Assets` - `Object` - Este valor será preenchido para Recurso dos tipos "DataCenter.Maintenance" e "DataCenter.Incident". Um objeto contendo os detalhes dos ativos afetados do cliente com os atributos: * `IBX` * `Cage` * `Cabinet` * `Serial Number` * `Circuit Type` ## Notificações de rede As notificações de rede são notificações quase em tempo real para qualquer manutenção planejada e não planejada de Rede de Produtos ou Serviços Equinix. Essas notificações também são acionadas para quaisquer incidentes de Rede de Produtos ou Serviços Equinix. O Messaging Gateway oferece suporte às variantes de Notificações de Rede abaixo * Notificações de manutenção de rede * Notificações de incidentes de rede Notificação de amostra: ``` { "Task": {     "Id": "370da978-b9bd-4030-b012-9dc97e2fdf98",     "Source": "3e095d30-40ff-11e9-8959-5be078353003",     "Verb": "Update",     "Resource": "Network.Maintenance",     "ContentType": "application/json",     "CreationTimeUTC": "2021-06-09T07:42:45.396Z",     "Version": "1.0",     "Body": {     "RequestorId": "97ae4427-70cb-4162-bf52-c3c7f9d7b2d8",     "ServicerId": "5-204454471282",     "State": "CONFIRMED",     "Description": "Equinix Test Maintenance",     "Sequence": "2",     "StartDateTime": "2021-03-29T17:33:00",     "EndDateTime": "2021-03-31T18:00:00",     "AccountNumber": "123456",     "Impact": "NON_SERVICE_IMPACTING",     "ProdID": "Network Notification https://developer.equinix.com",     "Organizer": "Equinix Customer Support https://www.equinix.com/contact-us/customer-support",     "Assets": []     } }, "Signature": "RWNobwp7CiAgIklkIjogIjM1MGFlZjcwLTc4MWItMTFlOSogIH0KfQ==" } ``` As notificações de rede têm os seguintes atributos de corpo: * `Body``Object` - - Um objeto contendo os detalhes da notificação. Os atributos dentro do objeto variam com base no recurso e no verbo. * `RequestorId` - `String` - Número de referência do cliente para a manutenção (se houver). * `ServicerId` - `String` - Indica o ID exclusivo fornecido pela Equinix para a manutenção/incidente da rede. * `State` - `String` - Estado atual do ticket Valores suportados: * `CONFIRMED` - A manutenção/incidente do data center está confirmada. * `IN-PROCESS` - Manutenção/incidente do data center atualmente em andamento. * `COMPLETED` - A manutenção/incidente do data center foi concluída. * `CANCELLED` - A manutenção/incidente do data center foi cancelada. * `Description` - `Object` - Resumo do ticket de um Técnico Equinix. * `Sequence` - `Number` - Incrementando o número para as notificações relacionadas. O número começa em 0. * `StartDateTime``String` - - Indica a data de início e a hora da manutenção. * `EndDateTime` - `String` - Indica a data e a hora de término da manutenção. Este valor será sempre preenchido para o Recurso do tipo "Network.Maintenance" Este valor será preenchido apenas para o Estado como `COMPLETED` para o Recurso do tipo `Network.Incident`. * `AccountNumber` - `String` - Indica o número da conta do Cliente relacionado à atividade de manutenção. * `Impact` - `String` - Indica o nível/gravidade do impacto para o cliente devido à atividade de manutenção ou incidente. Valores suportados: * `SERVICE_IMPACTING` - indica a atividade ou incidente que afeta seus serviços. * `NON_SERVICE_IMPACTING` - indica a atividade ou incidente que não interrompe seus serviços, como quando os servidores de backup mantêm as coisas funcionando apesar dos reparos. * `ProdID` - `String` - Indica o link para consultar mais informações sobre a atividade de manutenção. * `Organizer``String` - - Indica o nome do organizador de manutenção. [Equinix Customer Support](https://www.equinix.com/contact-us/customer-support). * `Assets` - `Object` - Este valor será preenchido para Recurso dos tipos "Network.Maintenance" e "Network.Incident". Um objeto contendo os detalhes dos ativos afetados do cliente com os atributos: * `IBX` * `Cage` * `Cabinet` * `Serial Number` * `Circuit Type` ## Notificações de pedidos As notificações de pedidos são notificações quase em tempo real para pedidos feitos por meio do Portal do Cliente, APIs ou EMG. Essas notificações fornecem atualizações sobre o status de seus pedidos à medida que eles progridem em vários estágios, incluindo criação, agendamento, atualizações e conclusão. As notificações de pedidos estão disponíveis para os seguintes tipos de pedidos: * Pedidos de conexão cruzada * Pedidos da Smart Hands * Ordens de visita de trabalho * pedidos de envio * Pedidos de suporte técnico Exemplo de Notificação de Pedido: ``` { "Task": { "Id": "a4f3d7e2-1a6c-4b8d-9e2f-3c5a8b7d9e1f", "Source": "3e095d30-40ff-11e9-8959-5be078353003", "Verb": "Update", "Resource": "SmartHands", "ContentType": "application/json", "CreationTimeUTC": "2021-06-16T19:57:21.326Z", "Version": "1.0", "Body": { "RequestorId": "CUSTOMER-REF-001", "ServicerId": "1-205346710865", "ActivityId": "1-3N5W5LYZ", "State": "InProgress", "Description": "Smart Hands order in progress - technician assigned", "CustomerContact": "customer.contact@example.com", "Location": "DC1", "ServiceDetails": { "scopeOfWork": "Equipment installation and cable management", "startDateTime": "2021-06-17T09:00:00Z", "endDateTime": "2021-06-17T11:00:00Z" }, "Attachments": [] } }, "Signature": "RWNobwp7CiAgIklkIjogIjM1MGFlZjcwLTc4MWItMTFlOSogIH0KfQ==" } ``` As notificações de pedidos possuem os seguintes atributos de corpo: * `Body``Object` - - Um objeto contendo os detalhes da notificação do pedido. Os atributos dentro do objeto variam com base no recurso e no estado. * `RequestorId` - `String` - Número de referência do cliente para o pedido. Este é o identificador exclusivo que você pode fornecer ao fazer pedidos. * `ServicerId` - `String` - O número do pedido exclusivo fornecido pela Equinix para o pedido enviado. Também chamado de número do pedido. * `ActivityId` - `String` - O identificador de atividade exclusivo para itens de linha ou subtarefas específicos dentro de um pedido. * `State``String` - - O estado atual do pedido. os estados comuns incluem: * `Open` - O pedido foi recebido e está sendo revisado * `InProgress` - O trabalho está sendo executado no pedido * `Completed` - O pedido foi concluído com sucesso * `Cancelled` - O pedido foi cancelado * `Pending Customer Input` - Equinix requer informações adicionais ou aprovação do cliente * `On Hold` - O pedido está temporariamente pausado * `Description``String` - - Uma descrição detalhada do status atual do pedido ou de quaisquer mensagens dos técnicos da Equinix. * `CustomerContact``String` - - O e-mail de contato principal do cliente associado ao pedido. * `Location``String` - - O local do data center IBX onde o pedido está sendo atendido. * `ServiceDetails` - `Object` - Detalhes específicos para o tipo de pedido que está sendo executado. O conteúdo varia de acordo com o tipo de pedido: * Para Smart Hands: escopo do trabalho, data e hora de início, data e hora de término, detalhes do equipamento. * Para Cross Connect: informações sobre painéis de conexão, detalhes do circuito, tipos de conectores * Para visitas a trabalho: informações para visitantes, finalidade, duração. * Para envios: informações da transportadora, números de rastreamento, instruções de entrega. * Para chamados de suporte: descrição do problema, gravidade, serviços afetados * `Attachments``Array` - - Uma matriz de anexos de arquivos relacionados ao pedido. Cada anexo inclui: * `Id` - Identificador exclusivo para o anexo * `Name` - Nome do arquivo do anexo * `Url` - URL de download para o anexo (quando disponível)