campaign.task.list

The campaign.task.list command is used to find and return a list of campaign actions.

TR50 Request


                        {
  "cmd": {
    "command": "campaign.task.list"
  }
}
      

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": {
      "result": [
        {
          "inputs": [
            {
              "count": 10,
              "key": "tags",
              "name": "Tags",
              "required": true,
              "type": "tags"
            }
          ],
          "type": "tag.add"
        },
        {
          "inputs": [
            {
              "count": 10,
              "key": "tags",
              "name": "Tags",
              "required": true,
              "type": "tags"
            }
          ],
          "type": "tag.delete"
        },
        {
          "inputs": [
            {
              "count": 1,
              "key": "timeout",
              "name": "Timeout (seconds)",
              "required": true,
              "type": "number"
            }
          ],
          "type": "gateway.ping"
        },
        {
          "inputs": [
            {
              "count": 1,
              "key": "name",
              "name": "SUP Name",
              "required": true,
              "type": "string"
            }
          ],
          "type": "gateway.sup.update"
        }
      ]
    }
  }
}
      

Response Parameters

Name

Type

Description

result

Array

An array consisting of result objects.

Result Object

Name

Type

Description

type

String

The action type.

inputs

Array

Array of objects describing input parameters for this action type.

Input/Output Object

Name

Type

Description

key

String

The input parameter field key.

name

String

The name of this input.

required

Boolean

Whether this parameter is required.

type

String

The type of this input's value.

count

Boolean

If multiple values are possible, the maximum array size.