Create Bot

Search in Potato software for @BotFather, as shown in the image below:

• Start a chat with BotFather and send /newbot command.
• Send the bot a nick.
• Send the bot an username to complete registration.

Authorizing your bot

Each bot is given a unique authentication token when it is created. The token looks something like 123456:ABC-DEF1234ghIkl-zyx57W2v1u123ew11, but we'll use simply <token> in this document instead. You can learn about obtaining tokens and generating new ones in Create Bot.

All queries to the Potato Bot API must be served over HTTPS and need to be presented in this form:
https://api.rct2008.com:8443/<bot_token>/METHOD_NAME.
Like this for example:
https://api.rct2008.com:8443/123456909:ABC-DEF1234ghIkl-zyx57W2v1u123ew11/getMe

We support GET and POST HTTP methods. We support four ways of passing parameters in Bot API requests:

• URL query string
• Application/json (except for uploading files)
• Multipart/form-data (use to upload files)

The response contains a JSON object, which always has a Boolean field 'ok' and may have an optional String field 'description' with a human-readable description of the result. If 'ok' equals true, the request was successful and the result of the query can be found in the 'result' field. In case of an unsuccessful request, 'ok' equals false and the error is explained in the 'description'. An Integer 'error_code' field is also returned, but its contents are subject to change in the future. Some errors may also have an optional field 'parameters' of the type ResponseParameters, which can help to automatically handle the error.

• All methods in the Bot API are case-sensitive.
• All queries must be made using UTF-8.

Bots how to receive message

• When a new message is sent to the bot, Potato bot server send the message to the bot user in two ways:
• Active Mode: The Potato bot server uses https request where the method is using post and the content-type is application/json. It automatically visit the webhook address provided by the user with the message data.
• Passive Mode: User regularly needs to request https://api.rct2008.com:8443/getUpdates to retrieve bot updates ( represents the bot user token value. With the chat you can search within Potato for BotCreator user to view and make changes). Upon success request, a json object containing the list of message updates will be returned. Details will be explained in later documents.

Making requests when getting updates

If you're using webhooks, you can perform a request to the Bot API while sending an answer to the webhook. Use either application/json or application/x-www-form-urlencoded or multipart/form-data response content type for passing parameters. Specify the method to be invoked in the method parameter of the request. It's not possible to know that such a request was successful or get its result.

Getting updates

Here are two mutually exclusive ways of receiving updates for your bot — the getUpdates method on one hand and Webhooks on the other. Incoming updates are stored on the server until the bot receives them either way, but they will not be kept longer than 24 hours.

Regardless of which option you choose, you will receive JSON-serialized Update objects as a result.

Update

This object represents an incoming update.
At most one of the optional parameters can be present in any given update.

getUpdates

Request URL

• https://api.rct2008.com:8443/<bot_token>/getUpdates

Request Method

• GET

A brief description

• Use this method to receive incoming updates using long polling(wiki). An Array of Update objects is returned.

Return parameter

An Array of Update objects is returned.

Return Example

{
    "ok": true,
    "result": [
        {
            "update_id": 1,
            "message": {
                "message_id": 57,
                "chat": {
                    "id": 11370003,
                    "type": 2,
                    "title": "group1"
                },
                "from": {
                    "id": 22800001,
                    "first_name": "David",
                    "last_name": "Smith",
                    "username": ""
                },
                "text": "123",
                "date": 1544440630
            },
            "inline_query": null,
            "lang": "en"
        }
    ]
}

Notes

• This method will not work if an outgoing webhook is set up.

setWebhook

Request URL

• https://api.rct2008.com:8443/<bot_token>/setWebhook

Request Method

• POST

A brief description

• Use this method to specify a url and receive incoming updates via an outgoing webhook. Whenever there is an update for the bot, we will send an HTTPS POST request to the specified url, containing a JSON-serialized Update. In case of an unsuccessful request, we will give up after a reasonable amount of attempts. Returns True on success.
• If you'd like to make sure that the Webhook request comes from Potato, we recommend using a secret path in the URL, e.g. https://www.example.com/<bot_token> Since nobody else knows your bot's token, you can be pretty sure it's us.

Request Parameter

Request Example

{
    "url": "https://127.0.0.1/web-mobile",
    "certificate": "00050000321djau921030213"
}

Notes

1. You will not be able to receive updates using getUpdates for as long as an outgoing webhook is set up.
2. To use a self-signed certificate, you need to upload your public key certificate using certificate parameter. Please upload as InputFile, sending a String will not work.

delWebhook

Request URL

• https://api.rct2008.com:8443/<bot_token>/delWebhook

Request Method

• GET

A brief description

• Use this method to remove webhook integration if you decide to switch back to getUpdates. Returns True on success. Requires no parameters.

Getting Information

getMe

Request URL

• https://api.rct2008.com:8443/<bot_token>/getMe

Request Method

• GET

A brief description

• A simple method for testing your bot's auth token. Requires no parameters. Returns basic information about the bot in form of a User object.

Return Example

{
    "ok": true,
    "result": {
        "id": 10100427,
        "first_name": "ll_bot",
        "last_name": "",
        "username": "ll_bot"
    }
}

Return Parameter

getFile

Request URL

• https://api.rct2008.com:8443/<bot_token>/getFile

Request Method

• POST

A brief description

• Use this method to get basic info about a file and prepare it for downloading. For the moment, bots can download files of up to 100MB in size. On success, a File object is returned. The file can then be downloaded via the link https://api.rct2008.com:8443/<bot_token>/<file_path>.

Request Parameter

Request Example

{
    "file_id": "000001009814fcd09659fdcd80bf5224"
}

Return Parameter

Return Example

{
    "ok": true,
    "result": {
        "url": "https://api.rct2008.com:8443/files/10000000:p6KKlJ7JWa6XKEj7cJ6/0000fcd09659fdcd80bf5224.mp3"
    }
}

Send A Message

sendTextMessage

Request URL

• https://api.rct2008.com:8443/<bot_token>/sendTextMessage

Request Method

• POST

A brief description

• Use this method to send text messages. On success, the sent MessageID is returned.

Request Parameter

Request Example

{
  "chat_type":1,
  "chat_id":20216742,
  "text":"aaqwerwqerwqerwerqwrqwerqwerqrqwerqwerwerqa",
  "markdown" : true,
  "reply_markup":{
        "type": 4,
        "inline_keyboard": [
            {
                "buttons": [
                    {
                        "text": "Button1",
                        "callback_data": "123"
                    },
                    {
                        "text": "Button2",
                        "callback_data": "abcde"
                    }
                ]
            },
            {
                "buttons": [
                    {
                        "text": "Button3",
                        "callback_data": "22222"
                    },
                    {
                        "text": "Button4",
                         "callback_data": "333"
                    }
                ]
            }
        ]
    }
}

Return Parameter

Return Example

{
    "ok": true,
    "result": {
        "message_id": 27315
    }
}

Formatting options

• The Bot API supports basic formatting for messages. You can use bold and italic text, as well as inline links and pre-formatted code in your bots' messages. Potato clients will render them accordingly. You can use either markdown-style.
• Note that Potato clients will display an alert to the user before opening an inline link ('Open this link?' together with the full URL).
• go to Rich Text for detail of markdown.

forwardMessage

Request URL

• https://api.rct2008.com:8443/<bot_token>/forwardMessage

Request Method

• POST

A brief description

• Use this method to forward messages of any kind. On success, the sent MessageID is returned.

Request Parameter

Request Example

{
    "chat_type": 1,
    "chat_id": 8000012,
    "from_chat_type": 1,
    "from_chat_id": 8000042,
    "message_id": 523621234
}

Return Parameter

Return Example

{
    "ok": true,
    "result": {
        "message_id": 27315
    }
}

answerCallbackQuery

Request URL

• https://api.rct2008.com:8443/<bot_token>/answerCallbackQuery

Request Method

• POST

A brief description

• Use this method to send answers to callback queries sent from inline keyboards. The answer will be displayed to the user as a notification at the top of the chat screen or as an alert. On success, True is returned.

Request Parameter

Request Example

{
    "inline_message_id": "521521325217527362323",
    "text": "Alert",
    "show_alert": true
}

Return Example

{
    "ok": true,
    "result": null
}

sendLocation

Request URL

• https://api.rct2008.com:8443/<bot_token>/sendLocation

Request Method

• POST

A brief description

• Use this method to send the user a geographic location. On success, the sent MessageID is returned.

Request Parameter

Request Example

{
    "chat_type": 1,
    "chat_id": 8000023,
    "latitude": 212.03,
    "longitude": 54.12
}

Return Parameter

Return Example

{
    "ok": true,
    "result": {
        "message_id": 27315
    }
}

sendVenue

Request URL

• https://api.rct2008.com:8443/<bot_token>/sendVenue

Request Method

• POST

A brief description

• Use this method to send the user a detailed address. On success, the sent MessageID is returned.

Request Parameter

Request Example

{
    "chat_type": 1,
    "chat_id": 8000023,
    "latitude": 33.6,
    "longitude": -111.9,
    "title": "Musical Instrument Museum",
    "address": "Phoenix,Arizona"
}

Return Parameter

Return Example

{
    "ok": true,
    "result": {
        "message_id": 27315
    }
}

sendPhoto

Request URL

• https://api.rct2008.com:8443/<bot_token>/sendPhoto

Request Method

• POST

A brief description

• It is used to send image files to users. Currently, it supports sending image files below 2M and only supports JPEG/PNG/BMP/WEBP format. On success, the sent FileID and MessageID is returned.

Request Parameter

Request Example

{
    "chat_type": 1,
    "chat_id": 8000012,
    "photo": "00000220aa47fca4bf5dfd5b49d552b9"
}

Return Parameter

Return Example

{
    "ok": true,
    "result": {
        "message_id": 27315,
        "file_id": "00050000321djau921030213"
    }
}

sendDocument

Request URL

• https://api.rct2008.com:8443/<bot_token>/sendDocument

Request Method

• POST

A brief description

• Use this method to send general files. On success, the sent Message is returned. Bots can currently send files of any type of up to 50 MB in size, this limit may be changed in the future.

Request Parameter

Request Example

{
    "chat_type": 1,
    "chat_id": 8000012,
    "document": "aaadeaamadf6knpuata7w2sceqpdjrpq"
}

Return Parameter

Return Example

{
    "ok": true,
    "result": {
        "message_id": 27315,
        "file_id": "00050000321djau921030213"
    }
}

sendVideo

Request URL

• https://api.rct2008.com:8443/<bot_token>/sendVideo

Request Method

• POST

A brief description

• Use this method to send video files, Potato clients support MP4 videos (other formats may be sent as Document). On success, the sent Message is returned. Bots can currently send files of any type of up to 50 MB in size, this limit may be changed in the future.

Request Parameter

Request Example

{
    "chat_type": 1,
    "chat_id": 8000012,
    "video": "000002229ad7056e1e5ddc6018da56dc"
}

Return Parameter

Return Example

{
    "ok": true,
    "result": {
        "message_id": 27315,
        "file_id": "000002229ad7056e1e5ddc6018da56dc"
    }
}

sendAudio

Request URL

• https://api.rct2008.com:8443/<bot_token>/sendAudio

Request Method

• POST

A brief description

• Use this method to send audio files, if you want Potato clients to display them in the music player. Your audio must be in the .mp3 format. On success, the sent Message is returned. Bots can currently send audio files of up to 50 MB in size, this limit may be changed in the future.

Request Parameter

Request Example

{
    "chat_type": 1,
    "chat_id": 8000012,
    "audio": "000002229ad7056e1e5ddc6018da56dc"
}

Return Parameter

Return Example

{
    "ok": true,
    "result": {
        "message_id": 27315,
        "file_id": "000002229ad7056e1e5ddc6018da56dc"
    }
}

Edit A Message

editMessageText

Request URL

• https://api.rct2008.com:8443/<bot_token>/editMessageText

Request Method

• POST

A brief description

• Use this method to edit text sent by the bot or via the bot (for inline bots). On success, True is returned.

Request Parameter

Request Example

{
	"chat_type":1,
	"chat_id":20000009,
	"message_id": 16,
	"text":"abcde",
	"markdown" : true,
	"reply_markup":{
        "type": 2,
        "resize_keyboard": true,
        "single_use": false,
        "selective": false,
        "keyboard": [
            {
                "buttons": [
                    {
                        "text": "new Button1"
                    },
                    {
                        "text": "new Button2"
                    }
                ]
            },
            {
                "buttons": [
                    {
                        "text": "new Button3"
                    },
                    {
                        "text": "new Button4"
                    }
                ]
            }
            ]
        }
}

Return Parameter

Return Example

{
    "ok": true
}

editMessageCaption

Request URL

• https://api.rct2008.com:8443/<bot_token>/editMessageCaption

Request Method

• POST

A brief description

• Use this method to edit text sent by the bot or via the bot (for inline bots). On success, True is returned.

Request Parameter

Request Example

{
	"chat_type":1,
	"chat_id":20000009,
	"message_id": 16,
	"caption" : "new text",
	"reply_markup":{
        "type": 4,
        "inline_keyboard": [
            {
                "buttons": [
                    {
                        "text": "new Button1",
                        "callback_data": "123"
                    },
                    {
                        "text": "new Button2",
                            "callback_data": ""
                    }
                ]
            },
            {
                "buttons": [
                    {
                        "text": "new Button3",
                            "callback_data": ""
                    },
                    {
                        "text": "new Button4",
                            "callback_data": ""
                    }
                ]
            }
        ]
        }
}

Return Parameter

Return Example

{
    "ok": true
}

deleteMessage

Request URL

• https://api.rct2008.com:8443/<bot_token>/deleteMessage

Request Method

• POST

A brief description

• Use this method to delete a message, including service messages, with the following limitations:
• private chats bots can only delete the message sent by itself
• group if bots is an administrator of the group, it can delete any message there. otherwise ,can only delete the message sent by itself. If all members are administrators, bot can only delete messages by itself
• super group or channel if bots is an administrator of the group, it can delete any message there. otherwise, can only delete the message sent by itself.

Request Parameter

Request Example

{
    "chat_type": 1,
    "chat_id": 8000012,
    "message_id": 27315634
}

Return Parameter

Return Example

{
    "ok": true,
    "result": null
}

Available methods

leaveChat

Request URL

• https://api.rct2008.com:8443/<bot_token>/leaveChat

Request Method

• POST

A brief description

• Use this method for your bot to leave a group, supergroup or channel. Returns True on success.

Request Parameter

Request Example

{
    "chat_type": 2,
    "chat_id": 8000012
}

Return Parameter

Return Example

{
    "ok": true
}

getChat

Request URL

• https://api.rct2008.com:8443/<bot_token>/getChat

Request Method

• POST

A brief description

• Use this method to get up to date information about the chat (current name of the user for one-on-one conversations, current username of a user, group or channel, etc.). Returns a Chat object on success.

Request Parameter

Request Example

{
    "chat_type": 2,
    "chat_id": 8000012
}

Return Parameter

Return Example

{
    "ok": true,
    "result": {
        "id": 11190291,
        "type": 2,
        "title": "grpnaga"
    }
}

getChatMembersCount

Request URL

• https://api.rct2008.com:8443/<bot_token>/getChatMembersCount

Request Method

• POST

A brief description

• Use this method to get the number of members in a chat. Returns Int on success.

Request Parameter

Request Example

{
    "chat_type": 2,
    "chat_id": 8000012
}

Return Parameter

Return Example

{
    "ok": true,
    "result": {
        "count": 4
    }
}

getChatAdministrators

Request URL

• https://api.rct2008.com:8443/<bot_token>/getChatAdministrators

Request Method

• POST

A brief description

• Use this method to get a list of administrators in a chat. On success, returns an Array of ChatMember objects that contains information about all chat administrators. If the chat is a group or a supergroup and no administrators were appointed, only the creator will be returned.

Request Parameter

Request Example

{
    "chat_type": 3,
    "chat_id": 8000012
}

Return Parameter

Return Example

{
    "ok": true,
    "result": [
        {
            "user": {
                "id": 20239276,
                "first_name": "ray",
                "last_name": "ray",
                "username": ""
            },
            "status": "creator"
        },
        {
            "user": {
                "id": 10100091,
                "first_name": "ABCD",
                "last_name": "",
                "username": "ABCD"
            },
            "status": "administrator",
            "can_change_info": true,
            "can_post_messages": true,
            "can_edit_messages": true,
            "can_delete_messages": true,
            "can_invite_users": true,
            "can_restrict_members": true,
            "can_pin_messages": true,
            "can_promote_members": true
        }
    ]
}

setChatTitle

Request URL

• https://api.rct2008.com:8443/<bot_token>/setChatTitle

A brief description

• Use this method to change the title of a chat. Titles can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns True on success.
• Note: In regular groups (non-supergroups), this method will only work if the 'All Members Are Admins' setting is off in the target group.

Request Method

• POST

Request Parameter

Request Example

{
    "chat_type": 2,
    "chat_id": 8000012,
    "title": "plane"
}

Return Parameter

Return Example

{
    "ok": true
}

setChatDescription

Request URL

• https://api.rct2008.com:8443/<bot_token>/setChatDescription

Request Method

• POST

A brief description

• Use this method to change the description of a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns True on success.

Request Parameter

Request Example

{
    "chat_type": 2,
    "chat_id": 8000012,
    "description": "plane"
}

Return Parameter

Return Example

{
    "ok": true
}

setJoinGroups

Request URL

• https://api.rct2008.com:8443/<bot_token>/setJoinGroups

Request Method

• POST

A brief description

• Use this method to set the personal robot is allowed to be added to the group.

Request Parameter

Request Example

{
	"enable":true
}

Return Parameter

Return Example

{
    "ok": true
}

pinChatMessage

Request URL

• https://api.rct2008.com:8443/<bot_token>/pinChatMessage

Request Method

• POST

A brief description

• Use this method to pin a message in a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' admin right in the supergroup or 'can_edit_messages' admin right in the channel. Returns True on success.

Request Parameter

Request Example

{
    "chat_type": 3,
    "chat_id": 8000012,
    "message_id": 6234,
    "disable_notification": false
}

Return Parameter

Return Example

{
    "ok": true
}

unpinChatMessage

Request URL

• https://api.rct2008.com:8443/<bot_token>/unpinChatMessage

Request Method

• POST

A brief description

• Use this method to unpin a message in a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' admin right in the supergroup or 'can_edit_messages' admin right in the channel. Returns True on success.

Request Parameter

Request Example

{
    "chat_type": 3,
    "chat_id": 8000012
}

Return Parameter

Return Example

{
    "ok": true
}

kickChatMember

Request URL

• https://api.rct2008.com:8443/<bot_token>/kickChatMember

Request Method

• POST

A brief description

• Use this method to kick a user from a group, a supergroup or a channel. In the case of supergroups and channels, the user will not be able to return to the group on their own using invite links, etc., unless unbanned first. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns True on success.
• In regular groups (non-supergroups), this method will only work if the 'All Members Are Admins' setting is off in the target group. Otherwise members may only be removed by the group's creator or by the member that added them.

Request Parameter

Request Example

{
    "chat_type": 3,
    "chat_id": 8000012,
    "user_id": 80000001
}

Return Parameter

Return Example

{
    "ok": true
}

kickNotBan

Request URL

• https://api.rct2008.com:8443/<bot_token>/kickNotBan

Request Method

• POST

A brief description

• Use this method to kick a user from a group, a supergroup or a channel but will be able to join via link, etc. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns True on success.

Request Parameter

Request Example

{
    "chat_type": 3,
    "chat_id": 8000012,
    "user_id": 80000001
}

Return Parameter

Return Example

{
    "ok": true
}

sendChatAction

Request URL

• https://api.rct2008.com:8443/<bot_token>/sendChatAction

Request Method

• POST

A brief description

• use this method when you need to tell the user that something is happening on the bot's side. The status is set for 5 seconds or less (when a message arrives from your bot, Potato clients clear its typing status). Returns True on success.
• Example: The StickerBot needs some time to process a request and upload the image. Instead of sending a text message along the lines of "Retrieving image, please wait…", the bot may use sendChatAction with action = upload_photo. The user will see a "sending photo" status for the bot.
• We only recommend using this method when a response from the bot will take a noticeable amount of time to arrive.

Request Parameter

Request Example

{
    "chat_type": 2,
    "chat_id": 8000012,
    "action":"upload_document"
}

Return Parameter

Return Example

{
    "ok": true
}

getGroups

Request URL

• https://api.rct2008.com:8443/<bot_token>/getGroups

Request Method

• GET

A brief description

• Get groups/supergroups/channels where bot staying

Return Parameter

Return Example

getGroupBlackList

Request URL

• https://api.sydney.im:8443/<bot_token>/getGroupBlackList

Request Method

• POST

A brief description

• Use this method to get a list of banned users in a supergroup. On success, returns an array of banned User. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights.

Request Parameter

Request Example

   
{
    "chat_id": 11241496
}

Return Parameter

Return Example

   
{
    "ok": true,
    "result": [
        {
            "user": {
                "id": 20241232,
                "first_name": "James",
                "last_name": "",
                "username": "james"
            },
            "kicked_by": 11240103
        }
    ]
}

editGroupBlackList

Request URL

• https://api.sydney.im:8443/<bot_token>/editGroupBlackList

Request Method

• POST

A brief description

• Use this method to manage blacklist from a supergroup. Bot can ban a user or unban a user.The user will not be able to return to the group on their own using invite links, etc. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns True on success.

Request Parameter

Request Example

   
{
    "action": 1,
    "chat_id": 11241496,
    "user_id": 20241232
}

Return Parameter

Return Example

   
{
    "ok": true
}

lipBlock

Request URL

• https://api.sydney.im:8443/<bot_token>/lipBlock

Request Method

• POST

A brief description

• Use this method to disable some user send messages from a supergroup. The user will not be able to send any messages to the group on their own using invite links. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns True on success.

Request Parameter

Request Example

   
{
    "group_id": 11241496,
    "user_id": 20241232
}

Return Parameter

Return Example

   
{
    "ok": true
}

lipUnBlock

Request URL

• https://api.sydney.im:8443/<bot_token>/lipUnBlock

Request Method

• POST

A brief description

• Use this method to enable some user send messages from a supergroup. If someone was lip blocked by group administrator can use this method to lift a ban. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns True on success.

Request Parameter

Request Example

   
{
    "group_id": 11241496,
    "user_id": 20241232
}

Return Parameter

Return Example

{
    "ok": true
}

{
    "user_id":20216682
}

{
    "ok": true,
    "result": [
        {
            "file_id": "00b00224aba34dcc825e7cdaa70003dc",
            "file_size": 22191,
            "width": 160,
            "height": 160
        },
        {
            "file_id": "00b00224aba3c6cd825ee2daa700d1dc",
            "file_size": 75297,
            "width": 320,
            "height": 320
        },
        {
            "file_id": "00b00224aba31dce825e68daa700d8dc",
            "file_size": 249302,
            "width": 640,
            "height": 640
        },
        {
            "file_id": "00b00224aba316cf825e00daa7001edc",
            "file_size": 385720,
            "width": 820,
            "height": 820
        }
    ]
}

{
    "chat_id":11241950,
    "user_id":20241232,
    "permissions" : {
        "can_send_messages":true,
        "can_send_media_messages":false,
        "can_add_web_page_previews":true
    },
    "until_date":1737281111
}

{
    "ok": true
}

{
    "chat_id":11241950,
    "user_id":20241232,
    "can_change_info":true,
    "can_post_messages":true,
    "can_edit_messages":true,
    "can_delete_messages":true,
    "can_invite_users":true,
    "can_restrict_members":true,
    "can_pin_messages":true,
    "can_promote_members":true
}

{
    "ok": true
}

{
    "ok": true,
    "result": {
        "Groups": [
            {
                "PeerID": 12345671,
                "PeerName": "group"
            }
        ],
        "SuperGroups": [
            {
                "PeerID": 12345672,
                "PeerName": "supergroup"
            }
        ],
        "Channels": [
            {
                "PeerID": 12345673,
                "PeerName": "channel"
            }
        ]
    }
}

Game

Description

• A game message will also display high scores for the current chat. Use setGameScore to post high scores to the chat with the game, add the edit_message parameter to automatically update the message with the current scoreboard.

• Use getGameHighScores to get data for in-game high score tables.

• For examples of what can be done using this new stuff, check the @app.

setGameScore

Request URL

• https://api.rct2008.com:8443/<bot_token>/setGameScore

Request Method

• POST

A brief description

• Use this method to set the score of the specified user in a game. On success, if the message was sent by the bot, returns the edited Message, otherwise returns True. Returns an error, if the new score is not greater than the user's current score in the chat and force is False.

Request Parameter

Request Example

{
	"message_id":204,
	"user_id":22800001,
	"chat_type":1,
	"chat_id":22800001,
	"bot_id":10006000,
	"score":70
}

Return Parameter

Return Example

{
    "ok": true,
    "result": {
        "message_id": 27315
    }
}

getGameHighScores

Request URL

• https://api.rct2008.com:8443/<bot_token>/getGameHighScores

Request Method

• POST

A brief description

• Use this method to get data for high score tables. Will return the score of the specified user and several of his neighbors in a game. On success, returns an Array of GameHighScore objects.

Request Parameter

Request Example

{
	"message_id":204,
	"user_id":22800001,
	"chat_type":3,
	"chat_id":10856320,
	"bot_id":10060216,
	"score":70
}

Return Parameter

Return Example

{
    "ok": true,
    "result": {
        "message_id": 27315
    }
}

Inline mode

• The following methods and objects allow your bot to work in inline mode.

• Please see our Introduction to Inline bots for more details.

• To enable this option, send the /setinline command to @BotFather and provide the placeholder text that the user will see in the input field after typing your bot's name.

InlineQuery

A brief description

• This object represents an incoming inline query. When the user sends an empty query, your bot could return some default or trending results.

answerInlineQuery

Request URL

• https://api.rct2008.com:8443/<bot_token>/answerInlineQuery

Request Method

• POST

A brief description

• Use this method to send answers to an inline query. On success, True is returned.
  No more than 50 results per query are allowed.

Request Parameter

InlineQueryResult

A brief description

This object represents one result of an inline query. Potato clients currently support results of the following 5 types:

• InlineQueryResultArticle

• InlineQueryResultWebsite

• InlineQueryResultGif

• InlineQueryResultPhoto

• InlineQueryResultVideo

• InlineQueryResultCachedPhoto

InlineQueryResultArticle

A brief description

• Represents a link to an article.

InlineQueryResultWebsite

A brief description

• Represents a link to an web page.

InlineQueryResultGif

A brief description

• Represents a link to an animated GIF file. By default, this animated GIF file will be sent by the user with optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the animation.

InlineQueryResultPhoto

A brief description

• Represents a link to a photo. By default, this photo will be sent by the user with optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the photo.

InlineQueryResultVideo

A brief description

• Represents a link to a page containing an embedded video player or a video file. By default, this video file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the video.
• If an InlineQueryResultVideo message contains an embedded video (e.g., YouTube), you must replace its content using input_message_content.

InputMessageContent

A brief description

This object represents the content of a message to be sent as a result of an inline query. Potato clients currently support the following 1 types:

• InputTextMessageContent

InputTextMessageContent

A brief description

• Represents the content of a text message to be sent as the result of an inline query.

InlineQueryResultCachedPhoto

A brief description

• Represents a link to a photo stored on the Potato servers. By default, this photo will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the photo.

Object Type

Chat Type

• Used to define the type of chat dialog box, the following is the type of Chat object can be used.

Entity Type

• Entity use to define rich text objects chat content, the following are the different type that can be used in the Entity object.

User

• User is use to describe user information.

Sample code

{
    "id": 1000,
    "first_name": "David",
    "last_name": "Smith",
    "username": "username"
}

Chat

• User is use to describe user information.

Sample code

{
    "id": 1000,
    "type": 3,
    "title": "super group"
}

Entity

• Entity used to define rich text objects in chat content, there are currently nine types available, the specific reference Entity type.

ReplyMarkup

• There are 4 types of ReplyMarkup: ForceReplyType, ReplyKeyboardMarkupType, ReplyKeyboardRemoveType and InlineKeyboardMarkup. Each have different functions (please refer to the ReplyMarkup Types tables below)

ForceReply

• Used to depict the reply interface, achieving the same effect of selecting the chat bot and then selecting "Reply".

ReplyKeyboardMarkup

• Used to depict replying to (with reply options) custom keyboard.

ReplyKeyboardRemove

• Used to depict the deletion/clearing of custom keyboard. When a message with an object is received, the Potato client will delete the previous custom keyboard and display the default keyboard, until the chatbot sends a new keyboard.

InlineKeyboardMarkup

• Used to depict the inline keyboard displayed in the chat message.

Button

ReplyMarkup Type

• The following is a list of the type of enumeration that can be used when customizing the reply message ReplyMarkup.

KeyboardButtonRow

• A row of custom buttons describing the user's keyboard.

KeyboardButton

• Used to describe custom buttons on the user's keyboard. Optional fields are mutually exclusive.

InlineKeyboardButtonRow

• A row of custom buttons for describing chat content.

InlineKeyboardButton

• User Description Inline keyboard, that is, a custom keyboard in the chat content, optional fields can only be filled in, otherwise only the first one will take effect.

Location

Venue

PhotoSize

Audio

Document

Video

Voice

Contact

MessageAction

CallbackQuery

Message

Update

ChatMember

ChatPermissions

• Describes actions that a non-administrator user is allowed to take in a chat.

Rich Text Support

Introduction to formatting

• Using similar MarkDown languages, you can easily generate entities object list according to the Potato message

Italics

• Enter the text to be defined with italics between 1 asterisk "*" or underscore "_":

*this is italics* _this is italics_

Bold

• Enter the text to be defined with bold between 2 asterisks "*" or underscores "_":

**This is bold font** __This is also bold font__

Italics and Bold

• Enter the text to be defined with bold and italics between 3 asterisks "*" or underscores "_":

***italics and bold*** ___italics and bold___

Code Marking

• In order to mark a small line of code, you can highlight the code between back quotation marks, for example:

`printf("Hello World!");`

Text Link

• Enter text links to be defined between the <> brackets:

<https://www.google.com/>

Email Link

• Enter email address to be defined between the <> brackets:

<username@mail.com>

Hyper Link

• Insert website URL in brackets behind the square brackets:

[https://www.google.com/](https://www.google.com/) [Tap here to open Google website](https://www.google.com/)

Chatbot Commands

• Insert String "cmd" in brackets behind the square brackets:

[/new_bot](cmd)

Mentions

• Insert String "@" in brackets behind the square brackets:

[@username](@)

Mentioned Users

• Insert String "mention_name" in brackets behind the square brackets, then insert user_id or @user_id behind:

[@username](@ 100500)

Error Code