Skip to content

LINE Notify API Node

Jump to bottom
Jatu Tung edited this page Jan 15, 2023 · 50 revisions

notify-node

NODE-RED node for publish message notification to LINE Notify. You can use LINE notify API through this Node, include uploading image file.

Three types of messages can be sent.

  1. Text
  2. Images
  3. Sticker

Two modes of usage node can be set.

  1. Manual input data
  2. Use data from flow

Initial usage

  1. Create and obtain an Access Token at LINE Notify official website.

  2. Add LINE Notify Node in Node-RED workspace.

Node settings

Configure nodes before use.

  1. Setup Access Token at LINE Notify API Node.

Access token

  1. Determined that user doesn't receive or receives Push Notification at LINE Notify when the message is sent.

push notification

  • Check : user doesn't receive Push Notification
  • Uncheck : user receives Push Notification
  1. Choose usage data from flow or manual input data.

select mode

  • Uncheck : Use data from manual input (default)
  • Check : Use data from flow
  1. Node settings

notify-useexternal

  • Use/Don't use external data. If use external data, it does not use data from Node Input.

notify-use-push

  • Disabled Push Notification, the user does/doesn't receive push notification when the message is sent.
  1. Don't use external data case, it use data from input below.

notify-message-tab

  • Message. Notification message.

notify-image

  • Not use. Not use image with LINE Notify.

  • Image URL. Use image URL with LINE Notify.

    • Fullsize URL. Image URL of full size image. Maximum size of 2048×2048px JPEG

    • Thumbnail URL. Image URL of thumbnail image. Maximum size of 240×240px JPEG

  • Upload Image. Use upload a image file to the LINE server. Should be an absolute path to upload image file, e.g. C:\folder\image.jpg
    Remark : Support .png and .jpg

notify-sticker

  • Use/Don't use Sticker. Use or don't use sticker with LINE Notify..

    • Package ID. LINE Package Id of sticker Id

    • Sticker ID. LINE Sticker Id

  1. Run workflow

  2. Check result.

API Input

When setup node values to 'Use external data', it uses msg object instead node input.

Property Mandatory Type Description
payload Yes string Notification message. 1000 characters max.
useImageUrl No (If not send, automated set to false) boolean true : Use image URL with LINE Notify. Additional imageFullsizeUrl and imageThumbnailUrl must be specified.
false : Not use image URL with LINE Notify.
imageFullsizeUrl No (Yes, if useImageUrl is true) string Image URL. Maximum size of 2048×2048px JPEG.
imageThumbnailUrl No (Yes, if useImageUrl is true) string Image URL. Maximum size of 240×240px JPEG.
useImageFile No (If not send, automated set to false) boolean true : Upload a image file to the LINE server. Additional imageFile must be specified.
false : Not upload a image file to the LINE server.
imageFile No (Yes, if useImageFile is true) string Should be an absolute path to upload image file, e.g. C:\folder\image.jpg (Support .png and .jpg)
If you specified all imageFullsizeUrl, imageThumbnailUrl and imageFile. The imageFile takes precedence. See more detail at LINE Notify API Document
useSticker No (If not send, automated set to false) boolean true : Use sticker with LINE Notify. Additional stickerPackageId and stickerId must be specified.
false : Not use sticker with LINE Notify.
stickerId No (Yes, if useSticker is true) number LINE Sticker Id. See more details at LINE List of available stickers
stickerPackageId No (Yes, if useSticker is true) number LINE Package Id of sticker Id. See more details at LINE List of available stickers

API Output

Using msg object.

Property Type Description
status number Result status code
payload string Result status message

Examples

After install package, see usage examples at Node-RED Import menu at node-red-contrib-node-line-api, then line-notify-examples.

More details

Clone this wiki locally