GramIO API Reference / @gramio/init-data/dist / WebAppInitData
Interface: WebAppInitData
Defined in: init-data/index.d.ts:85
This object contains data that is transferred to the Mini App when it is opened. It is empty if the Mini App was launched from a keyboard button or from inline mode.
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
auth_date | number | Unix time when the form was opened. | init-data/index.d.ts:129 |
can_send_after? | number | Time in seconds, after which a message can be sent via the answerWebAppQuery method. | init-data/index.d.ts:125 |
chat? | WebAppChat | An object containing data about the chat where the bot was launched via the attachment menu. Returned for supergroups, channels and group chats – only for Mini Apps launched via the attachment menu. | init-data/index.d.ts:106 |
chat_instance? | string | A global identifier indicating the chat from which Mini App was opened. Returned only for applications opened by direct link. | init-data/index.d.ts:115 |
chat_type? | WebAppChatType | Type of the chat from which the Mini App was opened. | init-data/index.d.ts:110 |
hash | string | A hash of all passed parameters, which the bot server can use to check their validity. | init-data/index.d.ts:134 |
query_id? | string | A unique identifier for the Mini App session, required for sending messages via the answerWebAppQuery method. | init-data/index.d.ts:90 |
receiver? | WebAppUser<true> | An object containing data about the chat partner of the current user in the chat where the bot was launched via the attachment menu. Returned only for private chats and only for Mini Apps launched via the attachment menu. | init-data/index.d.ts:101 |
start_param? | string | The value of the startattach parameter, passed via link. Only returned for Mini Apps when launched from the attachment menu via link. The value of the start_param parameter will also be passed in the GET-parameter tgWebAppStartParam, so the Mini App can load the correct interface right away. | init-data/index.d.ts:121 |
user? | WebAppUser | An object containing data about the current user. | init-data/index.d.ts:94 |