LINE Message API Multicast Message Node - jatu-studiobox/node-red-contrib-node-line-api GitHub Wiki

NODE-RED node for multicast message to LINE Messaging API channel. You can use LINE Messaging API, multicast message, through this Node.

1. Create LINE Messaging API Channel in LINE Developer console. Use this official document Getting started with the Messaging API to create your own LINE Messaging API.

2. Obtain a Channel Access Token and Channel Secret from your created LINE Messaging API Channel (Actually, LINE Message API Multicast Message Node use only Channel Access Token, but LINE Messaging API Configuration Node requires both Channel Access Token and Channel Secret for configuration).

3. Add Messaging API Channel to LINE application.

4. Find User IDs or Group IDs for multicast message. Go to How to find User Id, Group Id or replyToken for testing Messaging API for easy finding.

5. Add LINE Message API Multicast Message Node in Node-RED workspace.

6. Configure LINE Messaging API Channel Access Token and Channel Secret in Multicast Message Node. See using LINE Messaging API Configuration Node

7. Setup Node values

• Use/Don't use ID list from wired node. If use ID list from wired node, it does not use destinatin ID list from Node Input.

• Desitnation IDs. Specified destination ID list for multicast message.

• Use/Don't use message data from wired node. If use message data from wired node, it does not use message type and message content from Node Input.
• Message Type, Normal Text (string) or Custom Message Format (JSON)
• Message, message for multicast.
• Disabled Push Notification, the user does/doesn't receive push notification when the message is sent.

8. Run workflow

9. Check result.

When setup node values to 'Use ID list from wired node', it uses msg object instead node input.

Property	Mandatory	Type	Description
destinations	No (Yes, if select 'Use ID list from wired node')	String[]	Specified destination ID list for multicast message to

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

Property	Mandatory	Type	Description
messageType	No (Yes, if select 'Use Message data from wired node')	int	0 : for normal text message for multicast message. 1 : for custom message format for multicast message.
payload	No (Yes, if select 'Use Message data from wired node')	string or JSON	string : for normal text message JSON : for custom message format Payload multicast message is validated at runtime.

Result from multicast message by using msg object.

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

• Output success case

status = 0 payload = Multicast message success: {"x-line-request-id":"xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx"}

Remark : {"x-line-request-id":"xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx"} is result from LINE Messaging API response.

• Output Fail case

status = <Error Number> payload = <Error message>

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

• See more details at LINE Messaging API (Multicast Message) Document.
• See more details about Custom message format at LINE Message Types.
• See more details at List of available LINE emojis.
• Node has paste function data from clipboard, so allow paste permmision in browser to able to work paste function.