cdp.config.desc

The cdp.config.desc command is used to get descriptions of available CDP types and their configuration options.

Requires Org-Admin rights.

TR50 Request

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

TR50 Response

If the command is sent successfully a success message is returned and a list of available CDP types and configuration options. Otherwise, an error and error message will be returned.

{
  "cmd": {
    "success": true,
    "params": {
      "types": {
        "jasper": {
          "defaultName": "Jasper Control Center",
          "defaultPreferredSmsc": "tele2",
          "fields": [
            {
              "key": "endpoint",
              "name": "Endpoint (URL)",
              "required": false,
              "type": "string",
              "desc": "Leave empty if using default."
            },
            {
              "key": "username",
              "name": "Username",
              "required": true,
              "type": "string",
              "desc": "Your Jasper Control Center account username."
            },
            {
              "key": "password",
              "name": "Password",
              "required": true,
              "type": "password",
              "desc": "Your Jasper Control Center account password."
            },
            {
              "key": "licenseKey",
              "name": "License key",
              "required": true,
              "type": "string",
              "desc": "Your Jasper Control Center API license key."
            },
            {
              "key": "ratePlans",
              "name": "Rate plans",
              "required": false,
              "type": "stringarray",
              "desc": "Your Jasper Control Center account rate plans."
            }
          ]
        }
      }
    }
  }
}

Response Parameters

Name	Type	Description
types	Object	A collection of different CDP types, keyed by the CDP type.

Types Object

Name	Type	Description
services	Object	A collection of services configured per connection (the service types are: data, sms, voice).
defaultName	String	The default name that will be assigned to the CDP if a name is not specified at configuration time.
defaultPreferredSmsc	String	The default SMSC for this type of CDP.
fields	Object	A collection of fields describing the configuration options of the CDP.

Fields Object

Name	Type	Description
key	String	The key of the field.
name	String	The displayed name of the field.
require	Boolean	If the field is required for configuration.
type	String	The HTML type that the field should acquire: string, password, and string array.
desc	String	The description of the field.

Services Object

Name	Type	Description
Options	Array	An array of the service type configuration options.

Options Array

Name	Type	Description
name	String	Status of the option.
value	Integer	Value of the option.
contract	Array	An array of integers of the value settings that are available by the contract.