IotHub
  1. Bootstrap process
IotHub
  • API
    • TALQ
      • Device Class
        • Create a Talq Device Class
        • Update Talq Device Class
        • Delete a Talq Device Class
        • Update a Talq Device Class
      • Device
        • Create a Talq Device
        • List Talq Devices
        • Modify a Talq Device
        • Update Talq Devices
        • Delete a Talq Device
        • Get a Talq Device
        • Modify a Talq Device patch
        • Update a Talq Device
        • Get a Talq Device Function
        • Get a Talq Device Attribute
      • Services
        • Create a Talq Service
      • Group
        • List Talq Groups
        • Get a Talq Group
  • Docs TALQ
    • Introdução à especificação TALQ
    • Visão geral da API TALQ
    • Bootstrap process
    • Tier 1
      • Visão Geral
      • Solicitações
        • Criar Solicitação
        • Cancelar Solicitação
    • Tier 2
      • Visão geral
      • Bootstrap process
        • Device discovery
          POST
        • Classes discovery
          POST
        • Services announcement
          POST
        • Gateway update
          PATCH
        • Gateway class announcement
          POST
        • Gateway announcement
          POST
      • Device Class
        • Create a Talq Device Class
        • Update Talq Device Class
        • Delete a Talq Device Class
        • Update a Talq Device Class
      • Device
        • Get a Talq Device
        • Create a Talq Device
        • List Talq Devices
        • Modify a Talq Device
        • Update Talq Devices
        • Delete a Talq Device
        • Modify a Talq Device patch
        • Update a Talq Device
        • Get a Talq Device Function
        • Get a Talq Device Attribute
    • Tier 3
      • Visão Geral
      • Group
        • List Talq Groups
        • Get a Talq Group
      • Logger Configs
        • Get Logger Config
      • Log Reports
        • Send log report
    • Tier 4
      • Visão Geral
  1. Bootstrap process

Gateway announcement

Developing
POST
/talq/devices

Request

Query Params

Body Params application/json

Example
[
    {
        "address": "00000000-0000-0000-0000-000000000000",
        "name": "TCTGateway",
        "class": "cls:Gateway",
        "functions": [
            {
                "type": "BasicFunction",
                "id": "fBasicFunction",
                "assetId": {
                    "type": "AttributeString",
                    "timestamp": "2024-10-03T11:54:27.439636Z",
                    "value": "SetByCertificationToolForTestPurpose"
                },
                "serial": {
                    "type": "AttributeString",
                    "timestamp": "2024-10-03T11:54:27.439779Z",
                    "value": "SetByCertificationToolForTestPurpose"
                },
                "hwType": {
                    "type": "AttributeString",
                    "timestamp": "2024-10-03T11:54:27.439895Z",
                    "value": "SetByCertificationToolForTestPurpose"
                },
                "swVersion": {
                    "type": "AttributeString",
                    "timestamp": "2024-10-03T11:54:27.438286Z",
                    "value": "SetByCertificationToolForTestPurpose"
                },
                "timeZone": {
                    "type": "AttributeString",
                    "timestamp": "2024-10-03T11:54:27.440045Z",
                    "value": "Europe/Madrid"
                },
                "location": {
                    "type": "AttributeLocation",
                    "timestamp": "2024-10-03T11:54:27.441087Z",
                    "value": {
                        "latitude": -90,
                        "longitude": 180,
                        "altitude": -430
                    }
                }
            },
            {
                "type": "CommunicationFunction",
                "id": "fCommunicationFunction",
                "physicalAddress": {
                    "type": "AttributeString",
                    "timestamp": "2024-10-03T11:54:27.440239Z",
                    "value": "b0:76:8d:28:39:c0"
                },
                "parentAddress": {
                    "type": "AttributeString",
                    "timestamp": "2024-10-03T11:54:27.440502Z",
                    "value": "00000000-0000-0000-0000-000000000000/fCommunicationFunction"
                }
            },
            {
                "type": "GatewayFunction",
                "cmsUri": {
                    "type": "AttributeUri",
                    "timestamp": "2024-10-03T11:54:27.440576Z",
                    "value": "https://iothub-app-homol.whiteisland-d9d6c2f4.brazilsouth.azurecontainerapps.io/talq/"
                },
                "cmsAddress": null,
                "gatewayUri": {
                    "type": "AttributeUri",
                    "timestamp": "2024-10-03T11:54:27.440611Z",
                    "value": "https://api.exati.talq-cert-tool.org:2543/talq.cms"
                },
                "gatewayAddress": null,
                "retryPeriod": {
                    "type": "AttributeFloat",
                    "timestamp": "2024-10-03T11:54:27.440597Z",
                    "value": 10.0
                },
                "crlUrn": {
                    "type": "AttributeUri",
                    "timestamp": "2024-10-03T11:54:27.440602Z",
                    "value": "http://crl.url.example.com"
                },
                "vendor": {
                    "type": "AttributeString",
                    "value": "TALQ Consortium"
                },
                "id": "fGatewayFunction"
            },
            {
                "type": "ElectricalMeterFunction",
                "id": "fElectricalMeterFunction"
            }
        ]
    }
]

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://iot.exati.com.br/staging/talq/devices?clientAddress=00000000-0000-0000-0000-000000000000' \
--header 'Content-Type: application/json' \
--data-raw '[
    {
        "address": "00000000-0000-0000-0000-000000000000",
        "name": "TCTGateway",
        "class": "cls:Gateway",
        "functions": [
            {
                "type": "BasicFunction",
                "id": "fBasicFunction",
                "assetId": {
                    "type": "AttributeString",
                    "timestamp": "2024-10-03T11:54:27.439636Z",
                    "value": "SetByCertificationToolForTestPurpose"
                },
                "serial": {
                    "type": "AttributeString",
                    "timestamp": "2024-10-03T11:54:27.439779Z",
                    "value": "SetByCertificationToolForTestPurpose"
                },
                "hwType": {
                    "type": "AttributeString",
                    "timestamp": "2024-10-03T11:54:27.439895Z",
                    "value": "SetByCertificationToolForTestPurpose"
                },
                "swVersion": {
                    "type": "AttributeString",
                    "timestamp": "2024-10-03T11:54:27.438286Z",
                    "value": "SetByCertificationToolForTestPurpose"
                },
                "timeZone": {
                    "type": "AttributeString",
                    "timestamp": "2024-10-03T11:54:27.440045Z",
                    "value": "Europe/Madrid"
                },
                "location": {
                    "type": "AttributeLocation",
                    "timestamp": "2024-10-03T11:54:27.441087Z",
                    "value": {
                        "latitude": -90,
                        "longitude": 180,
                        "altitude": -430
                    }
                }
            },
            {
                "type": "CommunicationFunction",
                "id": "fCommunicationFunction",
                "physicalAddress": {
                    "type": "AttributeString",
                    "timestamp": "2024-10-03T11:54:27.440239Z",
                    "value": "b0:76:8d:28:39:c0"
                },
                "parentAddress": {
                    "type": "AttributeString",
                    "timestamp": "2024-10-03T11:54:27.440502Z",
                    "value": "00000000-0000-0000-0000-000000000000/fCommunicationFunction"
                }
            },
            {
                "type": "GatewayFunction",
                "cmsUri": {
                    "type": "AttributeUri",
                    "timestamp": "2024-10-03T11:54:27.440576Z",
                    "value": "https://iothub-app-homol.whiteisland-d9d6c2f4.brazilsouth.azurecontainerapps.io/talq/"
                },
                "cmsAddress": null,
                "gatewayUri": {
                    "type": "AttributeUri",
                    "timestamp": "2024-10-03T11:54:27.440611Z",
                    "value": "https://api.exati.talq-cert-tool.org:2543/talq.cms"
                },
                "gatewayAddress": null,
                "retryPeriod": {
                    "type": "AttributeFloat",
                    "timestamp": "2024-10-03T11:54:27.440597Z",
                    "value": 10.0
                },
                "crlUrn": {
                    "type": "AttributeUri",
                    "timestamp": "2024-10-03T11:54:27.440602Z",
                    "value": "http://crl.url.example.com"
                },
                "vendor": {
                    "type": "AttributeString",
                    "value": "TALQ Consortium"
                },
                "id": "fGatewayFunction"
            },
            {
                "type": "ElectricalMeterFunction",
                "id": "fElectricalMeterFunction"
            }
        ]
    }
]'

Responses

🟢200Success
application/json
Body

Example
{}
Modified at 2025-09-11 13:03:53
Previous
Gateway class announcement
Next
Create a Talq Device Class