Messages sent by users are delivered to the API (bot) through the message event. This event includes the complete message object as defined below, allowing the API to process and respond accordingly.

Get Started

QUICK START

AUTHENTICATION

ERROR HANDLING

Media Object

Uploading Media Files

Downloading Media Files

MEDIA

My Profile

getMyProfiles

setMyProfile

MY PROFILE

Chat Object

ChatTags Object

getChat

setChat

Chat

chatMember Object

getChatMember

banChatMember

unbanChatMember

removeChatMember

Chat Member

chatAdministrators Object

getChatAdministrators

Chat Admins

setChatMenu

Keypad Menu

Inline Menu

menuCallback — Read Keypad Menu

Chat Menu

CHATS

Message Object

Incoming Messages (Applies to All Messages)

sendText

sendPhoto

sendVideo

sendAudio

sendVoice

sendDocument

Location

Contact

Inline Menu (Applies to All Outgoing Messages)

Message Acknowledgment & Status Tracking Overview

Outgoing Messages

updateMessage

recallMessage

Message Management (Applies to All Messages)

MESSAGES

userJoinedBot

userStoppedBot

userStartedBot

userLeftBot

Incoming Message

menuCallback  — Read inline and Chat Menus

CHATBOT EVENTS

User Object

getUser

USERS

Options

Actions

Cell Query

Text Alignment

Cell

menuCallback

MENUS

PATTERN OBJECT

SIGNUP OBJECT

WHITELIST PATTERNS

USER WHITELIST

WHITELIST MANAGEMENT

BLACKLIST PATTERNS

USER BLACKLIST

BLACKLIST MANAGEMENT

SIGNUP MANAGEMENT

Collection Object

listCollections

getCollectionProduct

Collection - Define groups of products for display

Product - Event and Booking

getProductItem

Product -Manage item-level details, pricing, and inventory

COMMERCE - PRODUCT, BOOKING, EVENT

Component Object

updateMenuCell — Write to Component Cells

menuCallback — Read User Input

CUSTOM COMPONENT — FORMS AND WORKFLOW

Source Code

GET STARTED