config.desc

The config.desc command is used to get descriptions of available config settings.

TR50 Request


                        {
  "cmd": {
    "command": "config.desc"
  }
}
      

TR50 Response

If the command is sent successfully a success message is returned. Otherwise, an error and error message will be returned.


                        {
  "cmd": {
    "success": true,
    "params": {
      "retention": {
        "apiLogAge": {
          "name": "API Log Retention",
          "required": true
        },
        "fileAge": {
          "name": "File Retention",
          "required": true
        },
        "locHistoryAge": {
          "name": "Location History Retention",
          "required": true
        },
        "mailboxAge": {
          "name": "Mailbox History Retention",
          "required": true
        },
        "propAggregateAge": {
          "name": "Property Aggregate Retention",
          "required": true
        },
        "propHistoryAge": {
          "name": "Property History Retention",
          "required": true
        },
        "thingLogAge": {
          "name": "Thing Log Retention",
          "required": true
        }
      },
      "twilio": {
        "accountSid": {
          "name": "Account SID",
          "required": true
        },
        "authToken": {
          "name": "Auth Token",
          "required": true
        },
        "defaultFrom": {
          "name": "Default From Phone Number",
          "required": false
        }
      }
    }
  }
}
      

Response Parameters

Name

Type

Description

CONFIG_GROUP_KEY

Object

Config group object where the keys are the setting keys.

...

...

...

Config Group Object

Name

Type

Description

name

String

The name of this config setting.

required

Boolean

Whether this config setting is required.