timers

/:channel

Changed on Aug 19, 2022

Create a new timer

post/bot/timers/{channel}

Request

Base URL
https://api.streamelements.com/kappa/v2
Auth
- HTTP bearer
- or OAuth 2
  Authorization codehttps://api.streamelements.com/oauth2/authorize
  Token URLhttps://api.streamelements.com/oauth2/token
- or HTTP bearer
TypeScript
https://skmtc.dev/streamelements/apis/se-api-docs/docs/bot/timers/:channel/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

channelstring required

Example:5b2e2007760aeb7729487dab

guid - Channel id

Headers

Acceptstring required

Example:application/json

Request body

enabledboolean required

chatLinesinteger required

namestring required

messagestring required

Example request

{
  "online": {
    "enabled": true,
    "interval": 5
  },
  "offline": {
    "enabled": true,
    "interval": 30
  },
  "enabled": true,
  "chatLines": 5,
  "name": "",
  "message": ""
}

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

Aug 19, 20227ec3cd3b664e Revision changes
- breaking
  added the new required request property
- breaking
  added the new required request property
- breaking
  added the new required request property
- breaking
  added the new required request property
- breaking
  added the new required request property
- breaking
  added the new required request property
- breaking
  the request's body type changed from no type to object
- breaking
  the response's body type changed from no type to object for status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
Feb 22, 202151e3df32da57 Revision 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

Operation history (3 revisions)