STstreamelements
commands

/:channel/:commandId

Changed on

Get command details

get/bot/commands/{channel}/{commandId}

Request

Path parameters

channelstring required
Example:5b2e2007760aeb7729487dab

guid - Channel id

commandIdstring required

guid - Command id

Headers

Acceptstring required
Example:application/json

Response

aliasesstring[] required
keywordsstring[] required
enabledboolean required
enabledOnlineboolean required
enabledOfflineboolean required
hiddenboolean required
costinteger required
typestring required
accessLevelinteger required
_idstring
regexstring required
replystring required
commandstring required
channelstring required
createdAtstring
updatedAtstring

Example response

{
  "cooldown": {
    "user": 15,
    "global": 5
  },
  "aliases": [],
  "keywords": [],
  "enabled": true,
  "enabledOnline": true,
  "enabledOffline": true,
  "hidden": false,
  "cost": 0,
  "type": "say",
  "accessLevel": 100,
  "_id": "5c0a5172de9a4c5b7da14d8a",
  "regex": "test[0-9]{3}",
  "reply": "test response",
  "command": "test",
  "channel": "5b2e2007760aeb7729487dab",
  "createdAt": "2018-12-07T10:54:42.594Z",
  "updatedAt": "2018-12-07T10:54:42.594Z"
}

Changes

  • 51e3df32da57Revision changes
    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

  • 6f0746f170b0Revision changes
    • warning

      deleted the header request parameter Content-Type