Reference Script Functions Kick

Kick script functions

Also on the Cuebot Docs site.

Functions for C# (Cb.Call) and Python (a cb method each, or 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	In Python	What to put in
user	user	The Kick user name (a leading @ is fine) or their number id, like "CoolViewer42".
reason	reason	Optional. Why they were banned, like "Spam".

Gives back: Nothing.

C#

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

Python

answer = cb.kick_ban(user="CoolViewer42", reason="Spam")

kick.deleteMessage

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

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

Gives back: Nothing.

C#

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

Python

answer = cb.kick_delete_message(message_id="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#

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

Python

answer = cb.kick_get_broadcaster()

kick.getUserInfo

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

Value	In Python	What to put in
user	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#

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

Python

answer = cb.kick_get_user_info(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	In Python	What to put in
message	message	What to say, like "Thanks for asking!"
replyTo	reply_to	The id of the message to answer, like the %messageId% of a chat trigger.
useBot	use_bot	Optional. true sends it with your bot account. Leave it out to send as yourself.
fallback	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#

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

Python

answer = cb.kick_reply(message="Thanks for asking!", reply_to="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	In Python	What to put in
message	message	What to say, like "Welcome to the stream!"
useBot	use_bot	Optional. true sends it with your bot account. Leave it out to send as yourself.
fallback	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#

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

Python

answer = cb.kick_send_message(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	In Python	What to put in
category	category	The category name, like "Just Chatting", or its number id.

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

C#

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

Python

answer = cb.kick_set_category(category="Just Chatting")

kick.setTitle

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

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

Gives back: Nothing.

C#

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

Python

answer = cb.kick_set_title(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	In Python	What to put in
user	user	The Kick user name (a leading @ is fine) or their number id, like "CoolViewer42".
seconds	seconds	Optional. How long, in seconds, like 300. Leave it out for 300 (5 minutes).
reason	reason	Optional. Why they were timed out, like "Calm down".

Gives back: Nothing.

C#

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

Python

answer = cb.kick_timeout(user="CoolViewer42", seconds=300, reason="Calm down")

kick.unban

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

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

Gives back: Nothing.

C#

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

Python

answer = cb.kick_unban(user="CoolViewer42")