songrequests

/:channel/settings

Changed on Feb 22, 2021

Get settings

get/songrequest/{channel}/settings

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/songrequest/:channel/settings/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

channelstring required

Example:5b2e2007760aeb7729487dab

guid - Channel id

Response

enabledboolean required

modestring required

moderationboolean required

_idstring required

bannedUsersstring[] required

Example response

{
  "player": {
    "delay": 0
  },
  "limits": {
    "users": {
      "free": 5,
      "paid": 0
    },
    "queueLimit": 10,
    "maxDuration": 420
  },
  "backupPlaylist": {
    "url": "https://www.youtube.com/playlist?list=UUp8OOssjSjGZRVYK6zWbNLg",
    "prioritizeQueue": false
  },
  "bot": {
    "voteskip": {
      "enabled": true,
      "votesRequired": 5
    },
    "cost": 0,
    "subscriberDiscount": 50,
    "exemptUserLevel": 500,
    "minUserLevel": 100
  },
  "tips": {
    "mediashare": {
      "enabled": false,
      "costPerSecond": 0.1
    },
    "prioritize": true
  },
  "youtube": {
    "securityLevel": 0,
    "musicOnly": false,
    "bannedTags": [],
    "bannedVideos": []
  },
  "enabled": false,
  "mode": "combined",
  "moderation": false,
  "_id": "5b2e2007760aeb82e8487dc4",
  "bannedUsers": []
}

Changes

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
Feb 7, 20218c745ed2e9e4 Revision changes
- warning
  the optional response header Access-Control-Allow-Credentials removed for the status 200
- warning
  the optional response header Access-Control-Expose-Headers removed for the status 200
- warning
  the optional response header ETag removed for the status 200
- warning
  the optional response header Server removed for the status 200
- warning
  the optional response header Strict-Transport-Security removed for the status 200
- warning
  the optional response header X-Content-Type-Options removed for the status 200
- warning
  the optional response header X-DNS-Prefetch-Control removed for the status 200
- warning
  the optional response header X-Download-Options removed for the status 200
- warning
  the optional response header X-Frame-Options removed for the status 200
- warning
  the optional response header X-Requested-From removed for the status 200
- warning
  the optional response header X-XSS-Protection removed for the status 200

Operation history