mir/node-telegram-bot-api
2
0
Fork 0
mirror of https://github.com/yagop/node-telegram-bot-api synced 2025-08-28 21:07:39 +00:00
Code Issues Releases Wiki Activity

Generated README

Browse Source
This commit is contained in:
yago 2015-07-07 22:11:54 +02:00
parent 3ed643fd24
commit 1e60498207
1 changed files with 26 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
README.md
View File

@ -52,11 +52,13 @@ Returns basic information about the bot in form of a `User` object.
## setWebHook(url)
Specify a url to receive incoming updates via an outgoing webHook.
Specify an url to receive incoming updates via an outgoing webHook.
See: https://core.telegram.org/bots/api#setwebhook
### Params:
* **String** *url* URL
* **String** *url* URL where Telegram will make HTTP Post. Leave empty to delete webHook.
## getUpdates([timeout], [limit], [offset])
@ -136,17 +138,36 @@ See: https://core.telegram.org/bots/api#sendaudio
* **Promise**
## sendDocument(chatId, A, [options])
Send Document
See: https://core.telegram.org/bots/api#sendDocument
### Params:
* **Number|String** *chatId* Unique identifier for the message recipient
* **String|stream.Stream** *A* file path or a Stream. Can also be a `file_id` previously uploaded.
* **Object** *[options]* Additional Telegram query options
### Return:
* **Promise**
## sendChatAction(chatId, action)
Send chat action. Type of `action` to broadcast. `typing` for text messages, `upload_photo` for photos, `record_video` or `upload_video` for videos, `record_audio` or `upload_audio` for audio files, `upload_document` for general files, `find_location` for location data.
Send chat action.
`typing` for text messages,
`upload_photo` for photos, `record_video` or `upload_video` for videos,
`record_audio` or `upload_audio` for audio files, `upload_document` for general files,
`find_location` for location data.
See: https://core.telegram.org/bots/api#sendchataction
### Params:
* **Number|String** *chatId* Unique identifier for the message recipient
* **String** *action* Type of action to broadcast.
* **String** *action* Type of action to broadcast.
### Return: