tg-yarl

tg-yarl

A simple Promise based wrapper over Telegram Bot API with additional features.

npm install tg-yarl

const api = require('tg-yarl')('YOUR_TELEGRAM_BOT_TOKEN');

api.setWebhook('https://example.com/bot', './certificate.pem');
api.getMe().then(res => console.log(res.body));

api
  .sendPhoto('chatId', './anonim.jpg', {caption: 'Anonymous'})
  .then(res => console.log(res.body));

Methods

All methods return a Promise.

getMe()

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

setWebHook([url], [certificate])

Specify an url to receive incoming updates via an outgoing webhook.

To use a self-signed certificate, you need to upload your public key certificate using certificate parameter.

Params:

• [url] (String) - HTTPS url to send updates to. Use an empty string to remove webhook integration.
• [certificate] (String|Object) - Object with file path, Stream or Buffer. See InputFile object for more info.

getUpdates([offset], [limit], [timeout])

Use this method to receive incoming updates using long polling.

Params:

• offset (Integer) - Identifier of the first update to be returned.
• limit (Integer) - Limits the number of updates to be retrieved.
• timeout (Integer) - Timeout in seconds for long polling.

sendMessage(chatId, text, [options])

Send text message.

Params:

• chatId (Integer|String) - Unique identifier for the target chat or username of the target channel (in the format @channelusername)
• text (String) - Text of the message to be sent.
• [options] (Object) - Message options:
  • parse_mode (String) - Send Markdown, if you want Telegram apps to show bold, italic and inline URLs in your bot's message.
  • disable_web_page_preview (Boolean) - Disables link previews for links in this message.
  • reply_to_message_id (Integer) - If the message is a reply, ID of the original message.
  • reply_markup - Additional interface options.

forwardMessage(chatId, fromChatId, messageId)

Forward messages of any kind.

Params:

• chatId (Integer|String) - Unique identifier for the target chat or username of the target channel (in the format @channelusername)
• fromChatId (Integer|String) - Unique identifier for the chat where the original message was sent (or channel username in the format @channelusername)
• messageId (Integer) - Unique message identifier.

sendPhoto(chatId, photo, [options])

Send photo.

Params:

• chatId (Integer|String) - Unique identifier for the target chat or username of the target channel (in the format @channelusername)
• photo (String|Object) - Object with file path, Stream, Buffer or file_id. See InputFile object for more info.
• [options] (Object) - Photo options:
  • caption (String) - Photo caption.
  • reply_to_message_id (Integer) - If the message is a reply, ID of the original message.
  • reply_markup - Additional interface options.

sendAudio(chatId, audio, [options])

Send audio.

Params:

• chatId (Integer|String) - Unique identifier for the target chat or username of the target channel (in the format @channelusername)
• audio (String|Object) - Object with file path, Stream, Buffer or file_id. See InputFile object for more info.
• [options] (Object) - Audio options:
  • duration (Integer) - Duration of sent audio in seconds.
  • performer (String) - Performer of sent audio.
  • title (String) - Title of sent audio.
  • reply_to_message_id (Integer) - If the message is a reply, ID of the original message.
  • reply_markup - Additional interface options.

sendDocument(chatId, document, [options])

Send document.

Params:

• chatId (Integer|String) - Unique identifier for the target chat or username of the target channel (in the format @channelusername)
• document (String|Object) - Object with file path, Stream, Buffer or file_id. See InputFile object for more info.
• [options] (Object) - Document options:
  • reply_to_message_id (Integer) - If the message is a reply, ID of the original message.
  • reply_markup - Additional interface options.

sendSticker(chatId, sticker, [options])

Send .webp stickers.

Params:

• chatId (Integer|String) - Unique identifier for the target chat or username of the target channel (in the format @channelusername)
• sticker (String|Object) - Object with file path, Stream, Buffer or file_id. See InputFile object for more info.
• [options] (Object) - Sticker options:
  • reply_to_message_id (Integer) - If the message is a reply, ID of the original message.
  • reply_markup - Additional interface options.

sendVideo(chatId, video, [options])

Send video.

Params:

• chatId (Integer|String) - Unique identifier for the target chat or username of the target channel (in the format @channelusername)
• video (String|Object) - Object with file path, Stream, Buffer or file_id. See InputFile object for more info.
• [options] (Object) - Video options:
  • duration (Integer) - Duration of sent video in seconds.
  • caption (String) - Video caption.
  • reply_to_message_id (Integer) - If the message is a reply, ID of the original message.
  • reply_markup - Additional interface options.

sendVoice(chatId, voice, [options])

Send voice.

Params:

• chatId (Integer|String) - Unique identifier for the target chat or username of the target channel (in the format @channelusername)
• voice (String|Object) - Object with file path, Stream, Buffer or file_id. See InputFile object for more info.
• [options] (Object) - Voice options:
  • duration (Integer) - Duration of sent video in seconds.
  • reply_to_message_id (Integer) - If the message is a reply, ID of the original message.
  • reply_markup - Additional interface options.

sendLocation(chatId, latitude, longitude, [options])

Send location.

Params:

• chatId (Integer|String) - Unique identifier for the target chat or username of the target channel (in the format @channelusername)
• latitude (Float) - Latitude of location.
• longitude (Float) - Longitude of location.
• [options] (Object) - Location options:
  • reply_to_message_id (Integer) - If the message is a reply, ID of the original message.
  • reply_markup - Additional interface options.

sendChatAction(chatId, action)

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.

Params:

• chatId (Integer|String) - Unique identifier for the target chat or username of the target channel (in the format @channelusername)
• action (String) - Type of action to broadcast.

getUserProfilePhotos(userId, [offset], [limit])

Use this method to get a list of profile pictures for a user.

Params:

• userId (Integer) - Unique identifier of the target user.
• [offset] (Integer) - Sequential number of the first photo to be returned. By default, all photos are returned.
• [limit] (Integer) - Limits the number of photos to be retrieved. Values between 1—100 are accepted. Defaults to 100.

getFile(file_id)

Use this method to get basic info about a file and prepare it for downloading.

Params:

• file_id (String) - File identifier to get info about.

answerInlineQuery(inline_query_id, results, [options])

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

Params:

• inline_query_id (String) - Unique identifier for the answered query.
• results (Array of InlineQueryResult) - A JSON-serialized array of results for the inline query.
• [options] (Object) - Inline Query options:
  • cache_time (Integer) - The maximum amount of time in seconds that the result of the inline query may be cached on the server. Defaults to 300.
  • is_personal (Boolean) - Pass True, if results may be cached on the server side only for the user that sent the query. By default, results may be returned to any user who sends the same query.
  • next_offset (String) - Pass the offset that a client should send in the next query with the same text to receive more results. Pass an empty string if there are no more results or if you don‘t support pagination. Offset length can’t exceed 64 bytes.

Extra

downloadFile(file_id, path)

Download file to specified path.

Params:

• file_id (String) - File identifier to get info about.
• path (String|WritableStream) - File will be written to specified WritableStream or new WritableStream will be created with specified path.

api.downloadFile('AgADAgADjagxGxAR6gbMzfh8LDtkU-9GhCoABOmH973MjLOBq7sAAgI', './file.jpg');

setKeyboard(keyboard, [resize], [once], [selective])

Custom keyboard.

Params:

• keyboard (Array of Array of Strings) - Array of button rows, each represented by an Array of Strings.
• [resize] (Boolean) - Requests clients to resize the keyboard vertically for optimal fit.
• [once] (Boolean) - Requests clients to hide the keyboard as soon as it's been used.
• [selective] (Boolean) - Use this parameter if you want to show the keyboard to specific users only.

Note: This method is chainable.

setKeyboard([hide_keyboard], [selective])

If you just want to hide the keyboard, then do this:

api.setKeyboard().sendMessage('chatId', 'Text');
//or
api.setKeyboard(true);
api.sendMessage('chatId', 'Text');

If you want to hide the keyboard to specific users only, then do this:

api.setKeyboard(true, true).sendMessage('chatId', 'Text');
//or
api.setKeyboard(true, true);
api.sendMessage('chatId', 'Text');

Params:

• [hide_keyboard] (True)- Requests clients to hide the custom keyboard.
• [selective] (Boolean) - Use this parameter if you want to show the keyboard to specific users only.

Note: This method is chainable.

InputFile object

For path, file_id, Buffer and local Stream just pass into variable:

var inputFile = './file.png'; //path
//or
var inputFile = 'AgADAgADjagxGxAR6gbMzfh8LDtkU-9GhCoABOmH973MjLOBq7sAAgI'; //file_id
//or
var inputFile = new Buffer(); //Buffer
//or
var inputFile = require('fs').createReadStream('./file.png'); //local Stream

api.sendPhoto('chatId', inputFile);

For remote Stream:

var inputFile = {
  value: require('https').request('https://avatars1.githubusercontent.com/u/2401029'),
  filename: 'image.jpg'
};

api.sendPhoto('chatId', inputFile);

License

The MIT License (MIT)
Copyright (c) 2015-2016 Alexey Bystrov