Every method your API can send, and every event it can receive, on one page.

💡 How to read this

Outgoing methods are requests your API sends to the server. Inbound events are messages the server sends to your API — you receive them by implementing the matching callback.

A ✅ means the SDK exposes a helper for it. A — means it is not available in that SDK.

Outgoing methods — API → Server

Messages

Method	Purpose	Java	JavaScript	Python
`sendMessage`	Send a text message	✅	✅	✅
`sendPhoto`	Send a photo	✅	✅	✅
`sendVideo`	Send a video	✅	✅	✅
`sendAudio`	Send an audio file	✅	✅	✅
`sendVoice`	Send a voice note	✅	✅	✅
`sendDocument`	Send a document	✅	✅	✅
`sendContact`	Send a contact card	✅	✅	✅
`sendLocation`	Send a location	✅	✅	✅
`sendArticle`	Send an article	✅	✅	✅
`updateMessage`	Edit a sent message or its caption	✅	✅	✅
`recallMessage`	Recall a sent message	✅	✅	✅

Chats

Method	Purpose	Java	JavaScript	Python
`getChat`	Retrieve chat details	✅	✅	✅
`setChat`	Update chat details	✅	✅	✅
`createChat`	Create a new chat	✅	✅	✅
`getChatMember`	Retrieve a member of a chat	✅	✅	✅
`getChatAdministrators`	List chat administrators	✅	✅	✅
`addChatMember`	Add a member to a chat	✅	✅	✅
`addChatAdmin`	Promote a member to administrator	✅	✅	✅
`banChatMember`	Ban a member	✅	✅	✅
`unbanChatMember`	Lift a ban	✅	✅	✅
`removeChatMember`	Remove a member	✅	✅	✅

Profile & users

Method	Purpose	Java	JavaScript	Python
`getUser`	Retrieve a user's details	✅	✅	✅
`getMyProfiles`	Retrieve the API's own profile	✅	✅	✅
`setMyProfile`	Update the API's own profile	✅	✅	✅
`sendUserNotification`	Send an SMS, Email or Push notification to a user	✅	✅	✅

Menus & workflow

Method	Purpose	Java	JavaScript	Python
`setChatMenu`	Set the chat (keypad) menu	✅	✅	✅
`setNavigationButton`	Set the navigation button	✅	✅	✅
`updateMenuCell`	Write values into component cells	✅	✅	✅
`setWorkflowAction`	Move a user through a workflow screen	✅	✅	✅
`inlineSearchAnswer`	Answer an inline search	✅	✅	✅
`sendCellMessage`	Write text into a component cell (deprecated)	✅	✅	—
`sendCellPhoto`	Write a photo into a component cell (deprecated)	✅	✅	—
`sendCellVideo`	Write a video into a component cell (deprecated)	✅	✅	—

Signup management

Method	Purpose	Java	JavaScript	Python
`getWhitelistUsers`	List whitelisted signups	✅	✅	✅
`addToWhitelist`	Add signups to the whitelist	✅	✅	✅
`removeFromWhitelist`	Remove signups from the whitelist	✅	✅	✅
`addWhitelistPatterns`	Add whitelist patterns	✅	✅	✅
`removeWhitelistPatterns`	Remove whitelist patterns	✅	✅	✅
`getBlacklistUsers`	List blacklisted signups	✅	✅	✅
`addToBlacklist`	Add signups to the blacklist	✅	✅	✅
`removeFromBlacklist`	Remove signups from the blacklist	✅	✅	✅
`addBlacklistPatterns`	Add blacklist patterns	✅	✅	✅
`removeBlacklistPatterns`	Remove blacklist patterns	✅	✅	✅

Commerce

Method	Purpose	Java	JavaScript	Python
`getProductItem`	Retrieve a product	✅	✅	✅
`listCollections`	List collections	✅	✅	✅
`getCollectionProduct`	List products in a collection	✅	✅	✅
`submitPaymentResult`	Report the outcome of an authorized payment	✅	✅	✅

Media & storage

Method	Purpose	Java	JavaScript	Python
`generatePermanentUrl`	Create a permanent URL for a media file	✅	✅	✅
`extensionSetDoc`	Store a document record	✅	✅	✅
`extensionGetDoc`	Retrieve a document record	✅	✅	✅
`extensionListDoc`	List document records	✅	✅	✅
`extensionDeleteDoc`	Delete a document record	✅	✅	✅

Inbound events — Server → API

Implement the matching callback to receive these.

Connection

Event	Fires when	Java	JavaScript	Python
`TOKEN_AUTH_OK`	Authentication succeeded	`onConnect`	`onConnect`	`on_connect`

Messages

Event	Fires when	Java	JavaScript	Python
`message`	A message is received	`onReceive`	`onReceive`	`on_receive`
`scheduledMessage`	A scheduled message is received	`onScheduleMessage`	`onScheduleMessage`	`on_schedule_message`
`messageAck`	A sent message is acknowledged	`onMessagAckCallback`	`onMessagAckCallback`	`on_message_ack_callback`

Chatbot events

Event	Fires when	Java	JavaScript	Python
`userJoinedBot`	A user joins the API	`onUserJoinedBot`	`onUserJoinedBot`	`on_user_joined_bot`
`userStartedBot`	A user starts the API	`userStartedBot`	`userStartedBot`	`user_started_bot`
`userStoppedBot`	A user stops the API	`userStoppedBot`	`userStoppedBot`	`user_stopped_bot`
`userLeftBot`	A user leaves the API	`userLeftBot`	`userLeftBot`	`user_left_bot`
`WebhookEvent`	An external system posts to the callback URL	`onWebhookEvent`	`onWebhookEvent`	`on_webhook_event`

Menus

Event	Fires when	Java	JavaScript	Python
`menuCallback`	A user submits any menu	`onMenuCallBack`	`onMenuCallBack`	`on_menu_callback`
`chatMenuCallback`	A user interacts with a chat menu	`onChatMenuCallBack`	`onChatMenuCallBack`	`on_chat_menu_callback`
`inlineMessageCallback`	A user presses an inline menu button	`onInlineMessageCallback`	`onInlineMessageCallback`	`on_inline_message_callback`
`inlineSearch`	A user performs an inline search	`onInlineSearh`	`onInlineSearch`	`on_inline_search`
`workflowCell`	A workflow cell is returned	`onWorkflowDetails`	`onWorkflowDetails`	`on_workflow_details`

Chats & users

Event	Fires when	Java	JavaScript	Python
`chatDetails`	Response to `getChat` / `setChat`	`onChatDetails`	`onChatDetails`	`on_chat_details`
`chatMember`	Response to member operations	`onChatMember`	`onChatMember`	`on_chat_member`
`chatAdministrators`	Response to `getChatAdministrators`	`onChatAdministrators`	`onChatAdministrators`	`on_chat_administrators`
`createChatAck`	Response to `createChat`	`onCreateChat`	`onCreateChat`	`on_create_chat`
`userDetails`	Response to `getUser`	`onUserDetails`	`onUserDetails`	`on_user_details`
`myProfile`	Response to `getMyProfiles` / `setMyProfile`	`onMyProfile`	`onMyProfile`	`on_my_profile`

Signup management

Event	Fires when	Java	JavaScript	Python
`whitelist` · `getWhitelistUsersResponse` · `addToWhitelist_ack`	Whitelist retrieved or added to	`onWhiteList`	`onWhiteList`	`on_white_list`
`removeFromWhitelist_ack`	Signups removed from the whitelist	`onDeleteWhiteList`	`onDeleteWhiteList`	`on_remove_white_list`
`addWhitelistPatterns_ack` · `removeWhitelistPatterns_ack`	Whitelist patterns added or removed	`onWhiteListPattern`	`onWhiteListPattern`	`on_white_list_pattern`
`blacklist` · `addToBlacklist_ack`	Blacklist retrieved or added to	`onBlackList`	`onBlackList`	`on_black_list`
`removeFromBlacklist_ack`	Signups removed from the blacklist	`onDeleteBlackList`	`onDeleteBlackList`	`on_remove_black_list`
`addBlacklistPatterns_ack` · `removeBlacklistPatterns_ack`	Blacklist patterns added or removed	`onBlackListPattern`	`onBlackListPattern`	`on_black_list_pattern`

⚠️ getBlacklistUsers is answered with the blacklist method, not getBlacklistUsersResponse. The whitelist equivalent does use getWhitelistUsersResponse.

Commerce

Event	Fires when	Java	JavaScript	Python
`getProductItemResponse`	Response to `getProductItem`	`onProductDetail`	`onProductDetail`	`on_product_detail`
`listCollectionsResponse`	Response to `listCollections`	`listCollectionItemResponse`	`listCollectionItemResponse`	`on_collection_item`
`getCollectionProductResponse`	Response to `getCollectionProduct`	`onCollectionProduct`	`onCollectionProduct`	`on_collection_product`
`paymentAuthorizationRequest`	A payment needs authorizing by your API	`onPaymentAuthorizationRequest`	`onPaymentAuthorizationRequest`	`on_payment_authorization_request`

Media & storage

Event	Fires when	Java	JavaScript	Python
`permanentUrl`	Response to `generatePermanentUrl`	`permanentUrl`	`permanentUrl`	`permanent_url`
`extensionSetDocResponse` · `extensionGetDocResponse` · `extensionListDocResponse` · `extensionDeleteDocResponse`	Response to an extension document operation	`onExtensionDocResponse`	`onExtensionDocResponse`	`on_extension_doc_response`

API REFERENCE — ALL METHODS & CALLBACKS

Outgoing methods — API → Server

Messages

Chats

Profile & users

Menus & workflow

Signup management

Commerce

Media & storage

Inbound events — Server → API

Connection

Messages

Chatbot events

Menus

Chats & users

Signup management

Commerce

Media & storage