Kick script functions¶

Functions for C# (Cb.Call) and Python (cb.call). See Script functions for how to use them.

kick.ban¶

Bans a viewer from your Kick chat for good. Fails when you are not signed in to Kick or the user cannot be found.

Value	What to put in
`user`	The Kick user name (a leading @ is fine) or their number id, like "CoolViewer42".
`reason`	Optional. Why they were banned, like "Spam".

Gives back: Nothing.

C#Python

var answer = await Cb.Call("kick.ban", new { user = "CoolViewer42", reason = "Spam" });

answer = cb.call("kick.ban", user="CoolViewer42", reason="Spam")

kick.deleteMessage¶

Deletes one message from your Kick chat. Fails when the message id is empty.

Value	What to put in
`messageId`	The id of the chat message, like the %messageId% of a chat trigger.

Gives back: Nothing.

C#Python

var answer = await Cb.Call("kick.deleteMessage", new { messageId = "a1b2c3d4-5678-90ab-cdef-1234567890ab" });

answer = cb.call("kick.deleteMessage", messageId="a1b2c3d4-5678-90ab-cdef-1234567890ab")

kick.getBroadcaster¶

Gives you the details of your Kick account and bot account as Cuebot knows them right now. Values are empty when you are not signed in.

Gives back: An object with broadcastUser, broadcastUserId, broadcasterChannelSlug, broadcasterIsLive, broadcasterTitle, broadcasterCategory, broadcasterViewerCount, botUser and botUserId.

C#Python

var answer = await Cb.Call("kick.getBroadcaster");

answer = cb.call("kick.getBroadcaster")

kick.getUserInfo¶

Looks up a Kick viewer's profile and channel. Fails when the user cannot be found.

Value	What to put in
`user`	The Kick user name (a leading @ is fine) or their number id, like "CoolViewer42".

Gives back: An object with user, userName, userId, profilePicture, channelSlug, isLive, streamTitle, category and description.

C#Python

var answer = await Cb.Call("kick.getUserInfo", new { user = "CoolViewer42" });

answer = cb.call("kick.getUserInfo", user="CoolViewer42")

kick.reply¶

Replies to a message in your Kick chat. Long text is split into several messages; only the first one is the reply.

Value	What to put in
`message`	What to say, like "Thanks for asking!"
`replyTo`	The id of the message to answer, like the %messageId% of a chat trigger.
`useBot`	Optional. true sends it with your bot account. Leave it out to send as yourself.
`fallback`	Optional. With useBot, true (the default) sends as yourself when the bot is not signed in; false makes it fail instead.

Gives back: The id of the message that was sent last, or null when the message was empty.

C#Python

var answer = await Cb.Call("kick.reply", new { message = "Thanks for asking!", replyTo = "a1b2c3d4-5678-90ab-cdef-1234567890ab" });

answer = cb.call("kick.reply", message="Thanks for asking!", replyTo="a1b2c3d4-5678-90ab-cdef-1234567890ab")

kick.sendMessage¶

Sends a message in your Kick chat. Long text is split into several messages. Fails when you are not signed in to Kick.

Value	What to put in
`message`	What to say, like "Welcome to the stream!"
`useBot`	Optional. true sends it with your bot account. Leave it out to send as yourself.
`fallback`	Optional. With useBot, true (the default) sends as yourself when the bot is not signed in; false makes it fail instead.

Gives back: The id of the message that was sent last, or null when the message was empty.

C#Python

var answer = await Cb.Call("kick.sendMessage", new { message = "Welcome to the stream!" });

answer = cb.call("kick.sendMessage", message="Welcome to the stream!")

kick.setCategory¶

Changes the category of your Kick stream. A name picks the exact match, or else the first search result. Fails when nothing matches.

Value	What to put in
`category`	The category name, like "Just Chatting", or its number id.

Gives back: The name of the category that was set.

C#Python

var answer = await Cb.Call("kick.setCategory", new { category = "Just Chatting" });

answer = cb.call("kick.setCategory", category="Just Chatting")

kick.setTitle¶

Changes the title of your Kick stream. Fails when the title is empty.

Value	What to put in
`title`	The new title, like "Chill games with chat".

Gives back: Nothing.

C#Python

var answer = await Cb.Call("kick.setTitle", new { title = "Chill games with chat" });

answer = cb.call("kick.setTitle", title="Chill games with chat")

kick.timeout¶

Times out a viewer in your Kick chat. Kick counts in whole minutes, so seconds are rounded up (1 minute to 7 days).

Value	What to put in
`user`	The Kick user name (a leading @ is fine) or their number id, like "CoolViewer42".
`seconds`	Optional. How long, in seconds, like 300. Leave it out for 300 (5 minutes).
`reason`	Optional. Why they were timed out, like "Calm down".

Gives back: Nothing.

C#Python

var answer = await Cb.Call("kick.timeout", new { user = "CoolViewer42", seconds = 300, reason = "Calm down" });

answer = cb.call("kick.timeout", user="CoolViewer42", seconds=300, reason="Calm down")

kick.unban¶

Lets a banned or timed-out viewer chat on Kick again.

Value	What to put in
`user`	The Kick user name (a leading @ is fine) or their number id, like "CoolViewer42".

Gives back: Nothing.

C#Python

var answer = await Cb.Call("kick.unban", new { user = "CoolViewer42" });

answer = cb.call("kick.unban", user="CoolViewer42")