messaging-api-line
Version:
Messaging API client for LINE
1,112 lines (893 loc) • 108 kB
Markdown
# messaging-api-line
> Messaging API client for LINE
<img src="http://is5.mzstatic.com/image/thumb/Purple117/v4/01/c2/4d/01c24d99-4aae-71ea-24e2-d0b68f8c53d2/source/1200x630bb.jpg" alt="LINE" width="150" />
## Table of Contents
- [Installation](#installation)
- [Usage](#usage)
- [API Reference](#api-reference)
- [Reply API](#reply-api)
- [Imagemap Messages](#reply-imagemap-messages)
- [Template Messages](#reply-template-messages)
- [Flex Messages](#reply-flex-messages)
- [Push API](#push-api)
- [Imagemap Messages](#push-imagemap-messages)
- [Template Messages](#push-template-messages)
- [Flex Messages](#push-flex-messages)
- [Multicast API](#multicast-api)
- [Imagemap Messages](#multicast-imagemap-messages)
- [Template Messages](#multicast-template-messages)
- [Flex Messages](#multicast-flex-messages)
- [Quick Replies](#quick-replies)
- [Content API](#content-api)
- [Profile API](#profile-api)
- [Group/Room Member Profile API](#grouproom-member-profile-api)
- [Group/Room Member IDs API](#grouproom-member-ids-api)
- [Leave API](#leave-api)
- [Rich Menu API](#rich-menu-api)
- [Account Link API](#account-link-api)
- [LINE Front-end Framework API](#liff-api)
- [LINE Pay](#line-pay)
- [Debug Tips](#debug-tips)
- [Testing](#testing)
## Installation
```sh
npm i --save messaging-api-line
```
or
```sh
yarn add messaging-api-line
```
<br />
## Usage
### Initialize
```js
const { LineClient } = require('messaging-api-line');
// get accessToken and channelSecret from LINE developers website
const client = new LineClient({
accessToken: ACCESS_TOKEN,
channelSecret: CHANNEL_SECRET,
});
```
### Error Handling
`messaging-api-line` uses [axios](https://github.com/axios/axios) as HTTP client. We use [axios-error](https://github.com/Yoctol/messaging-apis/tree/master/packages/axios-error) package to wrap API error instances for better formatting error messages. Directly calling `console.log` with the error instance will return formatted message. If you'd like to get the axios `request`, `response`, or `config`, you can still get them via those keys on the error instance.
```js
client.replyText(token, text).catch((error) => {
console.log(error); // formatted error message
console.log(error.stack); // error stack trace
console.log(error.config); // axios request config
console.log(error.request); // HTTP request
console.log(error.response); // HTTP response
});
```
<br />
## API Reference
All methods return a Promise.
<br />
<a id="reply-api" />
### Reply API - [Official Docs](https://developers.line.me/en/reference/messaging-api/#send-reply-message)
Responds to events from users, groups, and rooms.
## `reply(token, messages)`
Responds messages using specified reply token.
| Param | Type | Description |
| -------- | --------------- | ----------------------------------------------------------------------- |
| token | `String` | `replyToken` received via webhook. |
| messages | `Array<Object>` | Array of objects which contains the contents of the message to be sent. |
Example:
```js
client.reply(REPLY_TOKEN, [
{
type: 'text',
text: 'Hello!',
},
]);
```
`replyToken` can only be used once, but you can send up to 5 messages using the same token.
```js
const { Line } = require('messaging-api-line');
client.reply(REPLY_TOKEN, [
Line.createText('Hello'),
Line.createImage({
originalContentUrl: 'https://example.com/original.jpg',
previewImageUrl: 'https://example.com/preview.jpg',
}),
Line.createText('End'),
]);
```
There are a bunch of factory methods can be used to create messages:
- `Line.createText(text, options)`
- `Line.createImage(image, options)`
- `Line.createVideo(video, options)`
- `Line.createAudio(audio, options)`
- `Line.createLocation(location, options)`
- `Line.createSticker(sticker, options)`
- `Line.createImagemap(altText, imagemap, options)`
- `Line.createTemplate(altText, template, options)`
- `Line.createButtonTemplate(altText, buttonTemplate, options)`
- `Line.createConfirmTemplate(altText, confirmTemplate, options)`
- `Line.createCarouselTemplate(altText, columns, options)`
- `Line.createImageCarouselTemplate(altText, columns, options)`
- `Line.createFlex(altText, contents, options)`
<br />
## `replyText(token, text, options)` - [Official Docs](https://developers.line.me/en/reference/messaging-api/#text-message)
Responds text message using specified reply token.
<img src="https://developers.line.me/media/messaging-api/messages/text-bf530b30.png" width="250px" />
You can include LINE original emoji in text messages using character codes. For a list of LINE emoji that can be sent in LINE chats, see the [emoji list](https://developers.line.me/media/messaging-api/emoji-list.pdf).
<img src="https://developers.line.me/media/messaging-api/messages/emoji-b3285d27.png" width="250px" />
| Param | Type | Description |
| ------------------------ | -------- | -------------------------------------------- |
| token | `String` | `replyToken` received via webhook. |
| text | `String` | Text of the message to be sent. |
| options | `Object` | Optional options. |
| options.quickReply | `Object` | Quick reply object to attach to the message. |
| options.quickReply.items | `Array` | Quick reply items. |
Example:
```js
client.replyText(REPLY_TOKEN, 'Hello!');
```
<br />
## `replyImage(token, image, options)` - [Official Docs](https://developers.line.me/en/reference/messaging-api/#image-message)
Responds image message using specified reply token.
<img src="https://developers.line.me/media/messaging-api/messages/image-167efb33.png" width="250px" /><img src="https://developers.line.me/media/messaging-api/messages/image-full-04fbba55.png" width="250px" />
| Param | Type | Description |
| ------------------------ | -------- | -------------------------------------------- |
| token | `String` | `replyToken` received via webhook. |
| image.originalContentUrl | `String` | Image URL. |
| image.previewImageUrl | `String` | Preview image URL. |
| options | `Object` | Optional options. |
| options.quickReply | `Object` | Quick reply object to attach to the message. |
| options.quickReply.items | `Array` | Quick reply items. |
Example:
```js
client.replyImage(REPLY_TOKEN, {
originalContentUrl: 'https://example.com/original.jpg',
previewImageUrl: 'https://example.com/preview.jpg',
});
```
<br />
## `replyVideo(token, video, options)` - [Official Docs](https://developers.line.me/en/reference/messaging-api/#video-message)
Responds video message using specified reply token.
<img src="https://developers.line.me/media/messaging-api/messages/video-a1bc08a4.png" width="250px" />
| Param | Type | Description |
| ------------------------ | -------- | -------------------------------------------- |
| token | `String` | `replyToken` received via webhook. |
| video.originalContentUrl | `String` | URL of video file. |
| video.previewImageUrl | `String` | URL of preview image. |
| options | `Object` | Optional options. |
| options.quickReply | `Object` | Quick reply object to attach to the message. |
| options.quickReply.items | `Array` | Quick reply items. |
Example:
```js
client.replyVideo(REPLY_TOKEN, {
originalContentUrl: 'https://example.com/original.mp4',
previewImageUrl: 'https://example.com/preview.jpg',
});
```
<br />
## `replyAudio(token, audio, options)` - [Official Docs](https://developers.line.me/en/reference/messaging-api/#audio-message)
Responds audio message using specified reply token.
<img src="https://developers.line.me/media/messaging-api/messages/audio-6290d91b.png" width="250px" />
| Param | Type | Description |
| ------------------------ | -------- | -------------------------------------------- |
| token | `String` | `replyToken` received via webhook. |
| audio.originalContentUrl | `String` | URL of audio file. |
| audio.duration | `Number` | Length of audio file (milliseconds). |
| options | `Object` | Optional options. |
| options.quickReply | `Object` | Quick reply object to attach to the message. |
| options.quickReply.items | `Array` | Quick reply items. |
Example:
```js
client.replyAudio(REPLY_TOKEN, {
originalContentUrl: 'https://example.com/original.m4a',
duration: 240000,
});
```
<br />
## `replyLocation(token, location, options)` - [Official Docs](https://developers.line.me/en/reference/messaging-api/#location-message)
Responds location message using specified reply token.
<img src="https://developers.line.me/media/messaging-api/messages/location-8f9b6b79.png" width="250px" />
| Param | Type | Description |
| ------------------------ | -------- | -------------------------------------------- |
| token | `String` | `replyToken` received via webhook. |
| location | `Object` | Object contains location's parameters. |
| location.title | `String` | Title of the location. |
| location.address | `String` | Address of the location. |
| location.latitude | `Number` | Latitude of the location. |
| location.longitude | `Number` | Longitude of the location. |
| options | `Object` | Optional options. |
| options.quickReply | `Object` | Quick reply object to attach to the message. |
| options.quickReply.items | `Array` | Quick reply items. |
Example:
```js
client.replyLocation(REPLY_TOKEN, {
title: 'my location',
address: '〒150-0002 東京都渋谷区渋谷２丁目２１−１',
latitude: 35.65910807942215,
longitude: 139.70372892916203,
});
```
<br />
## `replySticker(token, sticker, options)` - [Official Docs](https://developers.line.me/en/reference/messaging-api/#sticker-message)
Responds sticker message using specified reply token.
For a list of stickers that can be sent with the Messaging API, see the [sticker list](https://developers.line.me/media/messaging-api/messages/sticker_list.pdf).
<img src="https://developers.line.me/media/messaging-api/messages/sticker-cb1a6a3a.png" width="250px" />
| Param | Type | Description |
| ------------------------ | -------- | -------------------------------------------- |
| token | `String` | `replyToken` received via webhook. |
| sticker.packageId | `String` | Package ID. |
| sticker.stickerId | `String` | Sticker ID. |
| options | `Object` | Optional options. |
| options.quickReply | `Object` | Quick reply object to attach to the message. |
| options.quickReply.items | `Array` | Quick reply items. |
Example:
```js
client.replySticker(REPLY_TOKEN, { packageId: '1', stickerId: '1' });
```
<br />
### Reply Imagemap Messages
## `replyImagemap(token, altText, imagemap, options)` - [Official Docs](https://developers.line.me/en/reference/messaging-api/#imagemap-message)
Responds imagemap message using specified reply token.
<img src="https://developers.line.me/media/messaging-api/messages/imagemap-dd854fa7.png" width="250px" />
| Param | Type | Description |
| ----------------------------------- | --------------- | ------------------------------------------------------------------------------------------- |
| token | `String` | `replyToken` received via webhook. |
| altText | `String` | Alternative text. |
| imagemap | `Object` | Object contains imagemap's parameters. |
| imagemap.baseUrl | `String` | Base URL of image. |
| imagemap.baseSize | `Object` | Base size object. |
| imagemap.baseSize.width | `Number` | Width of base image. |
| imagemap.baseSize.height | `Number` | Height of base image. |
| imagemap.video | `Object` | Video object. |
| imagemap.video.originalContentUrl | `String` | URL of the video file (Max: 1000 characters). |
| imagemap.video.previewImageUrl | `String` | URL of the preview image (Max: 1000 characters). |
| imagemap.video.area.x | `Number` | Horizontal position of the video area relative to the top-left corner of the imagemap area. |
| imagemap.video.area.y | `Number` | Vertical position of the video area relative to the top-left corner of the imagemap area. |
| imagemap.video.area.width | `Number` | Width of the video area. |
| imagemap.video.area.height | `Number` | Height of the video area. |
| imagemap.video.externalLink.linkUri | `String` | Webpage URL. Called when the label displayed after the video is tapped. |
| imagemap.video.externalLink.label | `String` | Label. Displayed after the video is finished. |
| imagemap.actions | `Array<Object>` | Action when tapped. |
| options | `Object` | Optional options. |
| options.quickReply | `Object` | Quick reply object to attach to the message. |
| options.quickReply.items | `Array` | Quick reply items. |
Example:
```js
client.replyImagemap(REPLY_TOKEN, 'this is an imagemap', {
baseUrl: 'https://example.com/bot/images/rm001',
baseSize: {
width: 1040,
height: 1040,
},
actions: [
{
type: 'uri',
linkUri: 'https://example.com/',
area: {
x: 0,
y: 0,
width: 520,
height: 1040,
},
},
{
type: 'message',
text: 'hello',
area: {
x: 520,
y: 0,
width: 520,
height: 1040,
},
},
],
});
```
<br />
### Reply Template Messages
## `replyTemplate(token, altText, template, options)` - [Official Docs](https://developers.line.me/en/reference/messaging-api/#template-messages)
Responds template message using specified reply token.
| Param | Type | Description |
| ------------------------ | -------- | -------------------------------------------- |
| token | `String` | `replyToken` received via webhook. |
| altText | `String` | Alternative text. |
| template | `Object` | Object with the contents of the template. |
| options | `Object` | Optional options. |
| options.quickReply | `Object` | Quick reply object to attach to the message. |
| options.quickReply.items | `Array` | Quick reply items. |
Example:
```js
client.replyTemplate(REPLY_TOKEN, 'this is a template', {
type: 'buttons',
thumbnailImageUrl: 'https://example.com/bot/images/image.jpg',
title: 'Menu',
text: 'Please select',
actions: [
{
type: 'postback',
label: 'Buy',
data: 'action=buy&itemid=123',
},
{
type: 'postback',
label: 'Add to cart',
data: 'action=add&itemid=123',
},
{
type: 'uri',
label: 'View detail',
uri: 'http://example.com/page/123',
},
],
});
```
<br />
## `replyButtonTemplate(token, altText, buttonTemplate, options)` - [Official Docs](https://developers.line.me/en/reference/messaging-api/#buttons)
Alias: `replyButtonsTemplate`.
Responds button template message using specified reply token.
<img src="https://developers.line.me/media/messaging-api/messages/buttons-86e14165.png" width="250px" />
| Param | Type | Description |
| ----------------------------------- | --------------- | --------------------------------------------------------------------------------------------- |
| token | `String` | `replyToken` received via webhook. |
| altText | `String` | Alternative text. |
| buttonTemplate | `Object` | Object contains buttonTemplate's parameters. |
| buttonTemplate.thumbnailImageUrl | `String` | Image URL of buttonTemplate. |
| buttonTemplate.imageAspectRatio | `String` | Aspect ratio of the image. Specify one of the following values: `rectangle`, `square` |
| buttonTemplate.imageSize | `String` | Size of the image. Specify one of the following values: `cover`, `contain` |
| buttonTemplate.imageBackgroundColor | `String` | Background color of image. Specify a RGB color value. The default value is `#FFFFFF` (white). |
| buttonTemplate.title | `String` | Title of buttonTemplate. |
| buttonTemplate.text | `String` | Message text of buttonTemplate. |
| buttonTemplate.defaultAction | `Object` | Action when image is tapped; set for the entire image, title, and text area. |
| buttonTemplate.actions | `Array<Object>` | Action when tapped. |
| options | `Object` | Optional options. |
| options.quickReply | `Object` | Quick reply object to attach to the message. |
| options.quickReply.items | `Array` | Quick reply items. |
Example:
```js
client.replyButtonTemplate(REPLY_TOKEN, 'this is a template', {
thumbnailImageUrl: 'https://example.com/bot/images/image.jpg',
title: 'Menu',
text: 'Please select',
actions: [
{
type: 'postback',
label: 'Buy',
data: 'action=buy&itemid=123',
},
{
type: 'postback',
label: 'Add to cart',
data: 'action=add&itemid=123',
},
{
type: 'uri',
label: 'View detail',
uri: 'http://example.com/page/123',
},
],
});
```
<br />
## `replyConfirmTemplate(token, altText, confirmTemplate, options)` - [Official Docs](https://developers.line.me/en/reference/messaging-api/#confirm)
Responds confirm template message using specified reply token.
<img src="https://developers.line.me/media/messaging-api/messages/confirm-444aead5.png" width="250px" />
| Param | Type | Description |
| ------------------------ | --------------- | --------------------------------------------- |
| token | `String` | `replyToken` received via webhook. |
| altText | `String` | Alternative text. |
| confirmTemplate | `Object` | Object contains confirmTemplate's parameters. |
| confirmTemplate.text | `String` | Message text of confirmTemplate. |
| confirmTemplate.actions | `Array<Object>` | Action when tapped. |
| options | `Object` | Optional options. |
| options.quickReply | `Object` | Quick reply object to attach to the message. |
| options.quickReply.items | `Array` | Quick reply items. |
Example:
```js
client.replyConfirmTemplate(REPLY_TOKEN, 'this is a confirm template', {
text: 'Are you sure?',
actions: [
{
type: 'message',
label: 'Yes',
text: 'yes',
},
{
type: 'message',
label: 'No',
text: 'no',
},
],
});
```
<br />
## `replyCarouselTemplate(token, altText, carouselItems, options)` - [Official Docs](https://developers.line.me/en/reference/messaging-api/#carousel)
Responds carousel template message using specified reply token.
<img src="https://developers.line.me/media/messaging-api/messages/carousel-c59baef6.png" width="250px" />
| Param | Type | Description |
| ------------------------ | --------------- | ------------------------------------------------------------------------------------- |
| token | `String` | `replyToken` received via webhook. |
| altText | `String` | Alternative text. |
| carouselItems | `Array<Object>` | Array of columns which contains object for carousel. |
| options | `Object` | Object contains options. |
| options.imageAspectRatio | `String` | Aspect ratio of the image. Specify one of the following values: `rectangle`, `square` |
| options.imageSize | `String` | Size of the image. Specify one of the following values: `cover`, `contain` |
| options.quickReply | `Object` | Quick reply object to attach to the message. |
| options.quickReply.items | `Array` | Quick reply items. |
Example:
```js
client.replyCarouselTemplate(REPLY_TOKEN, 'this is a carousel template', [
{
thumbnailImageUrl: 'https://example.com/bot/images/item1.jpg',
title: 'this is menu',
text: 'description',
actions: [
{
type: 'postback',
label: 'Buy',
data: 'action=buy&itemid=111',
},
{
type: 'postback',
label: 'Add to cart',
data: 'action=add&itemid=111',
},
{
type: 'uri',
label: 'View detail',
uri: 'http://example.com/page/111',
},
],
},
{
thumbnailImageUrl: 'https://example.com/bot/images/item2.jpg',
title: 'this is menu',
text: 'description',
actions: [
{
type: 'postback',
label: 'Buy',
data: 'action=buy&itemid=222',
},
{
type: 'postback',
label: 'Add to cart',
data: 'action=add&itemid=222',
},
{
type: 'uri',
label: 'View detail',
uri: 'http://example.com/page/222',
},
],
},
]);
```
<br />
## `replyImageCarouselTemplate(token, altText, carouselItems, options)` - [Official Docs](https://developers.line.me/en/reference/messaging-api/#image-carousel)
Responds image carousel template message using specified reply token.
<img src="https://developers.line.me/media/messaging-api/messages/image-carousel-301701f6.png" width="250px" />
| Param | Type | Description |
| ------------------------ | --------------- | ---------------------------------------------------------- |
| token | `String` | `replyToken` received via webhook. |
| altText | `String` | Alternative text. |
| carouselItems | `Array<Object>` | Array of columns which contains object for image carousel. |
| options | `Object` | Optional options. |
| options.quickReply | `Object` | Quick reply object to attach to the message. |
| options.quickReply.items | `Array` | Quick reply items. |
Example:
```js
client.replyImageCarouselTemplate(
REPLY_TOKEN,
'this is an image carousel template',
[
{
imageUrl: 'https://example.com/bot/images/item1.jpg',
action: {
type: 'postback',
label: 'Buy',
data: 'action=buy&itemid=111',
},
},
{
imageUrl: 'https://example.com/bot/images/item2.jpg',
action: {
type: 'message',
label: 'Yes',
text: 'yes',
},
},
{
imageUrl: 'https://example.com/bot/images/item3.jpg',
action: {
type: 'uri',
label: 'View detail',
uri: 'http://example.com/page/222',
},
},
]
);
```
<br />
### Reply Flex Messages
## `replyFlex(token, altText, contents, options)` - [Official Docs](https://developers.line.me/en/reference/messaging-api/#flex-message)
Responds flex message using specified reply token.
<img src="https://developers.line.biz/media/messaging-api/using-flex-messages/bubbleSamples-Update1-c3e3fbf2.png" />
| Param | Type | Description |
| ------------------------ | -------- | -------------------------------------------------------------------------------------------------- |
| token | `String` | `replyToken` received via webhook. |
| altText | `String` | Alternative text. |
| contents | `Object` | Flex Message [container](https://developers.line.me/en/reference/messaging-api/#container) object. |
| options | `Object` | Optional options. |
| options.quickReply | `Object` | Quick reply object to attach to the message. |
| options.quickReply.items | `Array` | Quick reply items. |
Example:
```js
client.replyFlex(REPLY_TOKEN, 'this is a flex', {
type: 'bubble',
header: {
type: 'box',
layout: 'vertical',
contents: [
{
type: 'text',
text: 'Header text',
},
],
},
hero: {
type: 'image',
url: 'https://example.com/flex/images/image.jpg',
},
body: {
type: 'box',
layout: 'vertical',
contents: [
{
type: 'text',
text: 'Body text',
},
],
},
footer: {
type: 'box',
layout: 'vertical',
contents: [
{
type: 'text',
text: 'Footer text',
},
],
},
styles: {
comment: 'See the example of a bubble style object',
},
});
```
<br />
<a id="push-api" />
### Push API - [Official Docs](https://developers.line.me/en/reference/messaging-api/#send-push-message)
Sends messages to a user, group, or room at any time.
## `push(userId, messages)`
Sends messages using ID of the receiver.
| Param | Type | Description |
| -------- | --------------- | ----------------------------------------------------------------------- |
| userId | `String` | ID of the receiver. |
| messages | `Array<Object>` | Array of objects which contains the contents of the message to be sent. |
Example:
```js
client.push(USER_ID, [
{
type: 'text',
text: 'Hello!',
},
]);
```
<br />
## `pushText(userId, text, options)` - [Official Docs](https://developers.line.me/en/reference/messaging-api/#text-message)
Sends text message using ID of the receiver.
<img src="https://developers.line.me/media/messaging-api/messages/text-bf530b30.png" width="250px" />
You can include LINE original emoji in text messages using character codes. For a list of LINE emoji that can be sent in LINE chats, see the [emoji list](https://developers.line.me/media/messaging-api/emoji-list.pdf).
<img src="https://developers.line.me/media/messaging-api/messages/emoji-b3285d27.png" width="250px" />
| Param | Type | Description |
| ------------------------ | -------- | -------------------------------------------- |
| userId | `String` | ID of the receiver. |
| text | `String` | Text of the message to be sent. |
| options | `Object` | Optional options. |
| options.quickReply | `Object` | Quick reply object to attach to the message. |
| options.quickReply.items | `Array` | Quick reply items. |
Example:
```js
client.pushText(USER_ID, 'Hello!');
```
<br />
## `pushImage(userId, image, options)` - [Official Docs](https://developers.line.me/en/reference/messaging-api/#image-message)
Sends image message using ID of the receiver.
<img src="https://developers.line.me/media/messaging-api/messages/image-167efb33.png" width="250px" /><img src="https://developers.line.me/media/messaging-api/messages/image-full-04fbba55.png" width="250px" />
| Param | Type | Description |
| ------------------------ | -------- | -------------------------------------------- |
| userId | `String` | ID of the receiver. |
| image.originalContentUrl | `String` | Image URL. |
| image.previewImageUrl | `String` | Preview image URL. |
| options | `Object` | Optional options. |
| options.quickReply | `Object` | Quick reply object to attach to the message. |
| options.quickReply.items | `Array` | Quick reply items. |
Example:
```js
client.pushImage(USER_ID, {
originalContentUrl: 'https://example.com/original.jpg',
previewImageUrl: 'https://example.com/preview.jpg',
});
```
<br />
## `pushVideo(userId, video, options)` - [Official Docs](https://developers.line.me/en/reference/messaging-api/#video-message)
Sends video message using ID of the receiver.
<img src="https://developers.line.me/media/messaging-api/messages/video-a1bc08a4.png" width="250px" />
| Param | Type | Description |
| ------------------------ | -------- | -------------------------------------------- |
| userId | `String` | ID of the receiver. |
| video.originalContentUrl | `String` | URL of video file. |
| video.previewImageUrl | `String` | URL of preview image. |
| options | `Object` | Optional options. |
| options.quickReply | `Object` | Quick reply object to attach to the message. |
| options.quickReply.items | `Array` | Quick reply items. |
Example:
```js
client.pushVideo(USER_ID, {
originalContentUrl: 'https://example.com/original.mp4',
previewImageUrl: 'https://example.com/preview.jpg',
});
```
<br />
## `pushAudio(userId, audio, options)` - [Official Docs](https://developers.line.me/en/reference/messaging-api/#audio-message)
Sends audio message using ID of the receiver.
<img src="https://developers.line.me/media/messaging-api/messages/audio-6290d91b.png" width="250px" />
| Param | Type | Description |
| ------------------------ | -------- | -------------------------------------------- |
| userId | `String` | ID of the receiver. |
| audio.originalContentUrl | `String` | URL of audio file. |
| audio.duration | `Number` | Length of audio file (milliseconds). |
| options | `Object` | Optional options. |
| options.quickReply | `Object` | Quick reply object to attach to the message. |
| options.quickReply.items | `Array` | Quick reply items. |
Example:
```js
client.pushAudio(USER_ID, {
originalContentUrl: 'https://example.com/original.m4a',
duration: 240000,
});
```
<br />
## `pushLocation(userId, location, options)` - [Official Docs](https://developers.line.me/en/reference/messaging-api/#location-message)
Sends location message using ID of the receiver.
<img src="https://developers.line.me/media/messaging-api/messages/location-8f9b6b79.png" width="250px" />
| Param | Type | Description |
| ------------------------ | -------- | -------------------------------------------- |
| userId | `String` | ID of the receiver. |
| location | `Object` | Object contains location's parameters. |
| location.title | `String` | Title of the location. |
| location.address | `String` | Address of the location. |
| location.latitude | `Number` | Latitude of the location. |
| location.longitude | `Number` | Longitude of the location. |
| options | `Object` | Optional options. |
| options.quickReply | `Object` | Quick reply object to attach to the message. |
| options.quickReply.items | `Array` | Quick reply items. |
Example:
```js
client.pushLocation(USER_ID, {
title: 'my location',
address: '〒150-0002 東京都渋谷区渋谷２丁目２１−１',
latitude: 35.65910807942215,
longitude: 139.70372892916203,
});
```
<br />
## `pushSticker(userId, sticker, options)` - [Official Docs](https://developers.line.me/en/reference/messaging-api/#sticker-message)
Sends sticker message using ID of the receiver.
For a list of stickers that can be sent with the Messaging API, see the [sticker list](https://developers.line.me/media/messaging-api/messages/sticker_list.pdf).
<img src="https://developers.line.me/media/messaging-api/messages/sticker-cb1a6a3a.png" width="250px" />
| Param | Type | Description |
| ------------------------ | -------- | -------------------------------------------- |
| userId | `String` | ID of the receiver. |
| sticker.packageId | `String` | Package ID. |
| sticker.stickerId | `String` | Sticker ID. |
| options | `Object` | Optional options. |
| options.quickReply | `Object` | Quick reply object to attach to the message. |
| options.quickReply.items | `Array` | Quick reply items. |
Example:
```js
client.pushSticker(USER_ID, { packageId: '1', stickerId: '1' });
```
<br />
### Push Imagemap Messages
## `pushImagemap(userId, altText, imagemap, options)` - [Official Docs](https://developers.line.me/en/reference/messaging-api/#imagemap-message)
Sends imagemap message using ID of the receiver.
<img src="https://developers.line.me/media/messaging-api/messages/imagemap-dd854fa7.png" width="250px" />
| Param | Type | Description |
| ----------------------------------- | --------------- | ------------------------------------------------------------------------------------------- |
| userId | `String` | ID of the receiver. |
| altText | `String` | Alternative text. |
| imagemap | `Object` | Object contains imagemap's parameters. |
| imagemap.baseUrl | `String` | Base URL of image. |
| imagemap.baseSize | `Object` | Base size object. |
| imagemap.baseSize.width | `Number` | Width of base image. |
| imagemap.baseSize.height | `Number` | Height of base image. |
| imagemap.video | `Object` | Video object. |
| imagemap.video.originalContentUrl | `String` | URL of the video file (Max: 1000 characters). |
| imagemap.video.previewImageUrl | `String` | URL of the preview image (Max: 1000 characters). |
| imagemap.video.area.x | `Number` | Horizontal position of the video area relative to the top-left corner of the imagemap area. |
| imagemap.video.area.y | `Number` | Vertical position of the video area relative to the top-left corner of the imagemap area. |
| imagemap.video.area.width | `Number` | Width of the video area. |
| imagemap.video.area.height | `Number` | Height of the video area. |
| imagemap.video.externalLink.linkUri | `String` | Webpage URL. Called when the label displayed after the video is tapped. |
| imagemap.video.externalLink.label | `String` | Label. Displayed after the video is finished. |
| imagemap.actions | `Array<Object>` | Action when tapped. |
| options | `Object` | Optional options. |
| options.quickReply | `Object` | Quick reply object to attach to the message. |
| options.quickReply.items | `Array` | Quick reply items. |
Example:
```js
client.pushImagemap(USER_ID, 'this is an imagemap', {
baseUrl: 'https://example.com/bot/images/rm001',
baseSize: {
width: 1040,
height: 1040,
},
actions: [
{
type: 'uri',
linkUri: 'https://example.com/',
area: {
x: 0,
y: 0,
width: 520,
height: 1040,
},
},
{
type: 'message',
text: 'hello',
area: {
x: 520,
y: 0,
width: 520,
height: 1040,
},
},
],
});
```
<br />
### Push Template Messages
## `pushTemplate(userId, altText, template, options)` - [Official Docs](https://developers.line.me/en/reference/messaging-api/#template-messages)
Sends template message using ID of the receiver.
| Param | Type | Description |
| ------------------------ | -------- | -------------------------------------------- |
| userId | `String` | ID of the receiver. |
| altText | `String` | Alternative text. |
| template | `Object` | Object with the contents of the template. |
| options | `Object` | Optional options. |
| options.quickReply | `Object` | Quick reply object to attach to the message. |
| options.quickReply.items | `Array` | Quick reply items. |
Example:
```js
client.pushTemplate(USER_ID, 'this is a template', {
type: 'buttons',
thumbnailImageUrl: 'https://example.com/bot/images/image.jpg',
title: 'Menu',
text: 'Please select',
actions: [
{
type: 'postback',
label: 'Buy',
data: 'action=buy&itemid=123',
},
{
type: 'postback',
label: 'Add to cart',
data: 'action=add&itemid=123',
},
{
type: 'uri',
label: 'View detail',
uri: 'http://example.com/page/123',
},
],
});
```
<br />
## `pushButtonTemplate(userId, altText, buttonTemplate, options)` - [Official Docs](https://developers.line.me/en/reference/messaging-api/#buttons)
Alias: `pushButtonsTemplate`.
Sends button template message using ID of the receiver.
<img src="https://developers.line.me/media/messaging-api/messages/buttons-86e14165.png" width="250px" />
| Param | Type | Description |
| ----------------------------------- | --------------- | --------------------------------------------------------------------------------------------- |
| userId | `String` | ID of the receiver. |
| altText | `String` | Alternative text. |
| buttonTemplate | `Object` | Object contains buttonTemplate's parameters. |
| buttonTemplate.thumbnailImageUrl | `String` | Image URL of buttonTemplate. |
| buttonTemplate.imageAspectRatio | `String` | Aspect ratio of the image. Specify one of the following values: `rectangle`, `square` |
| buttonTemplate.imageSize | `String` | Size of the image. Specify one of the following values: `cover`, `contain` |
| buttonTemplate.imageBackgroundColor | `String` | Background color of image. Specify a RGB color value. The default value is `#FFFFFF` (white). |
| buttonTemplate.title | `String` | Title of buttonTemplate. |
| buttonTemplate.text | `String` | Message text of buttonTemplate. |
| buttonTemplate.defaultAction | `Object` | Action when image is tapped; set for the entire image, title, and text area. |
| buttonTemplate.actions | `Array<Object>` | Action when tapped. |
| options | `Object` | Optional options. |
| options.quickReply | `Object` | Quick reply object to attach to the message. |
| options.quickReply.items | `Array` | Quick reply items. |
Example:
```js
client.pushButtonTemplate(USER_ID, 'this is a template', {
thumbnailImageUrl: 'https://example.com/bot/images/image.jpg',
title: 'Menu',
text: 'Please select',
actions: [
{
type: 'postback',
label: 'Buy',
data: 'action=buy&itemid=123',
},
{
type: 'postback',
label: 'Add to cart',
data: 'action=add&itemid=123',
},
{
type: 'uri',
label: 'View detail',
uri: 'http://example.com/page/123',
},
],
});
```
<br />
## `pushConfirmTemplate(userId, altText, confirmTemplate, options)` - [Official Docs](https://developers.line.me/en/reference/messaging-api/#confirm)
Sends confirm template message using ID of the receiver.
<img src="https://developers.line.me/media/messaging-api/messages/confirm-444aead5.png" width="250px" />
| Param | Type | Description |
| ------------------------ | --------------- | --------------------------------------------- |
| userId | `String` | ID of the receiver. |
| altText | `String` | Alternative text. |
| confirmTemplate | `Object` | Object contains confirmTemplate's parameters. |
| confirmTemplate.text | `String` | Message text of confirmTemplate. |
| confirmTemplate.actions | `Array<Object>` | Action when tapped. |
| options | `Object` | Optional options. |
| options.quickReply | `Object` | Quick reply object to attach to the message. |
| options.quickReply.items | `Array` | Quick reply items. |
Example:
```js
client.pushConfirmTemplate(USER_ID, 'this is a confirm template', {
text: 'Are you sure?',
actions: [
{
type: 'message',
label: 'Yes',
text: 'yes',
},
{
type: 'message',
label: 'No',
text: 'no',
},
],
});
```
<br />
## `pushCarouselTemplate(userId, altText, carouselItems, options)` - [Official Docs](https://developers.line.me/en/reference/messaging-api/#carousel)
Sends carousel template message using ID of the receiver.
<img src="https://developers.line.me/media/messaging-api/messages/carousel-c59baef6.png" width="250px" />
| Param | Type | Description |
| ------------------------ | --------------- | ------------------------------------------------------------------------------------- |
| userId | `String` | ID of the receiver. |
| altText | `String` | Alternative text. |
| carouselItems | `Array<Object>` | Array of columns which contains object for carousel. |
| options | `Object` | Object contains options. |
| options.imageAspectRatio | `String` | Aspect ratio of the image. Specify one of the following values: `rectangle`, `square` |
| options.imageSize | `String` | Size of the image. Specify one of the following values: `cover`, `contain` |
| options.quickReply | `Object` | Quick reply object to attach to the message. |
| options.quickReply.items | `Array` | Quick reply items. |
Example:
```js
client.pushCarouselTemplate(USER_ID, 'this is a carousel template', [
{
thumbnailImageUrl: 'https://example.com/bot/images/item1.jpg',
title: 'this is menu',
text: 'description',