-
Notifications
You must be signed in to change notification settings - Fork 0
LINE Notify API 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.
- Text
- Images
- Sticker
Two modes of usage node can be set.
- Manual input data
- Use data from flow
-
Create and obtain an Access Token at LINE Notify official website.
-
Add LINE Notify Node in Node-RED workspace.
Configure nodes before use.
- Setup Access Token at LINE Notify API Node.
- Determined that user doesn't receive or receives Push Notification at LINE Notify when the message is sent.
- Check : user doesn't receive Push Notification
- Uncheck : user receives Push Notification
- Choose usage data from flow or manual input data.
- Check : Use data from flow
- Uncheck : Use data from manual input (default)
Default mode. Using data from manual input for publish message to LINE Notify.
Inputs | Mandatory | Type | Description |
---|---|---|---|
Message | Yes | string |
message to publish. 1000 characters max |
Addtional emoji picker for text message tab.
Inputs | Mandatory | Type | Description |
---|---|---|---|
Fullsize URL | Yes (if choose Image URL option) | string |
image fullsize URL to publish. Maximum size of 2048×2048px JPEG |
Fullsize URL | Yes (if choose Image URL option) | string |
image thumbnail URL to publish. Maximum size of 240×240px JPEG |
Upload Image | Yes (if choose Upload Image option) | string |
image to upload. Should be an absolute path to upload image file, e.g. C:\folder\image.jpg (Support .png and .jpg) |
Remark : Inputs 'Not use', 'Image URL' and 'Upload Image' have only one option able to use. So if choose one option, then other options have been cancelled.
Inputs | Mandatory | Type | Description |
---|---|---|---|
Use Sticker | Yes | boolean |
specify true/false to publish sticker to LINE Notify. |
Package ID | Yes (if choose Use Sticker option) | number |
LINE Package Id of sticker Id. |
Sticker ID | Yes (if choose Use Sticker option) | number |
LINE Sticker Id. |
output properties is underneath msg
object.
Property | Type | Description |
---|---|---|
status | number |
standard result status code |
payload | string |
result message |
Property | Type | Description |
---|---|---|
status | number |
standard error code |
payload | string |
standard error message |
Using data from flow for publish message to LINE Notify
msg
object is main used for this LINE Notify node. All input properties is underneath msg
object. Such as, msg.payload
.
Property | Mandatory | Type | Description |
---|---|---|---|
payload | Yes | string |
the payload of the message to publish. 1000 characters max |
useImageUrl | No | boolean |
specify true/false to publish image URL to LINE Notify. |
imageFullsizeUrl | No | string |
image fullsize URL to publish. Maximum size of 2048×2048px JPEG |
imageThumbnailUrl | No | string |
image thumbnail URL to publish. Maximum size of 240×240px JPEG |
useImageFile | No | boolean |
specify true/false to use upload a image file to the LINE server. |
imageFile | No | string |
image to upload. Should be an absolute path to upload image file, e.g. C:\folder\image.jpg (Support .png and .jpg) |
useSticker | No | boolean |
specify true/false to publish sticker to 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 |
Detail :
-
msg.useImageUrl
is optional. If it does not sent from flow, this means not publish image url to LINE Notify. Likewise, ifmsg.useImageUrl
is true,msg.imageFullsizeUrl
andmsg.imageThumbnailUrl
must be specified. -
msg.useImageFile
is optional. If it does not sent from flow, this means not upload image file to LINE server. Likewise, ifmsg.useImageFile
is true,msg.imageFile
must be specified. -
If you specified all
msg.imageFullsizeUrl
,msg.imageThumbnailUrl
andmsg.imageFile
, themsg.imageFile
takes precedence. See more detail at LINE Notify API Document -
msg.useSticker
is optional. If it does not sent from flow, this means not publish sticker to LINE Notify. Likewise, ifmsg.useSticker
is true,msg.stickerId
andmsg.stickerPackageId
must be specified.
output properties is underneath msg
object.
Property | Type | Description |
---|---|---|
status | number |
standard result status code |
payload | string |
result message |
Property | Type | Description |
---|---|---|
status | number |
standard error code |
payload | string |
standard error message |
After install package, see usage examples at Node-RED Import menu at node-red-contrib-node-line-api
, then line-notify-examples
.
- Obtain LINE Notify Access Token at LINE Notify API Document.
- See more details at LINE Notify API Document.
- See more details about Sticker ID and Package ID at LINE List of available stickers.