Messaging API reference
Common specifications
Webhooks
Webhook event objects
OAuth
Message
オーディエンス管理
Insight
Profile
Group
Room
Rich menu
Account link
Message objects
Action objects
Rich menu structure

Messaging API reference

Common specifications

Rate limits

The Messaging API applies the following rate limits for each endpoint. Rate limits depend on your plan and endpoint.

note Note

If you continue to send requests exceeding the rate limit for an extended period of time, we may block incoming requests.

For bots associated with LINE official accounts

Endpoint Rate limit
Send a multicast message 100,000 requests per minute
1,700 requests per second*
2,000,000 recipients per minute
Send a narrowcast message
Send a broadcast message
Get number of sent messages
Get number of friends
Get friend demographics 		60 requests per hour
Other API endpoints 100,000 requests per minute
1,700 requests per second*

*The rate limit in seconds is a guideline for mass transmission.

For bots associated with LINE@ accounts

Endpoint Rate limit
Send a multicast message 10,000 requests per minute
170 requests per second*
200,000 recipients per minute
Other API endpoints 10,000 requests per minute
170 requests per second*

*The rate limit in seconds is a guideline for mass transmission.

Status codes

The following status codes are returned by the Messaging API.

Status code Description
200 OK Request successful
400 Bad Request Problem with the request
401 Unauthorized Valid channel access token is not specified
403 Forbidden Not authorized to access the resource. Confirm that your account or plan is authorized to access the resource.
429 Too Many Requests Exceeded the rate limit for API calls
500 Internal Server Error Error on the internal server

Response headers

The following HTTP headers are included in Messaging API responses.

Response headers Description
X-Line-Request-Id Request ID. A unique ID is generated for each request

Error responses

The following JSON data is returned in the response body when an error occurs.

Property Type Description
message String Message containing information about the error. For more details, see Error messages.
details[].message String Details of the error. Not returned in certain situations.
details[].property String Location of where the error occurred. Not returned in certain situations.

Error messages

The main error messages that are found in the message property of the JSON error responses are shown below.

Message Description
The request body has X error(s) An error was found in the JSON data of the request body. The number of errors is displayed for "X". Further details are shown in the details[].message and details[].property properties.
Invalid reply token An invalid reply token was used in the reply message
The property, XXX, in the request body is invalid (line: XXX, column: XXX) An invalid property was specified in the request body. The specific property is displayed for "XXX".
The request body could not be parsed as JSON (line: XXX, column: XXX) The JSON in the request body could not be parsed. The specific line and column are displayed.
The content type, XXX, is not supported A content type not supported by the API is requested.
Authentication failed due to the following reason: XXX Authentication failed when the API was called. The reason is displayed for "XXX".
Access to this API is not available for your account Appears when calling an API that you do not have permission to use.
Failed to send messages Appears when the message fails to be sent. One reason this may appear is if the user ID specified does not exist.
You have reached your monthly limit. You have exceeded the target limit for additional messages.

Example error response

{  
   "message":"The request body has 2 error(s)",
   "details":[  
      {  
         "message":"May not be empty",
         "property":"messages[0].text"
      },
      {  
         "message":"Must be one of the following values: [text, image, video, audio, location, sticker, template, imagemap]",
         "property":"messages[1].type"
      }
   ]
}

Webhooks

Introduction

When an event, such as when a user adds your LINE official account or sends a message, is triggered, an HTTPS POST request is sent to the webhook URL that is configured for your channel on the console.

Your bot server then receives and handles the requests.

Request headers

Request header Description
X-Line-Signature Used for signature validation

Request body

The request body contains a JSON object with the user ID of a bot that should receive webhook events and an array of webhook event objects.

Property Type Description
destination String User ID of a bot that should receive webhook events. The user ID value is a string that matches the regular expression, U[0-9a-f]{32}.
events Array of webhook event objects Information about the event

Response

Your bot server should return the status code 200 for a HTTP POST request sent by a webhook.

Signature validation

The signature in the X-Line-Signature request header must be verified to confirm that the request was sent from the LINE Platform.

Authentication is performed as follows:

  1. With the channel secret as the secret key, your application retrieves the digest value in the request body created using the HMAC-SHA256 algorithm.
  2. The server confirms that the signature in the request header matches the digest value which is Base64 encoded.

Example of signature validation

# Click on the language tabs for examples of signature validation

String channelSecret = ...; // Channel secret string
String httpRequestBody = ...; // Request body string
SecretKeySpec key = new SecretKeySpec(channelSecret.getBytes(), "HmacSHA256");
Mac mac = Mac.getInstance("HmacSHA256");
mac.init(key);
byte[] source = httpRequestBody.getBytes("UTF-8");
String signature = Base64.encodeBase64String(mac.doFinal(source));
// Compare X-Line-Signature request header string and the signature

CHANNEL_SECRET = ... # Channel secret string
http_request_body = request.raw_post # Request body string
hash = OpenSSL::HMAC::digest(OpenSSL::Digest::SHA256.new, CHANNEL_SECRET, http_request_body)
signature = Base64.strict_encode64(hash)
# Compare X-Line-Signature request header string and the signature

defer req.Body.Close()
body, err := ioutil.ReadAll(req.Body)
if err != nil {
    // ...
}
decoded, err := base64.StdEncoding.DecodeString(req.Header.Get("X-Line-Signature"))
if err != nil {
    // ...
}
hash := hmac.New(sha256.New, []byte("<channel secret>"))
hash.Write(body)
// Compare decoded signature and `hash.Sum(nil)` by using `hmac.Equal`

$channelSecret = ...; // Channel secret string
$httpRequestBody = ...; // Request body string
$hash = hash_hmac('sha256', $httpRequestBody, $channelSecret, true);
$signature = base64_encode($hash);
// Compare X-Line-Signature request header string and the signature

use Digest::SHA 'hmac_sha256';
use MIME::Base64 'encode_base64';

my $channel_secret= ... # Channel secret string
my $http_body = ... # Request body string
my $signature = encode_base64(hmac_sha256($http_body, $channel_secret));
# Compare X-Line-Signature request header string and the signature

import base64
import hashlib
import hmac

channel_secret = ... # Channel secret string
body = ... # Request body string
hash = hmac.new(channel_secret.encode('utf-8'),
    body.encode('utf-8'), hashlib.sha256).digest()
signature = base64.b64encode(hash)
# Compare X-Line-Signature request header and the signature

const crypto = require('crypto');

const channelSecret = ...; // Channel secret string
const body = ...; // Request body string
const signature = crypto
  .createHmac('SHA256', channelSecret)
  .update(body).digest('base64');
// Compare X-Line-Signature request header and the signature

Webhook event objects

JSON objects which contain events generated on the LINE Platform.

Some properties of these event objects might not have any value. Generated event objects don't contain properties without any value.

The structure of these event objects might be changed when the Messaging API feature is updated. Such changes can include adding properties, changing the order of properties, adding or deleting spaces and newlines between data elements, and so on. Implement your server so as not to fail in receiving event objects whose structure has changed in the future.

Example webhook event object

{
  "destination": "xxxxxxxxxx", 
  "events": [
    {
      "replyToken": "0f3779fba3b349968c5d07db31eab56f",
      "type": "message",
      "mode": "active",
      "timestamp": 1462629479859,
      "source": {
        "type": "user",
        "userId": "U4af4980629..."
      },
      "message": {
        "id": "325708",
        "type": "text",
        "text": "Hello, world"
      }
    },
    {
      "replyToken": "8cf9239d56244f4197887e939187e19e",
      "type": "follow",
      "mode": "active",
      "timestamp": 1462629479859,
      "source": {
        "type": "user",
        "userId": "U4af4980629..."
      }
    }
  ]
}

Common properties

The following properties are found in webhook event objects.

Property Type Description
type String Identifier for the type of event
mode String Channel state.
  • active: The channel is active. You can send a reply message or push message from the bot server that received this webhook event.
  • standby (under development): The channel is waiting. The bot server that received this webhook event shouldn't send any messages.
timestamp Number Time of the event in milliseconds
source Object Source user, group, or room object with information about the source of the event.
note What causes the mode property to change

The mode property's value can change to standby if the channel administrator starts using channel multiplexing (under development). The value of mode never automatically changes to standby.

There is currently no way to multiplex incoming channels.

Source user

Property Type Description
type String user
userId String ID of the source user

Source user example

  "source": {
    "type": "user",
    "userId": "U4af4980629..."
  }

Source group

Property Type Description
type String group
groupId String ID of the source group
userId String ID of the source user. Only included in message events. Users of LINE version 7.4.x or earlier are not included in userId. For more information, see User consent.

Source group example

  "source": {
    "type": "group",
    "groupId": "Ca56f94637c...",
    "userId": "U4af4980629..."
  }

Source room

Property Type Description
type String room
roomId String ID of the source room
userId String ID of the source user. Only included in message events. Users of LINE version 7.4.x or earlier are not included in userId. For more information, see User consent.

Source room example

  "source": {
    "type": "room",
    "roomId": "Ra8dbf4673c...",
    "userId": "U4af4980629..."
  }

Message event

Webhook event object which contains the sent message. The message property contains a message object which corresponds with the message type. You can reply to message events.

Property Type Description
type String message
replyToken String Token for replying to the event
message Object Object containing the contents of the message. Message types include:

Text

Message object which contains the text sent from the source.

Property Type Description
id String Message ID
type String text
text String Message text

Text message example

{
  "replyToken": "nHuyWiB7yP5Zw52FIkcQobQuGDXCTA",
  "type": "message",
  "mode": "active",
  "timestamp": 1462629479859,
  "source": {
    "type": "user",
    "userId": "U4af4980629..."
  },
  "message": {
    "id": "325708",
    "type": "text",
    "text": "Hello, world!"
  }
}

Image

Message object which contains the image content sent from the source.

Property Type Description
id String Message ID
type String image
contentProvider.type String Provider of the image file.
  • line: The image was sent by a LINE user. The binary image data can be retrieved from the content endpoint.
  • external: The image was sent using the LIFF liff.sendMessages() method. For more information, see liff.sendMessages() in the LIFF API reference.
contentProvider.originalContentUrl String URL of the image file. Only included when contentProvider.type is external.
contentProvider.previewImageUrl String URL of the preview image. Only included when contentProvider.type is external.

Image message example

{
  "replyToken": "nHuyWiB7yP5Zw52FIkcQobQuGDXCTA",
  "type": "message",
  "mode": "active",
  "timestamp": 1462629479859,
  "source": {
    "type": "user",
    "userId": "U4af4980629..."
  },
  "message": {
    "id": "325708",
    "type": "image",
    "contentProvider": {
      "type": "line"
    }
  }
}

Video

Message object which contains the video content sent from the source. The preview image is displayed in the chat and the video is played when the image is tapped.

Property Type Description
id String Message ID
type String video
duration Number Length of video file (milliseconds)
contentProvider.type String Provider of the video file.
  • line: The video was sent by a LINE user. The binary video data can be retrieved from the content endpoint.
  • external: The video was sent using the LIFF liff.sendMessages() method. For more information, see liff.sendMessages() in the LIFF API reference.
contentProvider.originalContentUrl String URL of the video file. Only included when contentProvider.type is external.
contentProvider.previewImageUrl String URL of the preview image. Only included when contentProvider.type is external.

Video message example

{
  "replyToken": "nHuyWiB7yP5Zw52FIkcQobQuGDXCTA",
  "type": "message",
  "mode": "active",
  "timestamp": 1462629479859,
  "source": {
    "type": "user",
    "userId": "U4af4980629..."
  },
  "message": {
    "id": "325708",
    "type": "video",
    "duration": 60000,
    "contentProvider": {
      "type": "external",
      "originalContentUrl": "https://example.com/original.mp4",
      "previewImageUrl": "https://example.com/preview.jpg"
    }
  }
}

Audio

Message object which contains the audio content sent from the source.

Property Type Description
id String Message ID
type String audio
duration Number Length of audio file (milliseconds)
contentProvider.type String Provider of the audio file.
  • line: The audio file was sent by a LINE user. The binary audio data can be retrieved from the content endpoint.
  • external: The audio file was sent using the LIFF liff.sendMessages() method. For more information, see liff.sendMessages() in the LIFF API reference.
contentProvider.originalContentUrl String URL of the audio file. Only included when contentProvider.type is external.

Audio message example

{
  "replyToken": "nHuyWiB7yP5Zw52FIkcQobQuGDXCTA",
  "type": "message",
  "mode": "active",
  "timestamp": 1462629479859,
  "source": {
    "type": "user",
    "userId": "U4af4980629..."
  },
  "message": {
    "id": "325708",
    "type": "audio",
    "duration": 60000,
    "contentProvider": {
      "type": "line"
    }
  }
}

File

Message object which contains the file sent from the source. The binary data can be retrieved from the content endpoint.

Property Type Description
id String Message ID
type String file
fileName String File name
fileSize Number File size in bytes

File message example

{
  "replyToken": "nHuyWiB7yP5Zw52FIkcQobQuGDXCTA",
  "type": "message",
  "mode": "active",
  "timestamp": 1462629479859,
  "source": {
    "type": "user",
    "userId": "U4af4980629..."
  },
  "message": {
    "id": "325708",
    "type": "file",
    "fileName": "file.txt",
    "fileSize": 2138
  }
}

Location

Message object which contains the location data sent from the source.

Property Type Description
id String Message ID
type String location
title String Title
address String Address
latitude Decimal Latitude
longitude Decimal Longitude

Location message example

{
  "replyToken": "nHuyWiB7yP5Zw52FIkcQobQuGDXCTA",
  "type": "message",
  "mode": "active",
  "timestamp": 1462629479859,
  "source": {
    "type": "user",
    "userId": "U4af4980629..."
  },
  "message": {
    "id": "325708",
    "type": "location",
    "title": "my location",
    "address": "〒150-0002 東京都渋谷区渋谷２丁目２１−１",
    "latitude": 35.65910807942215,
    "longitude": 139.70372892916203
  }
}

Sticker

Message object which contains the sticker data sent from the source. For a list of basic LINE stickers and sticker IDs, see sticker list.

Property Type Description
id String Message ID
type String sticker
packageId String Package ID
stickerId String Sticker ID
stickerResourceType String Sticker resource type. One of:
  • STATIC: Still image
  • ANIMATION: Animated sticker
  • SOUND: Sticker with sound
  • ANIMATION_SOUND: Animated sticker with sound
  • POPUP: Pop-up sticker
  • POPUP_SOUND: Pop-up sticker with sound
  • NAME_TEXT: Custom sticker
note About sticker resource types

In the future, we may add new types without notice. Make sure your implementation can handle both current and future sticker resource types.

Sticker message example

{
  "replyToken": "nHuyWiB7yP5Zw52FIkcQobQuGDXCTA",
  "type": "message",
  "mode": "active",
  "timestamp": 1462629479859,
  "source": {
    "type": "user",
    "userId": "U4af4980629..."
  },
  "message": {
    "id": "325708",
    "type": "sticker",
    "packageId": "1",
    "stickerId": "1",
    "stickerResourceType": "STATIC"
  }
}

Follow event

Event object for when your LINE official account is added as a friend (or unblocked). You can reply to follow events.

Property Type Description
type String follow
replyToken String Token for replying to this event

Follow event example

{
  "replyToken": "nHuyWiB7yP5Zw52FIkcQobQuGDXCTA",
  "type": "follow",
  "mode": "active",
  "timestamp": 1462629479859,
  "source": {
    "type": "user",
    "userId": "U4af4980629..."
  }
}

Unfollow event

Event object for when your LINE official account is blocked.

Property Type Description
type String unfollow

Unfollow event example

{
  "type": "unfollow",
  "mode": "active",
  "timestamp": 1462629479859,
  "source": {
    "type": "user",
    "userId": "U4af4980629..."
  }
}

Join event

Event object for when your LINE official account joins a group or room. You can reply to join events.

A join event is triggered at different times for groups and rooms.

  • For groups: A join event is sent when a user invites your LINE official account.
  • For rooms: A join event is sent when the first event (for example when a user sends a message or is added to the room) occurs after your LINE official account is added.
Property Type Description
type String join
replyToken String Token for replying to this event

Join event example

{
  "replyToken": "nHuyWiB7yP5Zw52FIkcQobQuGDXCTA",
  "type": "join",
  "mode": "active",
  "timestamp": 1462629479859,
  "source": {
    "type": "group",
    "groupId": "C4af4980629..."
  }
}

Leave event

Event object for when a user removes your LINE official account from a group or when your LINE official account leaves a group or room.

Property Type Description
type String leave

Leave event example

{
  "type": "leave",
  "mode": "active",
  "timestamp": 1462629479859,
  "source": {
    "type": "group",
    "groupId": "C4af4980629..."
  }
}

Member join event

Event object for when a user joins a group or room that the LINE official account is in.

Property Type Description
type String memberJoined
joined.members Array of source user objects User ID of users who joined
replyToken String Token for replying to this event

Member join event example

{
  "replyToken": "0f3779fba3b349968c5d07db31eabf65",
  "type": "memberJoined",
  "mode": "active",
  "timestamp": 1462629479859,
  "source": {
    "type": "group",
    "groupId": "C4af4980629..."
  },
  "joined": {
    "members": [
      {
       "type": "user",
        "userId": "U4af4980629..."
      },
      {
        "type": "user",
        "userId": "U91eeaf62d9..."
      }
    ]
  }
}

Member leave event

Event object for when a user leaves a group or room that the LINE official account is in.

Property Type Description
type String memberLeft
left.members Array of source user objects User ID of users who left

Member leave event example

{
  "type": "memberLeft",
  "mode": "active",
  "timestamp": 1462629479960,
  "source": {
    "type": "group",
    "groupId": "C4af4980629..."
  },
  "left": {
    "members": [
      {
        "type": "user",
        "userId": "U4af4980629..."
      },
      {  
        "type": "user",
        "userId": "U91eeaf62d9..."
      }
    ]
  }
}

Postback event

Event object for when a user performs a postback action which initiates a postback. You can reply to postback events.

Property Type Description
type String postback
replyToken String Token for replying to this event
postback.data String Postback data
postback.params Object JSON object with the date and time selected by a user through a datetime picker action.
Only returned for postback actions via a datetime picker action.

Postback event example

{  
   "type":"postback",
   "replyToken":"b60d432864f44d079f6d8efe86cf404b",
   "source":{  
      "userId":"U91eeaf62d...",
      "type":"user"
   },
   "mode": "active",
   "timestamp":1513669370317,
   "postback":{  
      "data":"storeId=12345",
      "params":{  
         "datetime":"2017-12-25T01:00"
      }
   }
}

postback.params object

Object with the date and time selected by a user through a datetime picker action. The full-date, time-hour, and time-minute formats follow the RFC3339 protocol.

Property Format Description
date full-date Date selected by user. Only included in the date mode.
time time-hour ":" time-minute Time selected by the user. Only included in the time mode.
datetime full-date "T" time-hour ":" time-minute Date and time selected by the user. Only included in the datetime mode.

postback.params object example

{  
   "datetime":"2017-12-25T01:00"
}

Beacon event

Event object for when a user enters the range of a LINE Beacon. You can reply to beacon events.

Property Type Description
type String beacon
replyToken String Token for replying to this event
beacon.hwid String Hardware ID of the beacon that was detected
beacon.type String Type of beacon event. See Beacon event types.
beacon.dm String Device message of beacon that was detected. This message consists of data generated by the beacon to send notifications to bot servers. Only included in webhook events from devices that support the "device message" property.
For more information, see the LINE Simple Beacon specification.

Beacon event types

beacon.type Description
enter Entered beacon's reception range
leave [Deprecated] Left beacon's reception range.
banner Tapped beacon banner
stay A user is in the beacon's reception range.
This event is sent repeatedly at a minimum of 10 seconds.

If you are interested in using the Beacon Banner feature and stay event, make an inquiry through the LINE for Business website.

Beacon event example

{
  "replyToken": "nHuyWiB7yP5Zw52FIkcQobQuGDXCTA",
  "type": "beacon",
  "mode": "active",
  "timestamp": 1462629479859,
  "source": {
    "type": "user",
    "userId": "U4af4980629..."
  },
  "beacon": {
    "hwid": "d41d8cd98f",
    "type": "enter"
  }
}

Event object for when a user has linked his/her LINE account with a provider's service account. You can reply to account link events.

If the link token has expired or has already been used, no webhook event will be sent and the user will be shown an error.

Property Type Description
type String accountLink
replyToken String Token for replying to this event. This value will not be included if the link has failed.
link Object link object. This will include whether the account link was successful or not and a nonce generated from the user ID on the provider's service.

Account link event example

{
  "type": "accountLink",
  "mode": "active",
  "replyToken": "b60d432864f44d079f6d8efe86cf404b",
  "source": {
    "userId": "U91eeaf62d...",
    "type": "user"
  },
  "timestamp": 1513669370317,
  "link": {
    "result": "ok",
    "nonce": "xxxxxxxxxxxxxxx"
  }
}
Property Type Description
result String One of the following values to indicate whether the link was successful or not.
  • ok: Indicates the link was successful.
  • failed: Indicates the link failed for any reason, such as due to a user impersonation.
nonce String Specified nonce when verifying the user ID

Example link object

"link": {
  "result": "ok",
  "nonce": "xxxxxxxxxxxxxxx"
}

Indicates that a user linked a device with LINE.

Property Type Description
type String things
replyToken String Token for replying to this event
things.deviceId String Device ID of the device that has been linked with LINE.
things.type String link

If you use the LINE Things API, you can identify the device that has been linked or unlinked by the user from the device ID acquired by the Webhook event. For more information about the API, see Getting the product ID and PSDI by specifying the device ID in the LINE Things API reference.

Device link event example 

{
  "type": "things",
  "replyToken": "nHuyWiB7yP5Zw52FIkcQobQuGDXCTA",
  "mode": "active",
  "timestamp": 1462629479859,
  "source": {
    "type": "user",
    "userId": "U91eeaf62d..."
  },
  "things": {
    "deviceId": "t2c449c9d1...",
    "type": "link"
  }
}

Indicates that the user unlinked a device from LINE.

Property Type Description
type String things
replyToken String Token for replying to this event
things.deviceId String Device ID of the device that was unlinked from LINE.
things.type String unlink

If you use the LINE Things API, you can identify the device that has been linked or unlinked by the user from the device ID acquired by the Webhook event. For more information about the API, see Getting the product ID and PSDI by specifying the device ID in the LINE Things API reference.

Device unlink event example 

{
  "type": "things",
  "replyToken": "nHuyWiB7yP5Zw52FIkcQobQuGDXCTA",
  "mode": "active",
  "timestamp": 1462629479859,
  "source": {
    "type": "user",
    "userId": "U91eeaf62d..."
  },
  "things": {
    "deviceId": "t2c449c9d1...",
    "type": "unlink"
  }
}

LINE Things scenario execution event

This event indicates that an automatic communication scenario has been executed.

Rather than returning an aggregated result for a scenario set, an execution result is returned for each individual scenario.

The order in which execution results are returned is independent of the order of the scenarios.

Property Type Description
type String things
replyToken String Token for replying to this event
things.deviceId String Device ID of the device that executed the scenario
things.type String scenarioResult
things.result.scenarioId String Scenario ID executed
things.result.revision Number Revision number of the scenario set containing the executed scenario
things.result.startTime Number Timestamp for when execution of scenario action started (milliseconds, LINE app time)
things.result.endTime Number Timestamp for when execution of scenario was completed (milliseconds, LINE app time)
things.result.resultCode String Scenario execution completion status
See also things.result.resultCode definitions.
things.result.actionResults Array Execution result of individual operations specified in action
Note that an array of actions specified in a scenario has the following characteristics
  • The actions defined in a scenario are performed sequentially, from top to bottom.
  • Each action produces some result when executed.
    Even actions that do not generate data, such as SLEEP, return an execution result of type void.
  • The number of items in an action array may be 0.
Therefore, things.result.actionResults has the following properties:
  • The number of items in the array matches the number of actions defined in the scenario.
  • The order of execution results matches the order in which actions are performed. That is, in a scenario set with multiple GATT_READ actions, the results are returned in the order in which each individual GATT_READ action was performed.
  • If 0 actions are defined in the scenario, the number of items in things.result.actionResults will be 0.
things.result.actionResults[].type String void, binary
  • Depends on type of the executed action.
  • This property is always included if things.result.actionResults is not empty.
things.result.actionResults[].data String Base64-encoded binary data
This property is always included when things.result.actionResults[].type is binary.
things.result.bleNotificationPayload String Data contained in notification
The value is Base64-encoded binary data. Only included for scenarios where trigger.type = BLE_NOTIFICATION.
things.result.errorReason String Error reason

things.result.resultCode definition

resultCode Description
success Indicates that the execution has completed successfully
gatt_error Indicates that the execution of the GATT operation failed
  • GATT Service UUID is incorrect.
  • GATT Characteristic UUID is incorrect.
  • Attempted to write to a characteristic that cannot be written to.
runtime_error Indicates that an unexpected error has occurred
  • When an unexpected error has occurred

Example of LINE Things scenario execution event 

{
  "events": [
    {
      "type": "things",
      "replyToken": "0f3779fba3b349968c5d07db31eab56f",
      "source": {
        "userId": "uXXX",
        "type": "user"
      },
      "mode": "active",
      "timestamp": 1547817848122,
      "things": {
        "type": "scenarioResult",
        "deviceId": "tXXX",
        "result": {
          "scenarioId": "XXX",
          "revision": 2,
          "startTime": 1547817845950,
          "endTime": 1547817845952,
          "resultCode": "success",
          "bleNotificationPayload": "AQ==",
          "actionResults": [
            {
              "type": "binary",
              "data": "/w=="
            }
          ]
        }
      }
    }
  ],
  "destination": "uXXX"
}

OAuth

Issue channel access token

note Note

This method issues a short-lived channel access token that is valid for 30 days. To issue a long-lived channel access token, use the Issue button found on the Console.

Issues a short-lived channel access token.

Up to 30 tokens can be issued. If the maximum is exceeded, existing channel access tokens are revoked in the order of when they were first issued.

HTTP request

Request headers

Request header Description
Content-Type application/x-www-form-urlencoded

Request body

Field Type Description
grant_type String client_credentials
client_id String Channel ID. Found on the console.
client_secret String Channel secret. Found on the console.

Example request

curl -v -X POST https://api.line.me/v2/oauth/accessToken \
-H "Content-Type:application/x-www-form-urlencoded" \
--data-urlencode 'grant_type=client_credentials' \
--data-urlencode 'client_id={channel ID}' \
--data-urlencode 'client_secret={channel secret}'

// No sample code available

# No sample code available

// No sample code available

$httpClient = new \LINE\LINEBot\HTTPClient\CurlHTTPClient('<channel access token>');
$bot = new \LINE\LINEBot($httpClient, ['channelSecret' => '<channel secret>']);
$response = $bot->createChannelAccessToken('<channel id>');

# No sample code available

# No sample code available

// No sample code available

Response

Returns a 200 HTTP status code and a JSON object with the following information.

Property Type Description
access_token String Short-lived channel access token. Valid for 30 days.
Note: Channel access tokens cannot be refreshed.
expires_in Number Time until channel access token expires in seconds from time the token is issued
token_type String Bearer

Example response

{
"access_token":"W1TeHCgfH2Liwa.....",
"expires_in":2592000,
"token_type":"Bearer"
}

Error response

Returns a 400 HTTP status code and a JSON object with the following information.

Property Type Description
error String Error summary
error_description String Details of the error. Not returned in certain situations.

Example error response

{
"error":"invalid_request",
"error_description":"some parameters missed or invalid"
}

Revoke channel access token

Revokes a channel access token.

HTTP request

Request headers

Request header Description
Content-Type application/x-www-form-urlencoded

Request body

Field Type Description
access_token String Channel access token

Response

Returns the status code 200 and an empty response body. No error occurs if an invalid channel access token is specified.

Example request

curl -v -X POST https://api.line.me/v2/oauth/revoke \
-H "Content-Type: application/x-www-form-urlencoded" \
--data-urlencode 'access_token={channel access token}'

// No sample code available

# No sample code available

// No sample code available

$httpClient = new \LINE\LINEBot\HTTPClient\CurlHTTPClient('<channel access token>');
$bot = new \LINE\LINEBot($httpClient, ['channelSecret' => '<channel secret>']);
$response = $bot->revokeChannelAccessToken('<channel access token>');

# No sample code available

# No sample code available

// No sample code available

Error response

Returns a 400 HTTP status code and a JSON object with the following information.

Property Type Description
error String Error summary
error_description String Details of the error. Not returned in certain situations.

Example error response

{
"error":"invalid_request",
"error_description":"some parameters missed or invalid"
}

Message

Send reply message

Sends a reply message in response to an event from a user, group, or room.

To send reply messages, you must have a reply token which is included in a webhook event object.

Webhooks are used to notify you when an event occurs. For events that you can respond to, a reply token is issued for replying to messages.

Because the reply token becomes invalid after a certain period of time, responses should be sent as soon as a message is received. Reply tokens can only be used once.

HTTP request

POST https://api.line.me/v2/bot/message/reply

Request headers

Request header Description
Content-Type application/json
Authorization Bearer {channel access token}

Request body

Property Type Required Description
replyToken String Required Reply token received via webhook
messages Array of message objects Required Messages
Max: 5
notificationDisabled Boolean Optional
  • true: The user doesn't receive a push notification when the message is sent.
  • false: The user receives a push notification when the message is sent (unless they have disabled push notifications in LINE and/or their device).
Default: false

Example request

curl -v -X POST https://api.line.me/v2/bot/message/reply \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer {channel access token}' \
-d '{
    "replyToken":"nHuyWiB7yP5Zw52FIkcQobQuGDXCTA",
    "messages":[
        {
            "type":"text",
            "text":"Hello, user"
        },
        {
            "type":"text",
            "text":"May I help you?"
        }
    ]
}'

final LineMessagingClient client = LineMessagingClient
        .builder("<channel access token>")
        .build();

final TextMessage textMessage = new TextMessage("hello");
final ReplyMessage replyMessage = new ReplyMessage(
        "<replyToken>",
        textMessage);

final BotApiResponse botApiResponse;
try {
    botApiResponse = client.replyMessage(replyMessage).get();
} catch (InterruptedException | ExecutionException e) {
    e.printStackTrace();
    return;
}

System.out.println(botApiResponse);

bot, err := linebot.New(<channel secret>, <channel token>)
if err != nil {
    ...
}
if _, err := bot.ReplyMessage(<replyToken>, linebot.NewTextMessage("hello")).Do(); err != nil {
    ...
}

message = {
  type: 'text',
  text: 'hello'
}
client = Line::Bot::Client.new { |config|
    config.channel_secret = "<channel secret>"
    config.channel_token = "<channel access token>"
}
response = client.reply_message("<replyToken>", message)
p response

$httpClient = new \LINE\LINEBot\HTTPClient\CurlHTTPClient('<channel access token>');
$bot = new \LINE\LINEBot($httpClient, ['channelSecret' => '<channel secret>']);

$textMessageBuilder = new \LINE\LINEBot\MessageBuilder\TextMessageBuilder('hello');
$response = $bot->replyMessage('<replyToken>', $textMessageBuilder);

echo $response->getHTTPStatus() . ' ' . $response->getRawBody();

use LINE::Bot::API;
use LINE::Bot::API::Builder::SendMessage;

my $bot = LINE::Bot::API->new(
    channel_secret       => "<channel secret>",
    channel_access_token => "<channel access token>",
);

my $messages = LINE::Bot::API::Builder::SendMessage->new(
)->add_text(
    text => 'hello',
);
my $res = $bot->reply_message("<replyToken>", $messages->build);
unless ($res->is_success) {
    # error handling
    ....
}

from linebot import LineBotApi
from linebot.models import TextSendMessage
from linebot.exceptions import LineBotApiError

line_bot_api = LineBotApi('<channel access token>')

try:
    line_bot_api.reply_message('<reply_token>', TextSendMessage(text='Hello World!'))
except LineBotApiError as e:
    # error handle
    ...

const line = require('@line/bot-sdk');

const client = new line.Client({
  channelAccessToken: '<channel access token>'
});

const message = {
  type: 'text',
  text: 'Hello World!'
};

client.replyMessage('<replyToken>', message)
  .then(() => {
    ...
  })
  .catch((err) => {
    // error handling
  });

Response

Returns the status code 200 and an empty JSON object.

Example response

{}

Send push message

Sends a push message to a user, group, or room at any time.

Note: LINE@ accounts under the free or basic plan cannot call this API endpoint.

HTTP request

POST https://api.line.me/v2/bot/message/push

Request headers

Request header Description
Content-Type application/json
Authorization Bearer {channel access token}

Request body

Property Type Required Description
to String Required ID of the target recipient. Use a userId, groupId, or roomId value returned in a webhook event object. Do not use the LINE ID found on LINE.
messages Array of message objects Required Messages
Max: 5
notificationDisabled Boolean Optional
  • true: The user doesn't receive a push notification when the message is sent.
  • false: The user receives a push notification when the message is sent (unless they have disabled push notifications in LINE and/or their device).
Default: false

Example request

curl -v -X POST https://api.line.me/v2/bot/message/push \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer {channel access token}' \
-d '{
    "to": "U4af4980629...",
    "messages":[
        {
            "type":"text",
            "text":"Hello, world1"
        },
        {
            "type":"text",
            "text":"Hello, world2"
        }
    ]
}'

final LineMessagingClient client = LineMessagingClient
        .builder("<channel access token>")
        .build();

final TextMessage textMessage = new TextMessage("hello");
final PushMessage pushMessage = new PushMessage(
        "<to>",
        textMessage);

final BotApiResponse botApiResponse;
try {
    botApiResponse = client.pushMessage(pushMessage).get();
} catch (InterruptedException | ExecutionException e) {
    e.printStackTrace();
    return;
}

System.out.println(botApiResponse);

bot, err := linebot.New(<channel secret>, <channel token>)
if err != nil {
    ...
}
if _, err := bot.PushMessage(<to>, linebot.NewTextMessage("hello")).Do(); err != nil {
    ...
}

message = {
  type: 'text',
  text: 'hello'
}
client = Line::Bot::Client.new { |config|
    config.channel_secret = "<channel secret>"
    config.channel_token = "<channel access token>"
}
response = client.push_message("<to>", message)
p response

$httpClient = new \LINE\LINEBot\HTTPClient\CurlHTTPClient('<channel access token>');
$bot = new \LINE\LINEBot($httpClient, ['channelSecret' => '<channel secret>']);

$textMessageBuilder = new \LINE\LINEBot\MessageBuilder\TextMessageBuilder('hello');
$response = $bot->pushMessage('<to>', $textMessageBuilder);

echo $response->getHTTPStatus() . ' ' . $response->getRawBody();

use LINE::Bot::API;
use LINE::Bot::API::Builder::SendMessage;

my $bot = LINE::Bot::API->new(
    channel_secret       => "<channel secret>",
    channel_access_token => "<channel access token>",
);

my $messages = LINE::Bot::API::Builder::SendMessage->new(
)->add_text(
    text => 'hello',
);
my $res = $bot->push_message("<to>", $messages->build);
unless ($res->is_success) {
    # error handling
    ....
}

from linebot import LineBotApi
from linebot.models import TextSendMessage
from linebot.exceptions import LineBotApiError

line_bot_api = LineBotApi('<channel access token>')

try:
    line_bot_api.push_message('<to>', TextSendMessage(text='Hello World!'))
except LineBotApiError as e:
    # error handle
    ...

const line = require('@line/bot-sdk');

const client = new line.Client({
  channelAccessToken: '<channel access token>'
});

const message = {
  type: 'text',
  text: 'Hello World!'
};

client.pushMessage('<to>', message)
  .then(() => {
    ...
  })
  .catch((err) => {
    // error handling
  });

Response

Returns the status code 200 and an empty JSON object.

Example response

{}

Send multicast message

Sends push messages to multiple users at any time. Messages cannot be sent to groups or rooms.

Note: LINE@ accounts under the free or basic plan cannot call this API endpoint.

HTTP request

POST https://api.line.me/v2/bot/message/multicast

Request headers

Request header Description
Content-Type application/json
Authorization Bearer {channel access token}

Request body

Property Type Required Description
to Array of strings Required Array of user IDs. Use userId values which are returned in webhook event objects. Do not use LINE IDs found on LINE.
Max: 150 user IDs
messages Array of message objects Required Messages
Max: 5
notificationDisabled Boolean Optional
  • true: The user doesn't receive a push notification when the message is sent.
  • false: The user receives a push notification when the message is sent (unless they have disabled push notifications in LINE and/or their device).
Default: false

Example request

curl -v -X POST https://api.line.me/v2/bot/message/multicast \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer {channel access token}' \
-d '{
    "to": ["U4af4980629...","U0c229f96c4..."],
    "messages":[
        {
            "type":"text",
            "text":"Hello, world1"
        },
        {
            "type":"text",
            "text":"Hello, world2"
        }
    ]
}'

// No sample code available

client = Line::Bot::Client.new{ |config|
    config.channel_secret = ENV["<channel secret>"]
    config.channel_token = ENV["<channel token>"]
}
user_ids = [user_id1, user_id2, ...]
client.multicast(user_ids, <message>)

userIDs := []string{ ... }
bot, err := linebot.New(<channel secret>, <channel token>)
if err != nil {
    ...
}
if _, err := bot.Multicast(userIDs, linebot.NewTextMessage("hello")).Do(); err != nil {
    ...
}

$httpClient = new \LINE\LINEBot\HTTPClient\CurlHTTPClient('<channel access token>');
$bot = new \LINE\LINEBot($httpClient, ['channelSecret' => '<channel secret>']);
$userIds = ['<userId1>', '<userId2>', ...];
$bot->multicast($userIds, '<message>');

# No sample code available

line_bot_api.multicast(['<user_id_1>', '<user_id_2>'], TextSendMessage(text='Hello World!'))

const line = require('@line/bot-sdk');

const client = new line.Client({
  channelAccessToken: '<channel access token>'
});

const message1 = {
  type: 'text',
  text: 'Hello,'
};

const message2 = {
  type: 'text',
  text: 'World!'
};

client.multicast(['user_id_1', 'user_id_2', 'room_id_1'], 
  [message1, message2]
)

Response

Returns the status code 200 and an empty JSON object.

Example response

{}

ナローキャストメッセージを送る

★ This section will be translated into English soon.

複数のユーザーに、任意のタイミングでプッシュメッセージを送信します。送信対象は、属性情報（性別や年齢、OSの種類、地域など）やリターゲティング（オーディエンス）を利用して指定できます。グループまたはトークルームにメッセージを送ることはできません。

note 注意

サービス統合前のLINE公式アカウントおよびLINE@アカウントでは、このAPIは使用できません。サービス統合後のLINE公式アカウントに移行してください。詳しくは、「LINE@アカウントの移行」を参照してください。

HTTPリクエスト

POST https://api.line.me/v2/bot/message/narrowcast

リクエストヘッダー

リクエストヘッダー 説明
Authorization Bearer {channel access token}
Content-Type application/json

リクエストボディ

プロパティ タイプ 必須 説明
messages メッセージオブジェクトの配列 必須 送信するメッセージ
最大件数：5
recipient Object 任意 レシピエントオブジェクト。オーディエンスを使用して、送信対象を指定します。
省略すると、LINE公式アカウントを友だち追加したすべてのユーザーが送信対象になります。
filter.demographic Object 任意 デモグラフィックフィルターオブジェクト。友だちの属性情報を使用して、送信対象をフィルタリングできます。
省略すると、属性が「不明」になっているユーザーを含めた全員に配信されます。
limit.max Number 任意 ナローキャストメッセージの最大送信数。このナローキャストメッセージによる送信数を制限する場合に指定します。なお、選択される送信対象は、無作為に抽出されます。
note 最低送信対象数について

送信対象のユーザーの属性を推測できないようにするために、送信対象が「最低送信対象数」よりも少ない場合はナローキャストメッセージは送信できません。「最低送信対象数」は、LINEプラットフォームで定義されており、数値は非公開です。

note 配信可能なメッセージの上限数について

ナローキャストメッセージを送信するときは、recipientプロパティおよびfilter.demographicプロパティの設定にかかわらず、一時的にすべての友だちにメッセージを配信する前提で、配信予定メッセージ数が計算されます。配信予定メッセージ数が、当月分の上限目安を超えた場合は、ナローキャストメッセージを送信できません。

ただし、limit.maxプロパティで設定した最大送信数が、当月分の上限目安を超えなければ、ナローキャストメッセージを送信できます。

note 属性情報の利用について
  • 属性情報は3日前の属性情報を元に絞込みます。
  • 属性を指定しない場合は、属性が「不明」になっているユーザーを含めた全員に配信されます。

リクエストの例

curl -v -X POST https://api.line.me/v2/bot/message/narrowcast \
-H 'Authorization: Bearer {channel access token}' \
-H 'Content-Type: application/json' \
-d '{
    "messages": [
        {
            "type": "text",
            "text": "test message"
        }
    ],
    "recipient": {
        "type": "operator",
        "and": [
            {
                "type": "audience",
                "audienceGroupId": 5614991017776
            },
            {
                "type": "operator",
                "not": {
                    "type": "audience",
                    "requestId": "4389303728991"
                }
            }
        ]
    },
    "filter": {
        "demographic": {
            "type": "operator",
            "or": [
                {
                    "type": "operator",
                    "and": [
                        {
                            "type": "gender",
                            "oneOf": [
                                "male",
                                "female"
                            ]
                        },
                        {
                            "type": "age",
                            "gte": "age_20",
                            "lt": "age_25"
                        },
                        {
                            "type": "appType",
                            "oneOf": [
                                "android",
                                "ios"
                            ]
                        },
                        {
                            "type": "area",
                            "oneOf": [
                                "jp_23",
                                "jp_05"
                            ]
                        },
                        {
                            "type": "subscriptionPeriod",
                            "gte": "day_7",
                            "lt": "day_30"
                        }
                    ]
                },
                {
                    "type": "operator",
                    "and": [
                        {
                            "type": "age",
                            "gte": "age_35",
                            "lt": "age_40"
                        },
                        {
                            "type": "operator",
                            "not": {
                                "type": "gender",
                                "oneOf": [
                                    "male"
                                ]
                            }
                        }
                    ]
                }
            ]
        }
    },
    "limit": {
        "max": 100
    }
}'

// No sample code available

# No sample code available

// No sample code available

// No sample code available

# No sample code available

# No sample code available

// No sample code available
レシピエントオブジェクト

レシピエントオブジェクトは、オーディエンスを表すオブジェクトです。演算子オブジェクトを利用すると、条件を組み合わせて、送信対象を指定できます。

  • オーディエンスオブジェクト

    プロパティ タイプ 必須 説明
    type String 必須 audience
    audienceGroupId Number 必須 オーディエンスID。オーディエンスを作成するには、「オーディエンス管理」のAPIを使用します。

  • 演算子オブジェクト

    積集合（AND）、和集合（OR）、差集合（NOT）を使用して、複数のレシピエントオブジェクトから、新たなレシピエントオブジェクトを作成できます。1回のリクエストごとに、レシピエントオブジェクトは、合計10件まで指定できます。

    プロパティ タイプ 必須 説明
    type String 必須 operator
    and レシピエントオブジェクトの配列 ※ 配列で指定したレシピエントオブジェクトの積集合（AND）を、新たなレシピエントオブジェクトとする
    or レシピエントオブジェクトの配列 ※ 配列で指定したレシピエントオブジェクトの和集合（OR）を、新たなレシピエントオブジェクトとする
    not レシピエントオブジェクトの配列 ※ 配列で指定したレシピエントオブジェクトを配信対象外にした、新たなレシピエントオブジェクトとする

    ※andプロパティ、orプロパティ、notプロパティのいずれか1つだけ、必ず指定してください。また、空配列は指定できません。

オーディエンスを表すレシピエントオブジェクトの例

{
    "type": "operator",
    "and": [
        {
            "type": "audience",
            "audienceGroupId": 5614991017776
        },
        {
            "type": "operator",
            "not": {
                "type": "audience",
                "audienceGroupId": 4389303728991
            }
        }
    ]
}
デモグラフィックフィルターオブジェクト

デモグラフィックフィルターオブジェクトは、送信対象をフィルタリングする条件（性別、年齢、OSの種類、地域、友だち期間）を表すオブジェクトです。演算子オブジェクトを利用すると、条件を組み合わせて、送信対象をフィルタリングできます。

  • 性別

    プロパティ タイプ 必須 説明
    type String 必須 gender
    oneOf String 必須 指定した性別を送信対象とします。以下のいずれかの値を指定します。
    • male：男性
    • female：女性

  • 年齢

    年齢の範囲を指定してフィルタリングします。

    プロパティ タイプ 必須 説明
    type String 必須 age
    gte String ※ 指定した年齢以上を送信対象とします。以下のいずれかの値を指定します。
    • age_15
    • age_20
    • age_25
    • age_30
    • age_35
    • age_40
    • age_45
    • age_50
    lt String ※ 指定した年齢未満を送信対象とします。gteプロパティと同じ値を指定できます。

    ※gteプロパティまたはltプロパティの両方またはいずれか一方を、必ず指定してください。

  • OSの種類

    プロパティ タイプ 必須 説明
    type String 必須 appType
    oneOf String 必須 指定したOSを送信対象とします。以下のいずれかの値を指定します。
    • ios
    • android

  • 地域

    プロパティ タイプ 必須 説明
    type String 必須 appType
    oneOf String 必須 指定した地域を送信対象とします。以下のいずれかの値を指定します。
    日本 // JP (country code=392)
    • jp_01：北海道 // Hokkaido
    • jp_02：青森県 // Aomori
    • jp_03：岩手県 // Iwate
    • jp_04：宮城県 // Miyagi
    • jp_05：秋田県 // Akita
    • jp_06：山形県 // Yamagata
    • jp_07：福島県 // Fukushima
    • jp_08：茨城県 // Ibaraki
    • jp_09：栃木県 // Tochigi
    • jp_10：群馬県 // Gunma
    • jp_11：埼玉県 // Saitama
    • jp_12：千葉県 // Chiba
    • jp_13：東京都 // Tokyo
    • jp_14：神奈川県 // Kanagawa
    • jp_15：新潟県 // Niigata
    • jp_16：富山県 // Toyama
    • jp_17：石川県 // Ishikawa
    • jp_18：福井県 // Fukui
    • jp_19：山梨県 // Yamanashi
    • jp_20：長野県 // Nagano
    • jp_21：岐阜県 // Gifu
    • jp_22：静岡県 // Shizuoka
    • jp_23：愛知県 // Aichi
    • jp_24：三重県 // Mie
    • jp_25：滋賀県 // Shiga
    • jp_26：京都府 // Kyoto
    • jp_27：大阪府 // Osaka
    • jp_28：兵庫県 // Hyougo
    • jp_29：奈良県 // Nara
    • jp_30：和歌山県 // Wakayama
    • jp_31：鳥取県 // Tottori
    • jp_32：島根県 // Shimane
    • jp_33：岡山県 // Okayama
    • jp_34：広島県 // Hiroshima
    • jp_35：山口県 // Yamaguchi
    • jp_36：徳島県 // Tokushima
    • jp_37：香川県 // Kagawa
    • jp_38：愛媛県 // Ehime
    • jp_39：高知県 // Kouchi
    • jp_40：福岡県 // Fukuoka
    • jp_41：佐賀県 // Saga
    • jp_42：長崎県 // Nagasaki
    • jp_43：熊本県 // Kumamoto
    • jp_44：大分県 // Oita
    • jp_45：宮崎県 // Miyazaki
    • jp_46：鹿児島県 // Kagoshima
    • jp_47：沖縄県 // Okinawa
    台湾 // TW (country code=158)
    • tw_01：台北市 // Taipei City
    • tw_02：新北市 // New Taipei City
    • tw_03：桃園市 // Taoyuan City
    • tw_04：台中市 // Taichung City
    • tw_05：台南市 // Tainan City
    • tw_06：高雄市 // Kaohsiung City
    • tw_07：基隆市 // Keelung City
    • tw_08：新竹市 // Hsinchu City
    • tw_09：嘉義市 // Chiayi City
    • tw_10：新竹県 // Hsinchu County
    • tw_11：苗栗県 // Miaoli County
    • tw_12：彰化県 // Changhua County
    • tw_13：南投県 // Nantou County
    • tw_14：雲林県 // Yunlin County
    • tw_15：嘉義県 // Chiayi County
    • tw_16：屏東県 // Pingtung County
    • tw_17：宜蘭県 // Yilan County
    • tw_18：花蓮県 // Hualien County
    • tw_19：台東県 // Taitung County
    • tw_20：澎湖県 // Penghu County
    • tw_21：金門県 // Kinmen County
    • tw_22：連江県 // Lienchiang County
    タイ // TH (country code=764)
    • th_01：バンコク // Bangkok
    • th_02：パタヤ // Pattaya
    • th_03：北部 // Northern
    • th_04：中央部 // Central
    • th_05：南部 // Southern
    • th_06：東部 // Eastern
    • th_07：東北部 // NorthEastern
    • th_08：西部 // Western
    インドネシア // ID (country code=360)
    • id_01：バリ // Bali
    • id_02：バンドン // Bandung
    • id_03：バンジャルマシン // Banjarmasin
    • id_04：ジャボデタベック（ジャカルタ首都圏） // Jabodetabek
    • id_06：マカッサル // Makassar
    • id_07：メダン // Medan
    • id_08：パレンバン // Palembang
    • id_09：サマリンダ // Samarinda
    • id_10：スマラン // Semarang
    • id_11：スラバヤ // Surabaya
    • id_12：ジョグジャカルタ // Yogyakarta
    • id_05：その他のエリア // Lainnya

  • 友だち期間

    友だち期間の範囲を指定してフィルタリングします。

    プロパティ タイプ 必須 説明
    type String 必須 subscriptionPeriod
    gte String ※ 指定した日数以上を送信対象とします。以下のいずれかの値を指定します。
    • day_7
    • day_30
    • day_90
    • day_180
    • day_365
    lt String ※ 指定した日数未満を送信対象とします。gteプロパティと同じ値を指定できます。

    ※gteプロパティまたはltプロパティの両方またはいずれか一方を、必ず指定してください。

  • 演算子オブジェクト

    積集合（AND）、和集合（OR）、差集合（NOT）を使用して、複数のデモグラフィックフィルターオブジェクトから、新たなデモグラフィックフィルターオブジェクトを作成できます。1回のリクエストごとに、デモグラフィックフィルターオブジェクトは、合計10件まで指定できます。

    プロパティ タイプ 必須 説明
    type String 必須 operator
    and デモグラフィックフィルターオブジェクトの配列 ※ 配列で指定したデモグラフィックフィルターオブジェクトの積集合（AND）を、新たなデモグラフィックフィルターオブジェクトとする
    or デモグラフィックフィルターオブジェクトの配列 ※ 配列で指定したデモグラフィックフィルターオブジェクトの和集合（OR）を、新たなデモグラフィックフィルターオブジェクトとする
    not デモグラフィックフィルターオブジェクトの配列 ※ 配列で指定したデモグラフィックフィルターオブジェクトを配信対象外にした、新たなデモグラフィックフィルターオブジェクトとする

    ※andプロパティ、orプロパティ、notプロパティのいずれか1つだけ、必ず指定してください。また、空配列は指定できません。

レスポンス

HTTPステータスコード202を返します。

ナローキャストメッセージの送信状況を確認する方法について詳しくは、「ナローキャストメッセージの進行状況を取得する」を参照してください。

性別を使用してフィルタリングするデモグラフィックフィルターオブジェクトの例

{
    "type": "gender",
    "oneOf": [
        "male",
        "female"
    ]
}

ナローキャストメッセージの進行状況を取得する

★ This section will be translated into English soon.

ナローキャストメッセージの進行状況を取得します。

note 注意

サービス統合前のLINE公式アカウントおよびLINE@アカウントでは、このAPIは使用できません。サービス統合後のLINE公式アカウントに移行してください。詳しくは、「LINE@アカウントの移行」を参照してください。

note 最低送信対象数について

送信対象のユーザーの属性を推測できないようにするために、送信対象が「最低送信対象数」よりも少ない場合はナローキャストメッセージは送信できません。「最低送信対象数」は、LINEプラットフォームで定義されており、数値は非公開です。

note 進行状況を取得できる期間

ナローキャストメッセージの送信をリクエストしてから7日以上経過すると、進行状況は取得できません。

HTTPリクエスト

GET /v2/bot/message/progress/narrowcast

リクエストヘッダー

リクエストヘッダー 説明
Authorization Bearer {channel access token}

クエリパラメータ

パラメータ | 必須 | 説明 -|- requestId | 必須 | ナローキャストメッセージのリクエストID。リクエストIDは、Messaging APIのリクエストごとに発行されるIDです。レスポンスヘッダーに含まれます。

レスポンス

HTTPステータスコード200と以下の情報を含むJSONオブジェクトを返します。

プロパティ タイプ 説明
phase String 進行状況。以下のいずれかの値です。
  • waiting：送信準備ができていません。フィルタリングなどを行っています。
  • sending：送信中です。
  • succeeded：送信が成功しました。
  • failed：送信が失敗しました。failedDescriptionプロパティで失敗した理由を確認できます。
successCount Number メッセージの受信に成功したユーザー数（※）
failureCount Number メッセージの受信に失敗したユーザー数（※）
targetCount Number メッセージが配信される予定のユーザー数（※）
failedDescription String 送信が失敗した理由。phaseプロパティがfailedの場合にのみ含まれます。
errorCode Number エラーの概要。以下のいずれかの値です。
  • 1：内部エラーが発生しました。
  • 2：送信対象が少なすぎたためエラーになりました。

※phaseプロパティがwaitingの場合は取得できません。

エラーレスポンス

ナローキャストメッセージ以外のリクエストIDを指定した場合や、無効なリクエストIDを指定した場合は、HTTPステータスコード404を返します。

リクエストの例

curl -v -X GET https://api.line.me/v2/bot/message/progress/narrowcast?requestId={request_id} \
-H 'Authorization: Bearer {channel access token}'

// No sample code available

# No sample code available

// No sample code available

// No sample code available

# No sample code available

# No sample code available

// No sample code available

Send broadcast message

Sends push messages to multiple users at any time.

note LINE official account migration

You can't call this API with a LINE@ account or LINE official account that hasn't been migrated to the account plans implemented on April 18, 2019. Please migrate your account first. For more information, see Migration of LINE@ accounts.

HTTP request

POST https://api.line.me/v2/bot/message/broadcast

Request headers

Request header Description
Content-Type application/json
Authorization Bearer {channel access token}

Request body

Property Type Required Description
messages Array of message objects Required Messages
Max: 5
notificationDisabled Boolean Optional
  • true: The user doesn't receive a push notification when the message is sent.
  • false: The user receives a push notification when the message is sent (unless they have disabled push notifications in LINE and/or their device).
Default: false

Example request

curl -v -X POST https://api.line.me/v2/bot/message/broadcast \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer {channel access token}' \
-d '{
    "messages":[
        {
            "type":"text",
            "text":"Hello, world1"
        },
        {
            "type":"text",
            "text":"Hello, world2"
        }
    ]
}'

// No sample code available

# No sample code available

// No sample code available

// No sample code available

# No sample code available

# No sample code available

// No sample code available

Response

Returns the status code 200 and an empty JSON object.

Example response

{}

Get content

Gets images, videos, audio, and files sent by users.

HTTP request

GET https://api-data.line.me/v2/bot/message/{messageId}/content

Request headers

Request header Description
Authorization Bearer {channel access token}

Path parameters

Parameter Description
messageId Message ID

Response

Returns status code 200 and the content in binary.

Content is automatically deleted after a certain period from when the message was sent. There is no guarantee for how long content is stored.

Example request

curl -v -X GET https://api-data.line.me/v2/bot/message/{messageId}/content \
-H 'Authorization: Bearer {channel access token}'

final LineMessagingClient client = LineMessagingClient
        .builder("<channel access token>")
        .build();

final MessageContentResponse messageContentResponse;
try {
    messageContentResponse = client.getMessageContent("<messageId>").get();
} catch (InterruptedException | ExecutionException e) {
    e.printStackTrace();
    return;
}

Files.copy(messageContentResponse.getStream(),
           Files.createTempFile("foo", "bar"));

bot, err := linebot.New(<channel secret>, <channel token>)
if err != nil {
    ...
}
content, err := bot.GetMessageContent(<messageID>).Do()
if err != nil {
    ...
}
defer content.Content.Close()

...

client = Line::Bot::Client.new { |config|
    config.channel_secret = "<channel secret>"
    config.channel_token = "<channel access token>"
}
response = client.get_message_content("<messageId>")
case response
when Net::HTTPSuccess then
  tf = Tempfile.open("content")
  tf.write(response.body)
else
  p "#{response.code} #{response.body}"
end

$httpClient = new \LINE\LINEBot\HTTPClient\CurlHTTPClient('<channel access token>');
$bot = new \LINE\LINEBot($httpClient, ['channelSecret' => '<channel secret>']);
$response = $bot->getMessageContent('<messageId>');
if ($response->isSucceeded()) {
    $tempfile = tmpfile();
    fwrite($tempfile, $response->getRawBody());
} else {
    error_log($response->getHTTPStatus() . ' ' . $response->getRawBody());
}

use LINE::Bot::API;

my $bot = LINE::Bot::API->new(
    channel_secret       => "<channel secret>",
    channel_access_token => "<channel access token>",
);

my $res = $bot->get_message_content("<messageId>");
unless ($res->is_success) {
    # error handling
    ....
}
my $filename = $ret->fh->filename;
open my $fh, '<', $file or die "$!: $file";

from linebot import LineBotApi

line_bot_api = LineBotApi('<channel access token>')

message_content = line_bot_api.get_message_content('<message_id>')
with open(file_path, 'wb') as fd:
    for chunk in message_content.iter_content():
        fd.write(chunk)

const line = require('@line/bot-sdk');

const client = new line.Client({
  channelAccessToken: '<channel access token>'
});

client.getMessageContent('<messageId>')
  .then((stream) => {
    stream.on('data', (chunk) => {
      ...
    });
    stream.on('error', (err) => {
      // error handling
    });
  });

Get the target limit for additional messages

Gets the target limit for additional messages in the current month.

The number of messages retrieved by this operation includes the number of messages sent from LINE Official Account Manager.

Set a target limit with LINE Official Account Manager. For the procedures, refer to the LINE Official Account Manager manual.

Note: LINE@ accounts cannot call this API endpoint.

HTTP request

Request headers

Request header Description
Authorization Bearer {channel access token}

Example request

curl -v -X GET https://api.line.me/v2/bot/message/quota \
-H 'Authorization: Bearer {channel access token}'

// No sample code available

# No sample code available

// No sample code available

// No sample code available

# No sample code available

# No sample code available

// No sample code available

Response

Returns the status code 200 and a JSON object with the following information.

Property Type Description
type String One of the following values to indicate whether a target limit is set or not.
  • none. This indicates that a target limit is not set.
  • limited. This indicates that a target limit is set.
value Number The target limit for additional messages in the current month. This property is returned when the type property has a value of limited.

Example response

{
  "type":"limited",
  "value":1000
}

Get number of messages sent this month

Gets the number of messages sent in the current month.

The number of messages retrieved by this operation includes the number of messages sent from LINE Official Account Manager.

The number of messages retrieved by this operation is approximate. To get the correct number of sent messages, use LINE Official Account Manager or execute API operations for getting the number of sent messages.

Note: LINE@ accounts cannot call this API endpoint.

HTTP request

Request headers

Request header Description
Authorization Bearer {channel access token}

Example request

curl -v -X GET https://api.line.me/v2/bot/message/quota/consumption \
-H 'Authorization: Bearer {channel access token}'

// No sample code available

# No sample code available

// No sample code available

// No sample code available

# No sample code available

# No sample code available

// No sample code available

Response

Returns the status code 200 and a JSON object with the following information.

Property Type Description
totalUsage Number The number of sent messages in the current month

Example response

{
  "totalUsage":"500"
}

Get number of sent reply messages

Gets the number of messages sent with the /bot/message/reply endpoint.

The number of messages retrieved by this operation does not include the number of messages sent from LINE Official Account Manager.

HTTP request

Request headers

Request header Description
Authorization Bearer {channel access token}

Query parameters

Parameter Required Description
date Required Date the messages were sent
  • Format: yyyyMMdd (Example: 20191231)
  • Timezone: UTC+9

Example request

curl -v -X GET https://api.line.me/v2/bot/message/delivery/reply?date={yyyyMMdd} \
-H 'Authorization: Bearer {channel access token}'

// No sample code available

# No sample code available

// No sample code available

// No sample code available

# No sample code available

# No sample code available

// No sample code available

Response

Returns the status code 200 and a JSON object with the following information.

Property Type Description
status String Status of the counting process. One of the following values is returned:
  • ready: You can get the number of messages.
  • unready: The message counting process for the date specified in date has not been completed yet. Retry your request later. Normally, the counting process is completed within the next day.
  • out_of_service: The date specified in date is earlier than March 31, 2018, when the operation of the counting system started.
success Number The number of messages sent with the Messaging API on the date specified in date. The response has this property only when the value of status is ready.

Example response

{
  "status":"ready",
  "success":10000
}

Get number of sent push messages

Gets the number of messages sent with the /bot/message/push endpoint.

The number of messages retrieved by this operation does not include the number of messages sent from LINE Official Account Manager.

Note: LINE@ accounts under the free or basic plan cannot call this API endpoint.

HTTP request

Request headers

Request header Description
Authorization Bearer {channel access token}

Query parameters

Parameter Required Description
date Required Date the messages were sent
  • Format: yyyyMMdd (Example: 20191231)
  • Timezone: UTC+9

Example request

curl -v -X GET https://api.line.me/v2/bot/message/delivery/push?date={yyyyMMdd} \
-H 'Authorization: Bearer {channel access token}'

// No sample code available

# No sample code available

// No sample code available

// No sample code available

# No sample code available

# No sample code available

// No sample code available

Response

Returns the status code 200 and a JSON object with the following information.

Property Type Description
status String Status of the counting process. One of the following values is returned:
  • ready: You can get the number of messages.
  • unready: The message counting process for the date specified in date has not been completed yet. Retry your request later. Normally, the counting process is completed within the next day.
  • out_of_service: The date specified in date is earlier than March 31, 2018, when the operation of the counting system started.
success Number The number of messages sent with the Messaging API on the date specified in date. The response has this property only when the value of status is ready.

Example response

{
  "status":"ready",
  "success":10000
}

Get number of sent multicast messages

Gets the number of messages sent with the /bot/message/multicast endpoint.

The number of messages retrieved by this operation does not include the number of messages sent from LINE Official Account Manager.

Note: LINE@ accounts under the free or basic plan cannot call this API endpoint.

HTTP request

Request headers

Request header Description
Authorization Bearer {channel access token}

Query parameters

Parameter Required Description
date Required Date the messages were sent
  • Format: yyyyMMdd (Example: 20191231)
  • Timezone: UTC+9

Example request

curl -v -X GET https://api.line.me/v2/bot/message/delivery/multicast?date={yyyyMMdd} \
-H 'Authorization: Bearer {channel access token}'

// No sample code available

# No sample code available

// No sample code available

// No sample code available

# No sample code available

# No sample code available

// No sample code available

Response

Returns the status code 200 and a JSON object with the following information.

Property Type Description
status String Status of the counting process. One of the following values is returned:
  • ready: You can get the number of messages.
  • unready: The message counting process for the date specified in date has not been completed yet. Retry your request later. Normally, the counting process is completed within the next day.
  • out_of_service: The date specified in date is earlier than March 31, 2018, when the operation of the counting system started.
success Number The number of messages sent with the Messaging API on the date specified in date. The response has this property only when the value of status is ready.

Example response

{
  "status":"ready",
  "success":10000
}

Get number of sent broadcast messages

Gets the number of messages sent with the /bot/message/broadcast endpoint.

The number of messages retrieved by this operation does not include the number of messages sent from LINE Official Account Manager.

note LINE official account migration

You can't call this API with a LINE@ account or LINE official account that hasn't been migrated to the account plans implemented on April 18, 2019. Please migrate your account first. For more information, see Migration of LINE@ accounts.

HTTP request

GET https://api.line.me/v2/bot/message/delivery/broadcast

Request headers

Request header Description
Authorization Bearer {channel access token}

Query parameters

Parameter Required Description
date Required Date the messages were sent
  • Format: yyyyMMdd (Example: 20191231)
  • Timezone: UTC+9

Example request

curl -v -X GET https://api.line.me/v2/bot/message/delivery/broadcast?date={yyyyMMdd} \
-H 'Authorization: Bearer {channel access token}'

// No sample code available

# No sample code available

// No sample code available

// No sample code available

# No sample code available

# No sample code available

// No sample code available

Response

Returns the status code 200 and a JSON object with the following information.

Property Type Description
status String Status of the counting process. One of the following values is returned:
  • ready: You can get the number of messages.
  • unready: The message counting process for the date specified in date has not been completed yet. Retry your request later. Normally, the counting process is completed within the next day.
  • out_of_service: The date specified in date is earlier than March 31, 2018, when the operation of the counting system started.
success Number The number of messages sent with the Messaging API on the date specified in date. The response has this property only when the value of status is ready.

Example response

{
  "status":"ready",
  "success":10000
}

オーディエンス管理

★ This section will be translated into English soon.

オーディエンスを作成して、メッセージを配信できます。なお、日本（JP）、タイ（TH）、台湾（TW）のユーザーが作成したLINE公式アカウントの場合のみ、オーディエンスを利用できます。

なお、オーディエンスには、以下の3種類があります。

ユーザーIDアップロード用のオーディエンスを作成する

★ This section will be translated into English soon.

ユーザーIDアップロード用のオーディエンスを作成します。オーディエンスは、合計1,000件まで作成できます。

ユーザーIDは、以下の方法で取得できます。

note 送信対象アカウントをIFAで指定するには手続きが必要です

送信対象アカウントをIFAで指定することもできますが、この機能をご利用いただくためには、所定の申請等が必要です。詳しくは、担当営業までご連絡いただくか、LINE for Businessウェブサイトからお問い合わせください。

HTTPリクエスト

POST https://api.line.me/v2/bot/audienceGroup/upload

リクエストヘッダー

リクエストヘッダー 説明
Authorization Bearer {channel access token}
Content-Type application/json

リクエストボディ

プロパティ タイプ 必須 説明
description String 必須 オーディエンスの名前。他のオーディエンスと同じ名前は設定できません。なお、大文字と小文字は区別されません。
最大文字数：120
isIfaAudience Boolean 必須 送信対象アカウントをユーザーIDで指定する場合は、falseを指定します（標準）。送信対象アカウントをIFAで指定する場合は、trueを指定します。
uploadDescription String 任意 ジョブ（jobs[].description）に登録する説明
audiences Array 必須 ユーザーIDまたはIFAの配列
最大件数：10,000
audiences[].id String 必須 ユーザーIDまたはIFA

リクエストの例

curl -v -X POST https://api.line.me/v2/bot/audienceGroup/upload \
-H 'Authorization: Bearer {channel access token}' \
-H 'Content-Type: application/json' \
-d '{
    "description": "audienceGroupName",
    "isIfaAudience": "false"
}'

// No sample code available

# No sample code available

// No sample code available

// No sample code available

# No sample code available

# No sample code available

// No sample code available

レスポンス

HTTPステータスコード202とオーディエンスを返します。

プロパティ タイプ 説明
audienceGroupId Number オーディエンスID
type String UPLOAD
description String オーディエンスの名前
created Number オーディエンスが作成された時刻のUNIXタイム

エラーレスポンス

HTTPステータスコード400と以下の情報を含むJSONオブジェクトを返します。

プロパティ タイプ 説明
message String エラーの概要
details String エラーの内容。以下のいずれかの値です。
  • AUDIENCE_GROUP_COUNT_MAX_OVER：作成できるオーディエンス数の上限（合計1,000件）に達しています。
  • AUDIENCE_GROUP_NAME_SIZE_OVER：オーディエンスの名前が長すぎます。
  • AUDIENCE_GROUP_NAME_DUPLICATE：既存のオーディエンスと同じ名前を指定しました。
  • AUDIENCE_GROUP_NAME_WRONG：オーディエンスの名前に、無効な文字（例：\nなどの制御コード）を指定しました。
  • AUDIENCE_GROUP_MISSING_AUDIENCES：audiencesプロパティが見つかりません。または、audiences[].idにユーザーIDまたはIFAが指定されていません。
  • AUDIENCE_GROUP_MISSING_IS_IFA_AUDIENCE：isIfaAudienceプロパティが見つかりません。
  • UPLOAD_AUDIENCE_GROUP_INVALID_AUDIENCE_ID_FORMAT：audiences[].idプロパティに無効なユーザーIDまたはIFAが指定されています。
  • UPLOAD_AUDIENCE_GROUP_TOO_MANY_AUDIENCE_IDS：ユーザーIDまたはIFAの登録上限に達しています。

レスポンスの例

{
    "audienceGroupId": 4389303728991,
    "type": "UPLOAD",
    "description": "test",
    "created": 1500351844
}

ユーザーIDアップロード用のオーディエンスにユーザーIDまたはIFAを追加する

★ This section will be translated into English soon.

ユーザーIDアップロード用のオーディエンスに、ユーザーIDまたはIFAを追加します。

note リクエストタイムアウト値について

リクエストタイムアウトを30秒以上に設定することを強く推奨します。

note ユーザーIDまたはIFAの種類は変更できません

ユーザーIDアップロード用のオーディエンスを作成したときと同じ種類（ユーザーIDまたはIFA）のデータを追加してください。たとえば、初めにIFAを指定して作成したオーディエンスに、ユーザーIDを指定することはできません。

オーディエンスを作成したときに指定した送信対象アカウントの種類（ユーザーIDまたはIFA）は、オーディエンスのisIfaAudienceプロパティで確認できます。詳しくは、「オーディエンスの情報を取得する」を参照してください。

note ユーザーIDまたはIFAは削除できません

一度追加したユーザーIDまたはIFAを削除することはできません。

HTTPリクエスト

PUT https://api.line.me/v2/bot/audienceGroup/upload

リクエストヘッダー

リクエストヘッダー 説明
Authorization Bearer {channel access token}
Content-Type application/json

リクエストボディ

プロパティ タイプ 必須 説明
audienceGroupId Number 必須 オーディエンスID
description String 任意 オーディエンスの名前。他のオーディエンスと同じ名前は設定できません。なお、大文字と小文字は区別されません。
最大文字数：120
uploadDescription String 任意 ジョブ（jobs[].description）に登録する説明
audiences Array 必須 ユーザーIDまたはIFAの配列
最大件数：10,000
audiences[].id String 必須 ユーザーIDまたはIFA

レスポンス

HTTPステータスコード202を返します。

エラーレスポンス

HTTPステータスコード400と以下の情報を含むJSONオブジェクトを返します。

プロパティ タイプ 説明
message String エラーの概要
details String エラーの内容。以下のいずれかの値です。
  • AUDIENCE_GROUP_NAME_SIZE_OVER：オーディエンスの名前が長すぎます。
  • AUDIENCE_GROUP_NAME_DUPLICATE：既存のオーディエンスと同じ名前を指定しました。
  • AUDIENCE_GROUP_NAME_WRONG：オーディエンスの名前に、無効な文字（例：\nなどの制御コード）を指定しました。
  • UPLOAD_AUDIENCE_GROUP_INVALID_AUDIENCE_ID_FORMAT：audiences[].idプロパティに無効なユーザーIDまたはIFAが指定されています。
  • UPLOAD_AUDIENCE_GROUP_TOO_MANY_AUDIENCE_IDS：ユーザーIDまたはIFAの登録上限に達しています。
  • UPLOAD_AUDIENCE_GROUP_NO_VALID_AUDIENCE_IDS：有効なユーザーIDまたはIFAが指定されていません。
  • AUDIENCE_GROUP_CAN_NOT_UPLOAD_STATUS_EXPIRED：オーディエンス作成後、180日以上が経過しました。このオーディエンスは使用できません。

リクエストの例

curl -v -X PUT https://api.line.me/v2/bot/audienceGroup/upload \
-H 'Authorization: Bearer {channel access token}' \
-H 'Content-Type: application/json' \
-d '{
    "audienceGroupId": 4389303728991,
    "description": "audienceGroupName",
    "uploadDescription": "fileName",
    "audiences": [
        {
            "id": "u1000"
        },
        {
            "id": "u2000"
        }
    ]
}'

// No sample code available

# No sample code available

// No sample code available

// No sample code available

# No sample code available

# No sample code available

// No sample code available

クリックリターゲティング用のオーディエンスを作成する

★ This section will be translated into English soon.

クリックリターゲティング用のオーディエンスを作成します。オーディエンスは、合計1,000件まで作成できます。

クリックリターゲティング用のオーディエンスは、ブロードキャストメッセージまたはナローキャストメッセージに設定されたURLをクリックしたユーザーを集めたオーディエンスです。

メッセージは、リクエストIDで指定します。少なくとも1つのリンクをクリックしたユーザーが送信対象になります。

HTTPリクエスト

POST https://api.line.me/v2/bot/audienceGroup/click

リクエストヘッダー

リクエストヘッダー 説明
Authorization Bearer {channel access token}
Content-Type application/json

リクエストボディ

プロパティ タイプ 必須 説明
description String 必須 オーディエンスの名前。他のオーディエンスと同じ名前は設定できません。なお、大文字と小文字は区別されません。
最大文字数：120
requestId String 必須 配信から60日以内のブロードキャストメッセージまたはナローキャストメッセージのリクエストID。リクエストIDは、Messaging APIのリクエストごとに発行されるIDです。レスポンスヘッダーに含まれます。
clickUrl String 任意 ユーザーがクリックしたURL。省略した場合は、メッセージ内の任意のURLをクリックしたユーザーが送信対象になります。
最大文字数：2,000

リクエストの例

curl -v -X POST https://api.line.me/v2/bot/audienceGroup/click \
-H 'Authorization: Bearer {channel access token}' \
-H 'Content-Type: application/json' \
-d '{
    "description": "audienceGroupName",
    "messageIds": [
        "123",
        "124"
    ],
    "requestId": "12222",
    "clickUrl": "https://line.me/en"
}'

// No sample code available

# No sample code available

// No sample code available

// No sample code available

# No sample code available

# No sample code available

// No sample code available

レスポンス

HTTPステータスコード202とオーディエンスを返します。

プロパティ タイプ 説明
audienceGroupId Number オーディエンスID
type String CLICK
description String オーディエンスの名前
created Number オーディエンスが作成された時刻のUNIXタイム
requestId String オーディエンスを作成したときに指定したリクエストID
clickUrl String オーディエンスを作成したときに指定したURL

エラーレスポンス

HTTPステータスコード400と以下の情報を含むJSONオブジェクトを返します。

プロパティ タイプ 説明
message String エラーの概要
details String エラーの内容。以下のいずれかの値です。
  • AUDIENCE_GROUP_COUNT_MAX_OVER：作成できるオーディエンス数の上限（合計1,000件）に達しています。
  • AUDIENCE_GROUP_NAME_SIZE_OVER：オーディエンスの名前が長すぎます。
  • AUDIENCE_GROUP_NAME_DUPLICATE：既存のオーディエンスと同じ名前を指定しました。
  • AUDIENCE_GROUP_NAME_WRONG：オーディエンスの名前に、無効な文字（例：\nなどの制御コード）を指定しました。
  • AUDIENCE_GROUP_REQUESTID_DUPLICATE：既存のオーディエンスに指定したリクエストIDと同じ値を指定しました。
  • WRONG_BOT_ID：指定されたリクエストIDに含まれるボットIDが、チャネルに関連付けられたボットと異なります。
  • TOO_OLD_MESSAGES：メッセージを配信してから61日以上経過した場合は、そのメッセージ（リクエストID）に対するオーディエンスは作成できません。

レスポンスの例

{
    "audienceGroupId": 4389303728991,
    "type": "CLICK",
    "description": "test",
    "created": 1500351844,
    "requestId": "f70dd685-499a-4231-a441-f24b8d4fba21",
    "clickUrl": null
}

インプレッションリターゲティング用のオーディエンスを作成する

★ This section will be translated into English soon.

インプレッションリターゲティング用のオーディエンスを作成します。オーディエンスは、合計1,000件まで作成できます。

インプレッションリターゲティング用のオーディエンスは、ブロードキャストメッセージまたはナローキャストメッセージを表示したユーザーを集めたオーディエンスです。

メッセージは、リクエストIDで指定します。少なくとも1つの吹き出しを表示したユーザーが送信対象になります。

HTTPリクエスト

POST https://api.line.me/v2/bot/audienceGroup/imp

リクエストヘッダー

リクエストヘッダー 説明
Authorization Bearer {channel access token}
Content-Type application/json

リクエストボディ

プロパティ タイプ 必須 説明
description String 必須 オーディエンスの名前。他のオーディエンスと同じ名前は設定できません。なお、大文字と小文字は区別されません。
最大文字数：120
requestId String 必須 配信から60日以内のブロードキャストメッセージまたはナローキャストメッセージのリクエストID。リクエストIDは、Messaging APIのリクエストごとに発行されるIDです。レスポンスヘッダーに含まれます。

リクエストの例

curl -v -X POST https://api.line.me/v2/bot/audienceGroup/imp \
-H 'Authorization: Bearer {channel access token}' \
-H 'Content-Type: application/json' \
-d '{
    "description": "audienceGroupName",
    "messageIds": [
        "123",
        "124"
    ],
    "requestId": "12222"
}'

// No sample code available

# No sample code available

// No sample code available

// No sample code available

# No sample code available

# No sample code available

// No sample code available

レスポンス

HTTPステータスコード202とオーディエンスを返します。

プロパティ タイプ 説明
audienceGroupId Number オーディエンスID
type String IMP
description String オーディエンスの名前
created Number オーディエンスが作成された時刻のUNIXタイム
requestId String オーディエンスを作成したときに指定したリクエストID

エラーレスポンス

HTTPステータスコード400と以下の情報を含むJSONオブジェクトを返します。

プロパティ タイプ 説明
message String エラーの概要
details String エラーの内容。以下のいずれかの値です。
  • AUDIENCE_GROUP_COUNT_MAX_OVER：作成できるオーディエンス数の上限（合計1,000件）に達しています。
  • AUDIENCE_GROUP_NAME_SIZE_OVER：オーディエンスの名前が長すぎます。
  • AUDIENCE_GROUP_NAME_DUPLICATE：既存のオーディエンスと同じ名前を指定しました。
  • AUDIENCE_GROUP_NAME_WRONG：オーディエンスの名前に、無効な文字（例：\nなどの制御コード）を指定しました。
  • AUDIENCE_GROUP_REQUESTID_DUPLICATE：既存のオーディエンスに指定したリクエストIDと同じ値を指定しました。
  • WRONG_BOT_ID：指定されたリクエストIDに含まれるボットIDが、チャネルに関連付けられたボットと異なります。
  • TOO_OLD_MESSAGES：メッセージを配信してから60日以上経過した場合は、そのメッセージ（リクエストID）に対するオーディエンスは作成できません。

レスポンスの例

{
    "audienceGroupId": 4389303728991,
    "type": "IMP",
    "description": "test",
    "created": 1500351844,
    "requestId": "f70dd685-499a-4231-a441-f24b8d4fba21"
}

オーディエンスの名前を更新する

★ This section will be translated into English soon.

既存のオーディエンスの名前を変更します。

HTTPリクエスト

PUT https://api.line.me/v2/bot/audienceGroup/{audienceGroupId}/updateDescription

リクエストヘッダー

リクエストヘッダー 説明
Authorization Bearer {channel access token}
Content-Type application/json

パスパラメータ

パラメータ 説明
audienceGroupId オーディエンスID

リクエストボディ

プロパティ タイプ 必須 説明
description String 必須 オーディエンスの名前。他のオーディエンスと同じ名前は設定できません。なお、大文字と小文字は区別されません。
最大文字数：120

レスポンス

HTTPステータスコード200を返します。

エラーレスポンス

HTTPステータスコード400と以下の情報を含むJSONオブジェクトを返します。

プロパティ タイプ 説明
message String エラーの概要
details String エラーの内容。以下のいずれかの値です。
  • AUDIENCE_GROUP_NAME_SIZE_OVER：オーディエンスの名前が長すぎます。
  • AUDIENCE_GROUP_NAME_DUPLICATE：既存のオーディエンスと同じ名前を指定しました。
  • AUDIENCE_GROUP_NAME_WRONG：オーディエンスの名前に、無効な文字（例：\nなどの制御コード）を指定しました。

リクエストの例

curl -v -X PUT https://api.line.me/v2/bot/audienceGroup/{audienceGroupId}/updateDescription \
-H 'Authorization: Bearer {channel access token}' \
-H 'Content-Type: application/json' \
-d '{
    "description": "audienceGroupName"
}'

// No sample code available

# No sample code available

// No sample code available

// No sample code available

# No sample code available

# No sample code available

// No sample code available

オーディエンスを削除する

★ This section will be translated into English soon.

オーディエンスを削除します。

warning 削除したオーディエンスは元に戻せません

削除する前に、オーディエンスが使用されていないことを確認してください。

HTTPリクエスト

DELETE https://api.line.me/v2/bot/audienceGroup/{audienceGroupId}

リクエストヘッダー

リクエストヘッダー 説明
Authorization Bearer {channel access token}

パスパラメータ

パラメータ 説明
audienceGroupId オーディエンスID

レスポンス

HTTPステータスコード202を返します。

エラーレスポンス

HTTPステータスコード400と以下の情報を含むJSONオブジェクトを返します。

プロパティ タイプ 説明
message String エラーの概要
details String エラーの内容。以下のいずれかの値です。
  • AUDIENCE_GROUP_NOT_FOUND：オーディエンスが見つかりません。

リクエストの例

curl -v -X DELETE https://api.line.me/v2/bot/audienceGroup/{audienceGroupId} \
-H 'Authorization: Bearer {channel access token}'

// No sample code available

# No sample code available

// No sample code available

// No sample code available

# No sample code available

# No sample code available

// No sample code available

オーディエンスの情報を取得する

★ This section will be translated into English soon.

オーディエンスの情報を取得します。

HTTPリクエスト

GET https://api.line.me/v2/bot/audienceGroup/{audienceGroupId}

リクエストヘッダー

リクエストヘッダー 説明
Authorization Bearer {channel access token}

パスパラメータ

パラメータ 説明
audienceGroupId オーディエンスID

レスポンス

HTTPステータスコード200と以下の情報を含むJSONオブジェクトを返します。

プロパティ タイプ 説明
audienceGroupId Number オーディエンスID
type String オーディエンスのタイプ。以下のいずれかの値です。
  • UPLOAD：ユーザーIDアップロード用のオーディエンス
  • CLICK：クリックリターゲティング用のオーディエンス
  • IMP：インプレッションリターゲティング用のオーディエンス
description String オーディエンスの名前
status String オーディエンスのステータス。以下のいずれかの値です。
  • IN_PROGRESS：準備中。READYになるまで数時間かかる場合があります。
  • READY：配信に利用可能
  • FAILED：作成時にエラーが発生
  • EXPIRED：有効期限切れ。有効期限切れ後、1か月後に自動で削除されます。
failedType String 失敗した原因。statusがFAILEDの場合にのみ含まれます。以下のいずれかの値です。
  • AUDIENCE_GROUP_AUDIENCE_INSUFFICIENT：オーディエンスに含まれる送信対象アカウントの数（最低100件）が不足しています。
  • INTERNAL_ERROR：内部サーバーのエラーです。
audienceCount Number 有効な送信対象アカウントの数
created Number オーディエンスが作成された時刻のUNIXタイム
requestId String オーディエンスを作成したときに指定したリクエストID。typeがCLICKまたはIMPの場合にのみ含まれます。
clickUrl String オーディエンスを作成したときに指定したURL。typeがCLICKの場合にのみ含まれます。
isIfaAudience Boolean ユーザーIDアップロード用のオーディエンスを作成したときに指定した、送信対象アカウントの種類を示す値。以下のいずれかの値です。
  • true：IFAで指定する
  • false：ユーザーIDで指定する（標準）
jobs Array ジョブの配列。ユーザーIDアップロード用のオーディエンスに、ユーザーIDまたはIFAを追加した履歴を管理する配列です。それ以外のオーディエンスの場合はnullが返ります。
jobs[].audienceGroupJobId Number ジョブID
jobs[].audienceGroupId Number オーディエンスID
jobs[].description String ジョブの説明
jobs[].type String ジョブの種類。以下のいずれかの値です。
  • DIFF_ADD：Messaging APIでユーザーIDまたはIFAを追加したことを示します。
jobs[].jobStatus String ジョブのステータス。以下のいずれかの値です。
  • QUEUED：待機中
  • WORKING：実行中
  • FINISHED：成功
  • FAILED：失敗
jobs[].failedType String 失敗した原因。jobs[].jobStatusがFAILEDの場合にのみ含まれます。以下のいずれかの値です。
  • INTERNAL_ERROR：内部サーバーのエラーです。
jobs[].audienceCount Number 追加または削除された送信対象アカウントの数
jobs[].created Number ジョブが作成された時刻のUNIXタイム

エラーレスポンス

HTTPステータスコード400と以下の情報を含むJSONオブジェクトを返します。

プロパティ タイプ 説明
message String エラーの概要
details String エラーの内容。以下のいずれかの値です。
  • AUDIENCE_GROUP_NOT_FOUND：オーディエンスが見つかりません。

リクエストの例

curl -v -X GET https://api.line.me/v2/bot/audienceGroup/{audienceGroupId} \
-H 'Authorization: Bearer {channel access token}'

// No sample code available

# No sample code available

// No sample code available

// No sample code available

# No sample code available

# No sample code available

// No sample code available

複数のオーディエンスの情報を取得する

★ This section will be translated into English soon.

複数のオーディエンスの情報を取得します。

HTTPリクエスト

GET https://api.line.me/v2/bot/audienceGroup/list

リクエストヘッダー

リクエストヘッダー 説明
Authorization Bearer {channel access token}

クエリパラメータ

パラメータ 必須 説明
page 必須 取得するページ番号。1以上を指定してください。
description 任意 取得するオーディエンスの名前。部分一致で検索できます。大文字と小文字は区別されません。
status 任意 オーディエンスのステータス。以下のいずれかの値です。
  • IN_PROGRESS：準備中。READYになるまで数時間かかる場合があります。
  • READY：配信に利用可能
  • FAILED：作成時にエラーが発生
  • EXPIRED：有効期限切れ。有効期限切れ後、1か月後に自動で削除されます。
size 任意 1ページごとのオーディエンス数。デフォルト値は20です。
最大値：40

レスポンス

HTTPステータスコード200と以下の情報を含むJSONオブジェクトを返します。

プロパティ タイプ 説明
audienceGroups Array オーディエンスの情報の配列
audienceGroups[].audienceGroupId Number オーディエンスID
audienceGroups[].type String オーディエンスのタイプ。以下のいずれかの値です。
  • UPLOAD：ユーザーIDアップロード用のオーディエンス
  • CLICK：クリックリターゲティング用のオーディエンス
  • IMP：インプレッションリターゲティング用のオーディエンス
audienceGroups[].description String オーディエンスの名前
audienceGroups[].status String オーディエンスのステータス。以下のいずれかの値です。
  • IN_PROGRESS：準備中。READYになるまで数時間かかる場合があります。
  • READY：配信に利用可能
  • FAILED：作成時にエラーが発生
  • EXPIRED：有効期限切れ。有効期限切れ後、1か月後に自動で削除されます。
audienceGroups[].failedType String 失敗した原因。audienceGroups[].statusがFAILEDまたはEXPIREDの場合にのみ含まれます。以下のいずれかの値です。
  • AUDIENCE_GROUP_AUDIENCE_INSUFFICIENT：オーディエンスに含まれる送信対象アカウントの数（最低100件）が不足しています。
  • INTERNAL_ERROR：内部サーバーのエラーです。
audienceGroups[].audienceCount Number 有効な送信対象アカウントの数
audienceGroups[].created Number オーディエンスが作成された時刻のUNIXタイム
audienceGroups[].requestId String オーディエンスを作成したときに指定したリクエストID。audienceGroups[].typeがCLICKまたはIMPの場合にのみ含まれます。
audienceGroups[].clickUrl String オーディエンスを作成したときに指定したURL。audienceGroups[].typeがCLICKの場合にのみ含まれます。
audienceGroups[].isIfaAudience Boolean ユーザーIDアップロード用のオーディエンスを作成したときに指定した、送信対象アカウントの種類を示す値。以下のいずれかの値です。
  • true：IFAで指定する
  • false：ユーザーIDで指定する（標準）
hasNextPage Boolean 次のページが存在する場合は、true
totalCount Int 指定した条件で取得できるオーディエンスの総数
page Int 現在のページ番号
size Int 現在のページに含まれるオーディエンス数

リクエストの例

curl -v -X GET https://api.line.me/v2/bot/audienceGroup/list?description={description}&page=1&size=20 \
-H 'Authorization: Bearer {channel access token}'

// No sample code available

# No sample code available

// No sample code available

// No sample code available

# No sample code available

# No sample code available

// No sample code available

Insight

Get number of message deliveries

Returns the number of messages sent from LINE official account on a specified day.

note LINE official account migration

You can't call this API with a LINE@ account or LINE official account that hasn't been migrated to the account plans implemented on April 18, 2019. Please migrate your account first. For more information, see Migration of LINE@ accounts.

HTTP request

GET https://api.line.me/v2/bot/insight/message/delivery?date={date}

Request headers

Request header Description
Authorization Bearer {channel access token}

Query parameters

Parameter Required Description
date Required Date for which to retrieve number of sent messages.
  • Format: yyyyMMdd (Example: 20191231)
  • Timezone: UTC+9

Example request

curl -v -X GET https://api.line.me/v2/bot/insight/message/delivery?date=20190418 \
-H 'Authorization: Bearer {channel access token}'

// No sample code available

client = Line::Bot::Client.new{ |config|
    config.channel_secret = ENV["<channel secret>"]
    config.channel_token = ENV["<channel token>"]
}
client.get_number_of_message_deliveries("20190101")

// No sample code available

// No sample code available

# No sample code available

# No sample code available

// No sample code available

Response

Returns status code 200 and a JSON object with these properties:

Property Type Description
status String Status of the counting process. One of the following values is returned:
  • ready: Calculation has finished; the numbers are up-to-date.
  • unready: We haven't finished calculating the number of sent messages for the specified date. Retry your request later. Calculation usually takes about a day.
  • out_of_service: The specified date is earlier than the date on which we first started calculating sent messages (March 1, 2017).
broadcast Number Number of push messages sent to all of this LINE official account's friends (broadcast messages).
targeting Number Number of push messages sent to some of this LINE official account's friends, based on specific attributes (targeted/segmented messages).
autoResponse Number Number of auto-response messages sent.
welcomeResponse Number Number of greeting messages sent.
chat Number Number of messages sent from LINE Official Account Manager Chat screen.
apiBroadcast Number Number of broadcast messages sent with the Send broadcast message Messaging API operation.
apiPush Number Number of push messages sent with the Send push message Messaging API operation.
apiMulticast Number Number of multicast messages sent with the Send multicast message Messaging API operation.
apiReply Number Number of replies sent with the Send reply message Messaging API operation.

Properties after broadcast contain the number of messages sent on the date specified in date. These extra properties are included only if status is ready.

Example response

{
    "status": "ready",
    "broadcast": 5385,
    "targeting": 522
}

Get number of followers

Returns the number of users who have added the LINE official account on or before a specified date.

note LINE official account migration

You can't call this API with a LINE@ account or LINE official account that hasn't been migrated to the account plans implemented on April 18, 2019. Please migrate your account first. For more information, see Migration of LINE@ accounts.

HTTP request

GET https://api.line.me/v2/bot/insight/followers?date={date}

Request headers

Request header Description
Authorization Bearer {channel access token}

Query parameters

Parameter Required Description
date Required Date for which to retrieve the number of followers.
  • Format: yyyyMMdd (Example: 20191231)
  • Timezone: UTC+9

Example request

curl -v -X GET https://api.line.me/v2/bot/insight/followers?date=20190418 \
-H 'Authorization: Bearer {channel access token}'

// No sample code available

client = Line::Bot::Client.new{ |config|
    config.channel_secret = ENV["<channel secret>"]
    config.channel_token = ENV["<channel token>"]
}
client.get_number_of_followers("20190101")

// No sample code available

// No sample code available

# No sample code available

# No sample code available

// No sample code available

Response

Returns status code 200 and a JSON object with these properties:

Property Type Description
status String Calculation status. One of:
  • ready: Calculation has finished. The numbers are up-to-date.
  • unready: We haven't finished calculating followers for the specified date. Please try again later. Calculation usually takes about a day.
  • out_of_service: The specified date is earlier than the date on which we first started calculating followers (November 1, 2016).
followers Number The number of times, as of the specified date, that a user added this LINE official account as a friend for the first time. The number doesn't decrease even if a user later blocks the account or when they delete their LINE account.
targetedReaches Number The number of users, as of the specified date, that the official account can reach through targeted messages based on gender, age, and/or region. This number only includes users who are active on LINE or LINE services and whose demographics have a high level of certainty.
blocks Number The number of users blocking the account as of the specified date. The number decreases when a user unblocks the account.

Properties after followers are only returned if status is ready.

Example response

{
    "status": "ready",
    "followers": 7620,
    "targetedReaches": 5848,
    "blocks": 237
}

Get friend demographics

Retrieves the demographic attributes for a LINE official account's friends. You can only retrieve information about friends for LINE official accounts created by users in Japan (JP), Thailand (TH) and Taiwan (TW).

note LINE official account migration

You can't call this API with a LINE@ account or LINE official account that hasn't been migrated to the account plans implemented on April 18, 2019. Please migrate your account first. For more information, see Migration of LINE@ accounts.

note Not real-time data

It can take up to 3 days for demographic information to be calculated. This means the information the API returns may be 3 days old. Furthermore, your Target reach number must be at least 20 to retrieve demographic information.

HTTP request

GET https://api.line.me/v2/bot/insight/demographic

Request headers

Request header Description
Authorization Bearer {channel access token}

Example request 

curl -v -X GET https://api.line.me/v2/bot/insight/demographic \
-H 'Authorization: Bearer {channel access token}'

// No sample code available

client = Line::Bot::Client.new{ |config|
    config.channel_secret = ENV["<channel secret>"]
    config.channel_token = ENV["<channel token>"]
}
client.get_friend_demographics

// No sample code available

// No sample code available

# No sample code available

# No sample code available

// No sample code available

Response

Returns status code 200 and a JSON object with these properties:

Property Type Description
available Boolean true if friend demographic information is available.
genders Array Percentage per gender
genders[].gender String Gender
genders[].percentage Number Percentage
ages Array Percentage per age group
ages[].age String Age group
ages[].percentage Number Percentage
areas Array Percentage per area
areas[].area String Area
areas[].percentage Number Percentage
appTypes Array Percentage by OS
appTypes[].appType String OS
appTypes[].percentage Number Percentage
subscriptionPeriods Array Percentage per friendship duration
subscriptionPeriods[].subscriptionPeriod String Friendship duration
subscriptionPeriods[].percentage Number Percentage

The elements of each Array are included in the response only if the value of available is true.

Example response 

{
    "available": true,
    "genders": [
        {
            "gender": "unknown",
            "percentage": 37.6
        },
        {
            "gender": "male",
            "percentage": 31.8
        },
        {
            "gender": "female",
            "percentage": 30.6
        }
    ],
    "ages": [
        {
            "age": "unknown",
            "percentage": 37.6
        },
        {
            "age": "from50",
            "percentage": 17.3
        },
        ...
    ],
    "areas": [
        {
            "area": "unknown",
            "percentage": 42.9
        },
        {
            "area": "徳島",
            "percentage": 2.9
        },
        ...
    ],
    "appTypes": [
        {
            "appType": "ios",
            "percentage": 62.4
        },
        {
            "appType": "android",
            "percentage": 27.7
        },
        {
            "appType": "others",
            "percentage": 9.9
        }
    ],
    "subscriptionPeriods": [
        {
            "subscriptionPeriod": "over365days",
            "percentage": 96.4
        },
        {
            "subscriptionPeriod": "within365days",
            "percentage": 1.9
        },
        {
            "subscriptionPeriod": "within180days",
            "percentage": 1.2
        },
        {
            "subscriptionPeriod": "within90days",
            "percentage": 0.5
        },
        {
            "subscriptionPeriod": "within30days",
            "percentage": 0.1
        },
        {
            "subscriptionPeriod": "within7days",
            "percentage": 0
        }
    ]
}

Get user interaction statistics

Returns statistics about how users interact with broadcast messages sent from your LINE official account.

You can get statistics per message or per bubble.

Message and bubbles

note LINE official account migration

You can't call this API with a LINE@ account or LINE official account that hasn't been migrated to the account plans implemented on April 18, 2019. Please migrate your account first. For more information, see Migration of LINE@ accounts.

note Understanding the numbers

Interactions are tracked for only 14 days after a message was sent. The statistics are no longer updated after 15 days.

HTTP request

GET https://api.line.me/v2/bot/insight/message/event?requestId={requestId}

Request headers

Request header Description
Authorization Bearer {channel access token}

Query parameters

Parameter Required Description
requestId Required Request ID of broadcast message. A unique ID is generated for each Messaging API request. It is provided in the response headers.

Example request 

curl -v -X GET https://api.line.me/v2/bot/insight/message/event?requestId=f70dd685-499a-4231-a441-f24b8d4fba21 \
-H 'Authorization: Bearer {channel access token}'

// No sample code available

// No sample code available

// No sample code available

// No sample code available

# No sample code available

# No sample code available

// No sample code available

Response

Returns status code 200 and a JSON object with these properties:

note Note

To protect users' privacy, the values of some properties related to user interactions may be displayed as null or -1.

  • null：overview.uniqueImpression is 20 or lower.
  • -1：overview.uniqueImpression is 20 or higher, but the value of this property is 20 or lower.
Property Type Description
overview Object Summary of message statistics.
overview.requestId String Request ID.
overview.timestamp Number UNIX timestamp for message delivery time.
overview.delivered Number Number of messages delivered. This property shows values of less than 20.
overview.uniqueImpression Number Number of people who opened the message, meaning they displayed at least 1 bubble.
overview.uniqueClick Number Number of people who opened any URL in the message.
overview.uniqueMediaPlayed Number Number of people who started playing any video or audio in the message.
overview.uniqueMediaPlayed100Percent Number Number of people who played the entirety of any video or audio in the message.
messages Array Array of information about individual message bubbles.
messages[].seq Number Bubble's serial number.
messages[].impression Number Number of times the bubble was displayed.
messages[].mediaPlayed Number Number of times audio or video in the bubble started playing.
messages[].mediaPlayed25Percent Number Number of times audio or video in the bubble was played from start to 25%.
messages[].mediaPlayed50Percent Number Number of times audio or video in the bubble was played from start to 50%.
messages[].mediaPlayed75Percent Number Number of times audio or video in the bubble was played from start to 75%.
messages[].mediaPlayed100Percent Number Number of times audio or video in the bubble was played in its entirety.
messages[].uniqueMediaPlayed Number Number of people that started playing audio or video in the bubble.
messages[].uniqueMediaPlayed25Percent Number Number of people that played audio or video in the bubble from start to 25%.
messages[].uniqueMediaPlayed50Percent Number Number of people that played audio or video in the bubble from start to 50%.
messages[].uniqueMediaPlayed75Percent Number Number of people that played audio or video in the bubble from start to 75%.
messages[].uniqueMediaPlayed100Percent Number Number of people that played audio or video in the bubble in its entirety.
clicks Array Array of information about URLs in the message.
clicks[].seq Number The URL's serial number.
clicks[].url String URL
clicks[].click Number Number of times the URL was opened.
clicks[].uniqueClick Number Number of people that opened the URL.
clicks[].uniqueClickOfRequest Number Number of people who opened this url through any link in the message. If a message contains two links to the same URL and a user opens both links, they're counted only once.

Example response 

{
    "overview": {
        "requestId": "f70dd685-499a-4231-a441-f24b8d4fba21",
        "timestamp": 1568214000,
        "delivered": 32,
        "uniqueImpression": 4,
        "uniqueClick": null,
        "uniqueMediaPlayed": 2,
        "uniqueMediaPlayed100Percent": -1
    },
    "messages": [
        {
            "seq": 1,
            "impression": 18,
            "mediaPlayed": 11,
            "mediaPlayed25Percent": -1,
            "mediaPlayed50Percent": -1,
            "mediaPlayed75Percent": -1,
            "mediaPlayed100Percent": -1,
            "uniqueMediaPlayed": 2,
            "uniqueMediaPlayed25Percent": -1,
            "uniqueMediaPlayed50Percent": -1,
            "uniqueMediaPlayed75Percent": -1,
            "uniqueMediaPlayed100Percent": -1
        }
    ],
    "clicks": [
        {
            "seq": 1,
            "url": "https://www.yahoo.co.jp/",
            "click": -1,
            "uniqueClick": -1,
            "uniqueClickOfRequest": -1
        },
        {
            "seq": 1,
            "url": "https://www.google.com/?hl=ja",
            "click": -1,
            "uniqueClick": -1,
            "uniqueClickOfRequest": -1
        }
    ]
}

Profile

Get profile

Gets user profile information.

HTTP request

Request headers

Request header Description
Authorization Bearer {channel access token}

Path parameters

Parameter Description
userId User ID that is returned in a webhook event object. Do not use the LINE ID found on LINE.

Example request

curl -v -X GET https://api.line.me/v2/bot/profile/{userId} \
-H 'Authorization: Bearer {channel access token}'

final LineMessagingClient client = LineMessagingClient
        .builder("<channel access token>")
        .build();

final UserProfileResponse userProfileResponse;
try {
    userProfileResponse = client.getProfile("<userId>").get();
} catch (InterruptedException | ExecutionException e) {
    e.printStackTrace();
    return;
}

System.out.println(userProfileResponse.getUserId());
System.out.println(userProfileResponse.getDisplayName());
System.out.println(userProfileResponse.getPictureUrl());

bot, err := linebot.New(<channel secret>, <channel token>)
if err != nil {
    ...
}
res, err := bot.GetProfile(<userId>).Do();
if err != nil {
    ...
}
println(res.Displayname)
println(res.PicutureURL)
println(res.StatusMessage)

client = Line::Bot::Client.new { |config|
    config.channel_secret = "<channel secret>"
    config.channel_token = "<channel access token>"
}
response = client.get_profile("<userId>")
case response
when Net::HTTPSuccess then
  contact = JSON.parse(response.body)
  p contact['displayName']
  p contact['pictureUrl']
  p contact['statusMessage']
else
  p "#{response.code} #{response.body}"
end

$httpClient = new \LINE\LINEBot\HTTPClient\CurlHTTPClient('<channel access token>');
$bot = new \LINE\LINEBot($httpClient, ['channelSecret' => '<channel secret>']);
$response = $bot->getProfile('<userId>');
if ($response->isSucceeded()) {
    $profile = $response->getJSONDecodedBody();
    echo $profile['displayName'];
    echo $profile['pictureUrl'];
    echo $profile['statusMessage'];
}

use LINE::Bot::API;

my $bot = LINE::Bot::API->new(
    channel_secret       => "<channel secret>",
    channel_access_token => "<channel access token>",
);

my $res = $bot->get_profile("<userId>");
unless ($res->is_success) {
    # error handling
    ....
}

say $ret->display_name;
say $ret->user_id;
say $ret->picture_url;
say $ret->status_message;

from linebot import LineBotApi
from linebot.exceptions import LineBotApiError

line_bot_api = LineBotApi('<channel access token>')

try:
    profile = line_bot_api.get_profile('<user_id>')
except LineBotApiError as e:
    # error handle
    ...

const line = require('@line/bot-sdk');

const client = new line.Client({
  channelAccessToken: '<channel access token>'
});

client.getProfile('<userId>')
  .then((profile) => {
    console.log(profile.displayName);
    console.log(profile.userId);
    console.log(profile.pictureUrl);
    console.log(profile.statusMessage);
  })
  .catch((err) => {
    // error handling
  });

Response

Returns the status code 200 and a JSON object with the following information.

Property Type Description
displayName String User's display name
userId String User ID
pictureUrl String Profile image URL. "https" image URL. Not included in the response if the user doesn't have a profile image.
statusMessage String User's status message. Not included in the response if the user doesn't have a status message.

Example response

{
    "displayName":"LINE taro",
    "userId":"U4af4980629...",
    "pictureUrl":"https://obs.line-apps.com/...",
    "statusMessage":"Hello, LINE!"
}

Group

Get group member user IDs

note Note

This feature is available only to verified or premium accounts. For more information about account types, see the LINE Account Connect page on the LINE for Business website.

Gets the user IDs of the members of a group that the bot is in. This includes the user IDs of users who have not added the LINE official account as a friend or has blocked the LINE official account.

HTTP request

GET https://api.line.me/v2/bot/group/{groupId}/members/ids

Request headers

Request header Description
Authorization Bearer {channel access token}

Path parameters

Parameter Required Description
groupId Required Group ID. Found in the source object of webhook event objects.

Query parameters

Parameter Required Description
start Optional Value of the continuation token found in the next property of the JSON object returned in the response. Include this parameter to get the next array of user IDs for the members of the group.

Example request

curl -v -X GET https://api.line.me/v2/bot/group/{groupId}/members/ids?start={continuationToken} \
-H 'Authorization: Bearer {channel access token}'

// No sample code available

client = Line::Bot::Client.new{ |config|
    config.channel_secret = ENV["<channel secret>"]
    config.channel_token = ENV["<channel token>"]
}
client.get_group_member_ids(<groupId>, <continuationToken>)

bot, err := linebot.New(<channel secret>, <channel token>)
if err != nil {
    ...
}
res, err := bot.GetGroupMemberIDs(<groupId>, <continuationToken>).Do()
if err != nil {
    ...
}
for _, id := range res.MemberIDs {
    println(id)
}

$httpClient = new \LINE\LINEBot\HTTPClient\CurlHTTPClient('<channel access token>');
$bot = new \LINE\LINEBot($httpClient, ['channelSecret' => '<channel secret>']);
$response = $bot->getGroupMemberIds(<groupId>, <continuationToken>);

# No sample code available

member_ids_res = line_bot_api.get_group_member_ids(<group_id>)

const line = require('@line/bot-sdk');

const client = new line.Client({
  channelAccessToken: '<channel access token>'
});

client.getGroupMemberIds('<groupId>')
  .then((ids) => {
    ids.forEach((id) => console.log(id));
  })
  .catch((err) => {
    // error handling
  });

Response

Returns the status code 200 and a JSON object with the following properties.

Property Type Description
memberIds Array of strings List of user IDs of members in the group. Users of LINE version 7.4.x or earlier are not included in memberIds. For more information, see User consent.
Max: 100 user IDs
next String A continuation token to get the next array of user IDs of the members in the group. Returned only when there are remaining user IDs that were not returned in memberIds in the original request.

Example response

{  
   "memberIds":[  
      "U4af4980629...",
      "U0c229f96c4...",
      "U95afb1d4df..."
   ],
   "next":"jxEWCEEP..."
}

Get group member profile

Gets the user profile of a member of a group that the LINE official account is in if the user ID of the group member is known. You can get user profiles of users who have not added the LINE official account as a friend or have blocked the LINE official account.

HTTP request

GET https://api.line.me/v2/bot/group/{groupId}/member/{userId}

Request headers

Request header Description
Authorization Bearer {channel access token}

Path parameters

Parameter Description
groupId Group ID. Found in the source object of webhook event objects.
userId User ID. Found in the source object of webhook event objects. Do not use the LINE ID used in LINE.

Example request

curl -v -X GET https://api.line.me/v2/bot/group/{groupId}/member/{userId} \
-H 'Authorization: Bearer {channel access token}'

// No sample code available

client = Line::Bot::Client.new{ |config|
    config.channel_secret = ENV["<channel secret>"]
    config.channel_token = ENV["<channel token>"]
}
client.get_group_member_profile(<groupId>, <userId>)

bot, err := linebot.New(<channel secret>, <channel token>)
if err != nil {
    ...
}
res, err := bot.GetGroupMemberProfile(<groupId>, <userId>).Do()
if err != nil {
    ...
}
println(res.Displayname)
println(res.PicutureURL)

$httpClient = new \LINE\LINEBot\HTTPClient\CurlHTTPClient('<channel access token>');
$bot = new \LINE\LINEBot($httpClient, ['channelSecret' => '<channel secret>']);
$response = $bot->getGroupMemberProfile(<groupId>, <userId>);

# No sample code available

profile = line_bot_api.get_group_member_profile(<group_id>, <user_id>)

const line = require('@line/bot-sdk');

const client = new line.Client({
  channelAccessToken: '<channel access token>'
});

client.getGroupMemberProfile('<groupId>', '<userId>')
  .then((profile) => {
    console.log(profile.displayName);
    console.log(profile.userId);
    console.log(profile.pictureUrl);
    console.log(profile.statusMessage);
  })
  .catch((err) => {
    // error handling
  });

Response

Returns the status code 200 and a JSON object with the following information.

Property Type Description
displayName String Display name
userId String User ID
pictureUrl String Profile image URL

Example response

{
    "displayName":"LINE taro",
    "userId":"U4af4980629...",
    "pictureUrl":"https://obs.line-apps.com/..."
}

Leave group

Leaves a group.

HTTP request

POST https://api.line.me/v2/bot/group/{groupId}/leave

Request headers

Request header Description
Authorization Bearer {channel access token}

Path parameters

Parameter Description
groupId Group ID. Found in the source object of webhook event objects.

Example request

curl -v -X POST https://api.line.me/v2/bot/group/{groupId}/leave \
-H 'Authorization: Bearer {channel access token}'

final LineMessagingClient client = LineMessagingClient
        .builder("<channel access token>")
        .build();

final BotApiResponse botApiResponse;
try {
    botApiResponse = client.leaveGroup("<roomId>").get();
} catch (InterruptedException | ExecutionException e) {
    e.printStackTrace();
    return;
}

System.out.println(botApiResponse);

bot, err := linebot.New(<channel secret>, <channel token>)
if err != nil {
    ...
}
if _, err := bot.LeaveGroup(<groupId>).Do(); err != nil {
    ...
}

client = Line::Bot::Client.new { |config|
    config.channel_secret = "<channel secret>"
    config.channel_token = "<channel access token>"
}
response = client.leave_group("<groupId>")
p response.body

$httpClient = new \LINE\LINEBot\HTTPClient\CurlHTTPClient('<channel access token>');
$bot = new \LINE\LINEBot($httpClient, ['channelSecret' => '<channel secret>']);
$response = $bot->leaveGroup('<groupId>');
echo $response->getHTTPStatus() . ' ' . $response->getRawBody();

use LINE::Bot::API;

my $bot = LINE::Bot::API->new(
    channel_secret       => "<channel secret>",
    channel_access_token => "<channel access token>",
);

my $res = $bot->leave_group("<groupId>");
unless ($res->is_success) {
    # error handling
    ....
}

from linebot import LineBotApi
from linebot.exceptions import LineBotApiError

line_bot_api = LineBotApi('<channel access token>')

try:
    line_bot_api.leave_group('<group_id>')
except LineBotApiError as e:
    # error handle
    ...

const line = require('@line/bot-sdk');

const client = new line.Client({
  channelAccessToken: '<channel access token>'
});

client.leaveGroup('<groupId>')
  .then(() => {
    ...
  })
  .catch((err) => {
    // error handling
  });

Response

Returns the status code 200 and an empty JSON object.

Example response

{}

Room

Get room member user IDs

note Note

This feature is available only to verified or premium accounts. For more information about account types, see the LINE Account Connect page on the LINE for Business website.

Gets the user IDs of the members of a room that the LINE official account is in. This includes the user IDs of users who have not added the LINE official account as a friend or have blocked the LINE official account.

HTTP request

GET https://api.line.me/v2/bot/room/{roomId}/members/ids

Request headers

Request header Description
Authorization Bearer {channel access token}

Path parameters

Parameter Required Description
roomId 必須 Room ID. Found in the source object of webhook event objects.

Query parameters

Parameter Required Description
start Optional Value of the continuation token found in the next property of the JSON object returned in the response. Include this parameter to get the next array of user IDs for the members of the group.

Example request

curl -v -X GET https://api.line.me/v2/bot/room/{roomId}/members/ids?start={continuationToken} \
-H 'Authorization: Bearer {channel access token}'

// No sample code available

client = Line::Bot::Client.new{ |config|
    config.channel_secret = ENV["<channel secret>"]
        config.channel_token = ENV["<channel token>"]
}
client.get_room_member_ids(<roomId>, <continuationToken>)

bot, err := linebot.New(<channel secret>, <channel token>)
if err != nil {
    ...
}
res, err := bot.GetRoomMemberIDs(<roomId>, <continuationToken>).Do()
if err != nil {
    ...
}
for _, id := range res.MemberIDs {
    println(id)
}

$httpClient = new \LINE\LINEBot\HTTPClient\CurlHTTPClient('<channel access token>');
$bot = new \LINE\LINEBot($httpClient, ['channelSecret' => '<channel secret>']);
$response = $bot->getRoomMemberIds('<roomId>', '<continuationToken>');

# No sample code available

member_ids_res = line_bot_api.get_room_member_ids(<room_id>)

const line = require('@line/bot-sdk');

const client = new line.Client({
  channelAccessToken: '<channel access token>'
});

client.getRoomMemberIds('<roomId>')
  .then((ids) => {
    ids.forEach((id) => console.log(id));
  })
  .catch((err) => {
    // error handling
  });

Response

Returns the status code 200 and a JSON object with the following properties.

Property Type Description
memberIds Array of strings List of user IDs of the members in the room. Users of LINE version 7.4.x or earlier are not included in memberIds. For more information, see User consent.
Max: 100 user IDs
next String A continuation token to get the next array of user IDs of the members in the room. Returned only when there are remaining user IDs that were not returned in memberIds in the original request.

Example response

{  
   "memberIds":[  
      "U4af4980629...",
      "U0c229f96c4...",
      "U95afb1d4df..."
   ],
   "next":"jxEWCEEP..."
}

Get room member profile

Gets the user profile of a member of a room that the LINE official account is in if the user ID of the room member is known. You can get user profiles of users who have not added the LINE official account as a friend or have blocked the LINE official account.

HTTP request

GET https://api.line.me/v2/bot/room/{roomId}/member/{userId}

Request headers

Request header Description
Authorization Bearer {channel access token}

Path parameters

Parameter Description
roomId Room ID. Found in the source object of webhook event objects.
userId User ID. Found in the source object of webhook event objects. Do not use the LINE ID used in LINE.

Example request

curl -v -X GET https://api.line.me/v2/bot/room/{roomId}/member/{userId} \
-H 'Authorization: Bearer {channel access token}'

// No sample code available

client = Line::Bot::Client.new{ |config|
    config.channel_secret = ENV["<channel secret>"]
    config.channel_token = ENV["<channel token>"]
}
client.get_room_member_profile(<roomId>, <userId>)

bot, err := linebot.New(<channel secret>, <channel token>)
if err != nil {
    ...
}
res, err := bot.GetRoomMemberProfile(<roomId>, <userId>).Do()
if err != nil {
    ...
}
println(res.Displayname)
println(res.PicutureURL)

$httpClient = new \LINE\LINEBot\HTTPClient\CurlHTTPClient('<channel access token>');
$bot = new \LINE\LINEBot($httpClient, ['channelSecret' => '<channel secret>']);
$response = $bot->getRoomMemberProfile(<roomId>, <userId>);

# No sample code available

profile = line_bot_api.get_room_member_profile(<room_id>, <user_id>)

const line = require('@line/bot-sdk');

const client = new line.Client({
  channelAccessToken: '<channel access token>'
});

client.getRoomMemberProfile('<roomId>', '<userId>')
  .then((profile) => {
    console.log(profile.displayName);
    console.log(profile.userId);
    console.log(profile.pictureUrl);
    console.log(profile.statusMessage);
  })
  .catch((err) => {
    // error handling
  });

Response

Returns the status code 200 and a JSON object with the following information.

Property Type Description
displayName String Display name
userId String User ID
pictureUrl String Profile image URL

Example response

{
    "displayName":"LINE taro",
    "userId":"U4af4980629...",
    "pictureUrl":"https://obs.line-apps.com/..."
}

Leave room

Leaves a room.

HTTP request

POST https://api.line.me/v2/bot/room/{roomId}/leave

Request headers

Request header Description
Authorization Bearer {channel access token}

Path parameters

Parameter Description
roomId Room ID. Found in the source object of webhook event objects.

Example request

curl -v -X POST https://api.line.me/v2/bot/room/{roomId}/leave \
-H 'Authorization: Bearer {channel access token}'

final LineMessagingClient client = LineMessagingClient
        .builder("<channel access token>")
        .build();

final BotApiResponse botApiResponse;
try {
    botApiResponse = client.leaveRoom("<roomId>").get();
} catch (InterruptedException | ExecutionException e) {
    e.printStackTrace();
    return;
}

System.out.println(botApiResponse);

bot, err := linebot.New(<channel secret>, <channel token>)
if err != nil {
    ...
}
if _, err := bot.LeaveRoom(<roomId>).Do(); err != nil {
    ...
}

client = Line::Bot::Client.new { |config|
    config.channel_secret = "<channel secret>"
    config.channel_token = "<channel access token>"
}
response = client.leave_room("<roomId>")
p response.body

$httpClient = new \LINE\LINEBot\HTTPClient\CurlHTTPClient('<channel access token>');
$bot = new \LINE\LINEBot($httpClient, ['channelSecret' => '<channel secret>']);
$response = $bot->leaveRoom('<roomId>');
echo $response->getHTTPStatus() . ' ' . $response->getRawBody();

use LINE::Bot::API;

my $bot = LINE::Bot::API->new(
    channel_secret       => "<channel secret>",
    channel_access_token => "<channel access token>",
);

my $res = $bot->leave_room("<roomId>");
unless ($res->is_success) {
    # error handling
    ....
}

from linebot import LineBotApi
from linebot.exceptions import LineBotApiError

line_bot_api = LineBotApi('<channel access token>')

try:
    line_bot_api.leave_room('<room_id>')
except LineBotApiError as e:
    # error handle
    ...

const line = require('@line/bot-sdk');

const client = new line.Client({
  channelAccessToken: '<channel access token>'
});

client.leaveRoom('<roomId>')
  .then(() => {
    ...
  })
  .catch((err) => {
    // error handling
  });

Response

Returns the status code 200 and an empty JSON object.

Example response

{}

Rich menu

note Note

Rich menus created using the Messaging API are only supported on LINE 7.14.0 and later for Android and iOS.

Customizable menu that is displayed on your LINE official account's chat screen. For more information, see Using rich menus.

Create rich menu

Creates a rich menu.

You must upload a rich menu image, and set the rich menu as the default rich menu or link the rich menu to a user for the rich menu to be displayed. You can create up to 1000 rich menus for one LINE official account with the Messaging API.

HTTP request

POST https://api.line.me/v2/bot/richmenu

Request headers

Request header Description
Authorization Bearer {channel access token}
Content-Type application/json

Request body

The rich menu represented as a rich menu object.

Example request

curl -v -X POST https://api.line.me/v2/bot/richmenu \
-H 'Authorization: Bearer {channel access token}' \
-H 'Content-Type: application/json' \
-d \
'{
    "size": {
      "width": 2500,
      "height": 1686
    },
    "selected": false,
    "name": "Nice richmenu",
    "chatBarText": "Tap here",
    "areas": [
      {
        "bounds": {
          "x": 0,
          "y": 0,
          "width": 2500,
          "height": 1686
        },
        "action": {
          "type": "postback",
          "data": "action=buy&itemid=123"
        }
      }
   ]
}'

// No sample code available

client = Line::Bot::Client.new{ |config|
    config.channel_secret = ENV["<channel secret>"]
    config.channel_token = ENV["<channel token>"]
}

rich_menu = {
    <rich menu content>
}
client.create_rich_menu(rich_menu)

richMemu := linebot.RichMenu{ ... }
bot, err := linebot.New(<channel secret>, <channel token>)
if err != nil {
    ...
}
res, err := bot.CreateRichMenu(richMemu).Do()
if err != nil {
    t.Error(err.Error())
}
println(res.RichMenuID)

$httpClient = new \LINE\LINEBot\HTTPClient\CurlHTTPClient('<channel access token>');
$bot = new \LINE\LINEBot($httpClient, ['channelSecret' => '<channel secret>']);
$richMenuBuilder = new \LINE\LINEBot\RichMenuBuilder(...)
$response = $bot->createRichMenu($richMenuBuilder);

# No sample code available

rich_menu_to_create = RichMenu(
    size=RichMenuSize(width=2500, height=843),
    selected=False,
    name="Nice richmenu",
    chat_bar_text="Tap here",
    areas=[RichMenuArea(
        bounds=RichMenuBounds(x=0, y=0, width=2500, height=843),
        action=URIAction(label='Go to line.me', uri='https://line.me'))]
)
rich_menu_id = line_bot_api.create_rich_menu(rich_menu=rich_menu_to_create)

const line = require('@line/bot-sdk');

const client = new line.Client({
  channelAccessToken: '<channel access token>'
});

const richmenu = {
  size: {
    width: 2500,
    height: 1686
  },
  // Other rich menu object properties
  // ...
}
};

client.createRichMenu(richmenu)
  .then((richMenuId) => 
  console.log(richMenuId))

Response

Returns the status code 200 and the ID of the rich menu.

Example response

{
  "richMenuId": "{richMenuId}"
}

Upload rich menu image

Uploads and attaches an image to a rich menu.

You can use rich menu images with the following specifications:

  • Image format: JPEG or PNG
  • Image size (pixels): 2500x1686, 2500x843, 1200x810, 1200x405, 800x540, 800x270
  • Maximum file size: 1 MB

Note: You cannot replace an image attached to a rich menu. To update your rich menu image, create a new rich menu object and upload another image.

HTTP request

POST https://api-data.line.me/v2/bot/richmenu/{richMenuId}/content

Request headers

Request header Description
Authorization Bearer {channel access token}
Content-Type image/jpeg or image/png
Content-Length The length of the request body in octets (8-bit bytes). Must be a non-negative value.

Path parameters

Parameter Required Description
richMenuId Required The ID of the rich menu to attach the image to

Example request

curl -v -X POST https://api-data.line.me/v2/bot/richmenu/{richMenuId}/content \
-H "Authorization: Bearer {channel access token}" \
-H "Content-Type: image/jpeg" \
-T image.jpg

// No sample code available

client = Line::Bot::Client.new{ |config|
    config.channel_secret = ENV["<channel secret>"]
    config.channel_token = ENV["<channel token>"]
}
client.create_rich_menu_image(<richMenuId>, <file>)

bot, err := linebot.New(<channel secret>, <channel token>)
if err != nil {
    ...
}
if _, err := bot.UploadRichMenuImage(<richMenuId>, <imagePath>).Do(); err != nil {
    ...
}

$httpClient = new \LINE\LINEBot\HTTPClient\CurlHTTPClient('<channel access token>');
$bot = new \LINE\LINEBot($httpClient, ['channelSecret' => '<channel secret>']);
$imagePath = '/path/to/image.jpeg';
$contentType = 'image/jpeg';
$response = $bot->uploadRichMenuImage(<richMenuId>, $imagePath, $contentType);

# No sample code available

with open(<file_path>, 'rb') as f:
    line_bot_api.set_rich_menu_image(<rich_menu_id>, <content_type>, f)

const line = require('@line/bot-sdk');

const client = new line.Client({
  channelAccessToken: '<channel access token>'
});

client.setRichMenuImage('<rich_menu_id>', fs.createReadStream('./example.png'))

Response

Returns the status code 200 and an empty JSON object.

Example response

{}

Download rich menu image

Downloads an image associated with a rich menu.

HTTP request

GET https://api-data.line.me/v2/bot/richmenu/{richMenuId}/content

Request headers

Request header Description
Authorization Bearer {channel access token}

Path parameters

Parameter Required Description
richMenuId Required ID of the rich menu with the image to be downloaded

Response

Returns the status code 200 and the binary data of the rich menu image. The image can be downloaded as shown in the example request.

Example request

curl -v -X GET "https://api-data.line.me/v2/bot/richmenu/{richMenuId}/content" \
-H 'Authorization: Bearer {channel access token}' \
-o picture.jpg

// No sample code available

client = Line::Bot::Client.new{ |config|
    config.channel_secret = ENV["<channel secret>"]
    config.channel_token = ENV["<channel token>"]
}
client.get_rich_menu_image(<richMenuId>)

bot, err := linebot.New(<channel secret>, <channel token>)
if err != nil {
    ...
}
content, err := bot.DownloadRichMenuImage(<richMenuId>).Do()
if err != nil {
    ...
}
defer content.Content.Close()

...

$httpClient = new \LINE\LINEBot\HTTPClient\CurlHTTPClient('<channel access token>');
$bot = new \LINE\LINEBot($httpClient, ['channelSecret' => '<channel secret>']);
$response = $bot->downloadRichMenuImage(<richMenuId>);

# No sample code available

content = line_bot_api.get_rich_menu_image(<rich_menu_id>)
with open(file_path, 'wb') as fd:
    for chunk in content.iter_content():
        fd.write(chunk)

const line = require('@line/bot-sdk');

const client = new line.Client({
  channelAccessToken: '<channel access token>'
});

client.getRichMenuImage('<rich menu id>')
  .then((stream) => {
    stream.on('data', (chunk) => {
      ...
    });
    stream.on('error', (err) => {
      // Error handling
    });
    stream.pipe(...)
  });

Get rich menu list

Gets a list of all rich menus created by Create rich menu.

Note: You can't retrieve rich menus created with LINE Official Account Manager.

HTTP request

GET https://api.line.me/v2/bot/richmenu/list

Request headers

Request header Description
Authorization Bearer {channel access token}

Example request

curl -v -X GET https://api.line.me/v2/bot/richmenu/list \
-H 'Authorization: Bearer {channel access token}'

// No sample code available

client = Line::Bot::Client.new{ |config|
    config.channel_secret = ENV["<channel secret>"]
    config.channel_token = ENV["<channel token>"]
}
client.get_rich_menus

bot, err := linebot.New(<channel secret>, <channel token>)
if err != nil {
    ...
}
res, err := bot.GetRichMenuList().Do()
if err != nil {
    ...
}
for _, richMenu := range res {
    println(richMenu.RichMenuID)
}

$httpClient = new \LINE\LINEBot\HTTPClient\CurlHTTPClient('<channel access token>');
$bot = new \LINE\LINEBot($httpClient, ['channelSecret' => '<channel secret>']);
$response = $bot->getRichMenuList();

# No sample code available

from linebot import LineBotApi
from linebot.exceptions import LineBotApiError

rich_menu_list = line_bot_api.get_rich_menu_list()


const line = require('@line/bot-sdk');

const client = new line.Client({
  channelAccessToken: '<channel access token>'
});

client.getRichMenuList()
    .then((richmenus) => {
    ids.forEach((richmenu) => console.log(richmenu));
    })

Response

Returns the status code 200 and a list of rich menu response objects.

Property Type Description
richmenus Array Array of rich menu response objects

Example response

{
  "richmenus": [
    {
      "richMenuId": "{richMenuId}",
      "size": {
        "width": 2500,
        "height": 1686
      },
      "selected": false,
      "areas": [
        {
          "bounds": {
            "x": 0,
            "y": 0,
            "width": 2500,
            "height": 1686
          },
          "action": {
            "type": "postback",
            "data": "action=buy&itemid=123"
          }
        }
      ]
    }
  ]
}

Get rich menu

Gets a rich menu via a rich menu ID.

HTTP request

GET https://api.line.me/v2/bot/richmenu/{richMenuId}

Request headers

Request header Description
Authorization Bearer {channel access token}

Path parameters

Parameter Required Description
richMenuId Required ID of an uploaded rich menu

Example request

curl -v -X GET https://api.line.me/v2/bot/richmenu/{richMenuId} \
-H 'Authorization: Bearer {channel access token}'

// No sample code available

client = Line::Bot::Client.new{ |config|
    config.channel_secret = ENV["<channel secret>"]
    config.channel_token = ENV["<channel token>"]
}
client.get_rich_menu(<richMenuId>)

bot, err := linebot.New(<channel secret>, <channel token>)
if err != nil {
    ...
}
res, err := bot.GetRichMenu(<richMenuId>).Do()
if err != nil {
    ...
}
println(res.RichMenuID)

$httpClient = new \LINE\LINEBot\HTTPClient\CurlHTTPClient('<channel access token>');
$bot = new \LINE\LINEBot($httpClient, ['channelSecret' => '<channel secret>']);
$response = $bot->getRichMenu(<richMenuId>);

# No sample code available

rich_menu = line_bot_api.get_rich_menu(rich_menu_id)

const line = require('@line/bot-sdk');

const client = new line.Client({
  channelAccessToken: '<channel access token>'
});

client.getRichMenu('<rich_menu_id>')
  .then((richMenu) => {
    console.log(richMenu.size);
    console.log(richMenu.areas[0].bounds);
    })

Response

Returns the status code 200 and a rich menu response object.

Example response

{
  "richMenuId": "{richMenuId}",
  "size": {
     "width": 2500,
     "height": 1686
   },
   "selected": false,
   "areas": [
     {
       "bounds": {
         "x": 0,
         "y": 0,
         "width": 2500,
         "height": 1686
       },
       "action": {
         "type": "postback",
         "data": "action=buy&itemid=123"
       }
     }
   ]
}

Delete rich menu

Deletes a rich menu.

HTTP request

DELETE https://api.line.me/v2/bot/richmenu/{richMenuId}

Request headers

Request header Description
Authorization Bearer {channel access token}

Path parameters

Parameter Required Description
richMenuId Required ID of an uploaded rich menu

Example request

curl -v -X DELETE https://api.line.me/v2/bot/richmenu/{richMenuId} \
-H 'Authorization: Bearer {channel access token}'

// No sample code available

client = Line::Bot::Client.new{ |config|
    config.channel_secret = ENV["<channel secret>"]
    config.channel_token = ENV["<channel token>"]
}
client.delete_rich_menu(<richMenuId>)

bot, err := linebot.New(<channel secret>, <channel token>)
if err != nil {
    ...
}
if _, err := bot.DeleteRichMenu(<richMenuId>).Do(); err != nil {
    ...
}

$httpClient = new \LINE\LINEBot\HTTPClient\CurlHTTPClient('<channel access token>');
$bot = new \LINE\LINEBot($httpClient, ['channelSecret' => '<channel secret>']);
$response = $bot->deleteRichMenu(<richMenuId>);

# No sample code available

line_bot_api.delete_rich_menu(<rich_menu_id>)

const line = require('@line/bot-sdk');

const client = new line.Client({
  channelAccessToken: '<channel access token>'
});

client.deleteRichMenu('<rich_menu_id>')

Response

Returns the status code 200 and an empty JSON object.

Example response

{}

Set default rich menu

Sets the default rich menu. The default rich menu is displayed to all users who have added your LINE official account as a friend and are not linked to any per-user rich menu. If a default rich menu has already been set, calling this endpoint replaces the current default rich menu with the one specified in your request.

The rich menu is displayed in the following order of priority (highest to lowest):

  1. The per-user rich menu set with the Messaging API
  2. The default rich menu set with the Messaging API
  3. The default rich menu set with LINE Official Account Manager

HTTP request

POST https://api.line.me/v2/bot/user/all/richmenu/{richMenuId}

Request headers

Request header Description
Authorization Bearer {channel access token}

Path parameters

Parameter Required Description
richMenuId Required ID of an uploaded rich menu

Example request

curl -v -X POST https://api.line.me/v2/bot/user/all/richmenu/{richMenuId} \
-H "Authorization: Bearer {channel access token}"

// No sample code available

client = Line::Bot::Client.new{ |config|
    config.channel_secret = ENV["<channel secret>"]
    config.channel_token = ENV["<channel token>"]
}
client.set_default_rich_menu(<richMenuId>)

bot, err := linebot.New(<channel secret>, <channel token>)
if err != nil {
    ...
}
if _, err := bot.SetDefaultRichMenu(<richMenuId>).Do(); err != nil {
    ...
}

// No sample code available

# No sample code available

# No sample code available

const line = require('@line/bot-sdk');

const client = new line.Client({
  channelAccessToken: '<channel access token>'
});

client.setDefaultRichMenu('<rich_menu_id>')

Response

Returns the status code 200 and an empty JSON object.

Example response

{}

Get default rich menu ID

Gets the ID of the default rich menu set with the Messaging API.

HTTP request

GET https://api.line.me/v2/bot/user/all/richmenu

Request headers

Request header Description
Authorization Bearer {channel access token}

Example request

curl -v -X GET https://api.line.me/v2/bot/user/all/richmenu \
-H 'Authorization: Bearer {channel access token}'

// No sample code available

client = Line::Bot::Client.new { |config|
    config.channel_secret = "<channel secret>"
    config.channel_token = "<channel access token>"
}
p client.get_default_rich_menu

bot, err := linebot.New(<channel secret>, <channel token>)
if err != nil {
    ...
}
res, err := bot.GetDefaultRichMenu().Do()
if err != nil {
    ...
}
println(res.RichMenuID)

// No sample code available

# No sample code available

# No sample code available

const line = require('@line/bot-sdk');

const client = new line.Client({
  channelAccessToken: '<channel access token>'
});

client.getDefaultRichMenuId()

Response

Returns the status code 200 and a JSON object with the rich menu ID.

Example response

{
    "richMenuId": "{richMenuId}"
}

Cancel default rich menu

Cancels the default rich menu set with the Messaging API.

HTTP request

DELETE https://api.line.me/v2/bot/user/all/richmenu

Request headers

Request header Description
Authorization Bearer {channel access token}

Example request

curl -v -X DELETE https://api.line.me/v2/bot/user/all/richmenu \
-H 'Authorization: Bearer {channel access token}'

// No sample code available

client = Line::Bot::Client.new{ |config|
    config.channel_secret = ENV["<channel secret>"]
    config.channel_token = ENV["<channel token>"]
}
client.unset_default_rich_menu

bot, err := linebot.New(<channel secret>, <channel token>)
if err != nil {
    ...
}
if _, err := bot.CancelDefaultRichMenu().Do(); err != nil {
    ...
}

// No sample code available

# No sample code available

# No sample code available

const line = require('@line/bot-sdk');

const client = new line.Client({
  channelAccessToken: '<channel access token>'
});

client.deleteDefaultRichMenu()

Response

Returns the status code 200 and an empty JSON object.

Example response

{}

Links a rich menu to a user. Only one rich menu can be linked to a user at one time. If a user already has a rich menu linked, calling this endpoint replaces the existing rich menu with the one specified in your request.

The rich menu is displayed in the following order of priority (highest to lowest):

  1. The per-user rich menu set with the Messaging API
  2. The default rich menu set with the Messaging API
  3. The default rich menu set with LINE Official Account Manager

HTTP request

POST https://api.line.me/v2/bot/user/{userId}/richmenu/{richMenuId}

Request headers

Request header Description
Authorization Bearer {channel access token}

Path parameters

Parameter Required Description
richMenuId Required ID of an uploaded rich menu
userId Required User ID. Found in the source object of webhook event objects. Do not use the LINE ID used in LINE.

Example request

curl -v -X POST https://api.line.me/v2/bot/user/{userId}/richmenu/{richMenuId} \
-H "Authorization: Bearer {channel access token}"

// No sample code available

client = Line::Bot::Client.new{ |config|
    config.channel_secret = ENV["<channel secret>"]
    config.channel_token = ENV["<channel token>"]
}
client.link_user_rich_menu(<userId>, <richMenuId>)

bot, err := linebot.New(<channel secret>, <channel token>)
if err != nil {
    ...
}
if _, err := bot.LinkUserRichMenu(<userId>, <richMenuId>).Do(); err != nil {
    ...
}

$httpClient = new \LINE\LINEBot\HTTPClient\CurlHTTPClient('<channel access token>');
$bot = new \LINE\LINEBot($httpClient, ['channelSecret' => '<channel secret>']);
$response = $bot->linkRichMenu(<userId>, <richMenuId>);

# No sample code available

line_bot_api.link_rich_menu_to_user(<user_id>, <rich_menu_id>)

const line = require('@line/bot-sdk');

const client = new line.Client({
  channelAccessToken: '<channel access token>'
});

client.linkRichMenuToUser('<user_id>', '<rich_menu_id>')

Response

Returns the status code 200 and an empty JSON object.

Example response

{}

Links a rich menu to multiple users.

The rich menu is displayed in the following order of priority (highest to lowest):

  1. The per-user rich menu set with the Messaging API
  2. The default rich menu set with the Messaging API
  3. The default rich menu set with LINE Official Account Manager

HTTP request

POST https://api.line.me/v2/bot/richmenu/bulk/link

Request headers

Request header Description
Content-Type application/json
Authorization Bearer {channel access token}

Request body

Property Type Required Description
richMenuId String Required ID of an uploaded rich menu
userIds Array of strings Required Array of user IDs. Found in the source object of webhook event objects. Do not use the LINE ID used in LINE.
Max: 150 user IDs

Example request

curl -v -X POST https://api.line.me/v2/bot/richmenu/bulk/link \
-H "Authorization: Bearer {channel access token}" \
-H "Content-Type: application/json" \
-d '{
  "richMenuId":"{richMenuId}",
  "userIds":["{userId1}","{userId2}"]
}'

// No sample code available

client = Line::Bot::Client.new{ |config|
    config.channel_secret = ENV["<channel secret>"]
    config.channel_token = ENV["<channel token>"]
}
client.bulk_link_rich_menus([<userId1>, <userId2>], <richMenuId>)

// No sample code available

// No sample code available

# No sample code available

# No sample code available

const line = require('@line/bot-sdk');

const client = new line.Client({
  channelAccessToken: '<channel access token>'
});

client.linkRichMenuToMultipleUsers('rich_menu_id', 
  [
    '<user_id1>',
    '<user_id2>',
    '<user_id3>'
  ],
)

Response

Returns the status code 202 and an empty JSON object.

Unlike linking a rich menu to a user, this request is processed asynchronously in the background. Normally, the process is completed within a few seconds.

To verify whether the request was processed successfully, get the rich menu ID linked to the users and check if the rich menu is actually linked to the users.

Example response

{}

Get rich menu ID of user

Gets the ID of the rich menu linked to a user.

HTTP request

GET https://api.line.me/v2/bot/user/{userId}/richmenu

Request headers

Request header Description
Authorization Bearer {channel access token}

Path parameters

Parameter Required Description
userId Required User ID. Found in the source object of webhook event objects. Do not use the LINE ID used in LINE.

Example request

curl -v -X GET https://api.line.me/v2/bot/user/{userId}/richmenu \
-H 'Authorization: Bearer {channel access token}'

// No sample code available

client = Line::Bot::Client.new{ |config|
    config.channel_secret = ENV["<channel secret>"]
    config.channel_token = ENV["<channel token>"]
}
client.get_user_rich_menu(<userId>)

bot, err := linebot.New(<channel secret>, <channel token>)
if err != nil {
    ...
}
res, err := bot.GetUserRichMenu(<userId>).Do()
if err != nil {
    ...
}
println(res.RichMenuID)

$httpClient = new \LINE\LINEBot\HTTPClient\CurlHTTPClient('<channel access token>');
$bot = new \LINE\LINEBot($httpClient, ['channelSecret' => '<channel secret>']);
$response = $bot->getRichMenuId(<userId>);

# No sample code available

rich_menu_id = line_bot_api.get_rich_menu_id_of_user(<user_id>)

const line = require('@line/bot-sdk');

const client = new line.Client({
  channelAccessToken: '<channel access token>'
});

client.getRichMenuIdOfUser('<user_id>')
  .then((richMenuId) => {
    console.log(richMenuId);
    })

Response

Returns the status code 200 and a JSON object with the rich menu ID.

Example response

{
    "richMenuId": "{richMenuId}"
}

Unlinks a rich menu from a user.

HTTP request

DELETE https://api.line.me/v2/bot/user/{userId}/richmenu

Request headers

Request header Description
Authorization Bearer {channel access token}

Path parameters

Parameter Required Description
userId Required User ID. Found in the source object of webhook event objects. Do not use the LINE ID used in LINE.

Example request

curl -v -X DELETE https://api.line.me/v2/bot/user/{userId}/richmenu \
-H 'Authorization: Bearer {channel access token}'

// No sample code available

client = Line::Bot::Client.new{ |config|
    config.channel_secret = ENV["<channel secret>"]
    config.channel_token = ENV["<channel token>"]
}
client.unlink_user_rich_menu(<userId>)

bot, err := linebot.New(<channel secret>, <channel token>)
if err != nil {
    ...
}
if _, err := bot.UnlinkUserRichMenu(<userId>).Do(); err != nil {
    ...
}

$httpClient = new \LINE\LINEBot\HTTPClient\CurlHTTPClient('<channel access token>');
$bot = new \LINE\LINEBot($httpClient, ['channelSecret' => '<channel secret>']);
$bot->unlinkRichMenu(<userId>);

# No sample code available

line_bot_api.unlink_rich_menu_from_user(<user_id>)

const line = require('@line/bot-sdk');

const client = new line.Client({
  channelAccessToken: '<channel access token>'
});

client.unlinkRichMenuFromUser('<user_id>', '<rich_menu_id>')

Response

Returns the status code 200 and an empty JSON object.

Example response

{}

Unlinks rich menus from multiple users.

HTTP request

POST https://api.line.me/v2/bot/richmenu/bulk/unlink

Request headers

Request header Description
Content-Type application/json
Authorization Bearer {channel access token}

Request body

Property Type Required Description
userIds Array of strings Required Array of user IDs. Found in the source object of webhook event objects. Do not use the LINE ID used in LINE.
Max: 150 user IDs

Example request

curl -v -X POST https://api.line.me/v2/bot/richmenu/bulk/unlink \
-H "Authorization: Bearer {channel access token}" \
-H "Content-Type: application/json" \
-d '{
  "userIds":["{userId1}","{userId2}"]
}'

// No sample code available

client = Line::Bot::Client.new{ |config|
    config.channel_secret = ENV["<channel secret>"]
    config.channel_token = ENV["<channel token>"]
}
client.bulk_unlink_rich_menus([<userId1>, <userId2>])

// No sample code available

// No sample code available

# No sample code available

# No sample code available

const line = require('@line/bot-sdk');

const client = new line.Client({
  channelAccessToken: '<channel access token>'
});

client.unlinkRichMenusFromMultipleUsers(['<user_id1>', '<user_id2>', '<user_id3>'])

Response

Returns the status code 202 and an empty JSON object.

Unlike unlinking a rich menu from a user, this request is processed asynchronously in the background. Normally, the process is completed within a few seconds.

To verify whether the request was processed successfully, get the rich menu ID linked to the users and check if the unlinked rich menus are actually not linked to the users.

Example response

{}

Get follower IDs

Note: This feature is available only to verified or premium accounts. For more information about account types, see the LINE Account Connect page on the LINE for Business website.

Gets the user IDs of users who have added the LINE official account as a friend (followers).

HTTP request

GET https://api.line.me/v2/bot/followers/ids

Request headers

Request header Description
Content-Type application/json
Authorization Bearer {channel access token}

Query parameters

Parameter Required Description
start Optional Value of the continuation token found in the next property of the JSON object returned in the response. Include this parameter to get the next array of user IDs.

Example request

curl -v -X GET https://api.line.me/v2/bot/followers/ids?start={continuationToken} \
-H 'Authorization: Bearer {channel access token}'

// No sample code available

# No sample code available

// No sample code available

// No sample code available

# No sample code available

# No sample code available

// No sample code available

Response

Returns the status code 200 and a JSON object with the following properties.

Property Type Description
userIds Array of string List of user IDs of users that have added the LINE official account as a friend. Users of LINE version 7.4.x or earlier are not included in userIds. For more information, see User Consent.
Max: 300 user IDs
next String A continuation token to get the next array of user IDs. Returned only when there are remaining user IDs that were not returned in userIds in the original request. The number of user IDs in the userIds element does not have to reach 300 for the next property to be included in the response.

Example response

{  
   "userIds":[  
      "U4af4980629...",
      "U0c229f96c4...",
      "U95afb1d4df..."
   ],
   "next":"yANU9IA..."
}

Issues a link token used for the account link feature.

HTTP request

POST https://api.line.me/v2/bot/user/{userId}/linkToken

Request headers

Request header Description
Authorization Bearer {channel access token}

Path parameters

Parameter Required Description
userId Required User ID for the LINE account to be linked. Found in the source object of account link event objects. Do not use the LINE ID used in LINE.

Example request

curl -X POST https://api.line.me/v2/bot/user/{userId}/linkToken \
-H 'Authorization: Bearer {channel access token}'

// No sample code available

client = Line::Bot::Client.new{ |config|
    config.channel_secret = ENV["<channel secret>"]
    config.channel_token = ENV["<channel token>"]
}
client.create_link_token(<userId>)

bot, err := linebot.New(<channel secret>, <channel token>)
if err != nil {
    ...
}
res, err := bot.IssueLinkToken(<userId>).Do()
if err != nil {
    ...
}
println(res.LinkToken)

$httpClient = new \LINE\LINEBot\HTTPClient\CurlHTTPClient('<channel access token>');
$bot = new \LINE\LINEBot($httpClient, ['channelSecret' => '<channel secret>']);
$response = $bot->createLinkToken(<userId>);

# No sample code available

link_token_response = line_bot_api.issue_link_token(<user_id>)

const line = require('@line/bot-sdk');

const client = new line.Client({
  channelAccessToken: '<channel access token>'
});

client.getLinkToken('<user_id>')

Response

Returns the status code 200 and a link token. Link tokens are valid for 10 minutes and can only be used once.

Note: The validity period may change without notice.

Example response

{
  "linkToken": "NMZTNuVrPTqlr2IF8Bnymkb7rXfYv5EY"
}

Message objects

JSON object which contains the contents of the message you send.

Common properties for messages

The following properties can be specified in all the message objects.

Quick reply

These properties are used for the quick reply feature. Supported on LINE 8.11.0 and later for iOS and Android. For more information, see Using quick replies.

Property Type Required Description
quickReply Object Optional items object

If the user receives multiple message objects, the quickReply property of the last message object is displayed.

items object

This is a container that contains quick reply buttons.

Property Type Required Description
items Array of objects Required Quick reply button objects. Max: 13 objects
Quick reply button object

This is a quick reply option that is displayed as a button.

Property Type Required Description
type String Required action
imageUrl String Optional URL of the icon that is displayed at the beginning of the button
  • Max: 1000 characters
  • URL scheme: https
  • Image format: PNG
  • Aspect ratio: 1:1
  • Data size: Up to 1 MB
There is no limit on the image size.
If the action property has a camera action, camera roll action, or location action, and the imageUrl property is not set, the default icon is displayed.
action Object Required Action performed when this button is tapped. Specify an action object. The following is a list of the available actions:

If a version of LINE that doesn't support the quick reply feature receives a message that contains quick reply buttons, only the message is displayed.

Example items object

"quickReply": {
  "items": [
    {
      "type": "action",
      "action": {
        "type": "cameraRoll",
        "label": "Send photo"
      }
    },
    {
      "type": "action",
      "action": {
        "type": "camera",
        "label": "Open camera"
      }
    }
  ]
}

Text message

Property Type Required Description
type String Required text
text String Required Message text. You can include the following emoji: Max: 2000 characters

Text message example

{
    "type": "text",
    "text": "Hello, world"
}

Text message example with emoji

{
    "type": "text",
    "text": "\uDBC0\uDC84 LINE emoji"
}

Sticker message

Property Type Required Description
type String Required sticker
packageId String Required Package ID for a set of stickers. For information on package IDs, see the Sticker list.
stickerId String Required Sticker ID. For a list of sticker IDs for stickers that can be sent with the Messaging API, see the Sticker list.

Sticker message example

{
  "type": "sticker",
  "packageId": "1",
  "stickerId": "1"
}

Image message

Property Type Required Description
type String Required image
originalContentUrl String Required Image URL (Max: 1000 characters)
HTTPS over TLS 1.2 or later
JPEG
Max: 4096 x 4096
Max: 1 MB
previewImageUrl String Required Preview image URL (Max: 1000 characters)
HTTPS over TLS 1.2 or later
JPEG
Max: 240 x 240
Max: 1 MB

Image message example

{
    "type": "image",
    "originalContentUrl": "https://example.com/original.jpg",
    "previewImageUrl": "https://example.com/preview.jpg"
}

Video message

Property Type Required Description
type String Required video
originalContentUrl String Required URL of video file (Max: 1000 characters)
HTTPS over TLS 1.2 or later
mp4
Max: 1 minute
Max: 10 MB

A very wide or tall video may be cropped when played in some environments.
previewImageUrl String Required URL of preview image (Max: 1000 characters)
HTTPS over TLS 1.2 or later
JPEG
Max: 240 x 240
Max: 1 MB

Video message example

{
    "type": "video",
    "originalContentUrl": "https://example.com/original.mp4",
    "previewImageUrl": "https://example.com/preview.jpg"
}

Audio message

Property Type Required Description
type String Required audio
originalContentUrl String Required URL of audio file (Max: 1000 characters)
HTTPS over TLS 1.2 or later
m4a
Max: 1 minute
Max: 10 MB
duration Number Required Length of audio file (milliseconds)

Audio message example

{
    "type": "audio",
    "originalContentUrl": "https://example.com/original.m4a",
    "duration": 60000
}

Location message

Property Type Required Description
type String Required location
title String Required Title
Max: 100 characters
address String Required Address
Max: 100 characters
latitude Decimal Required Latitude
longitude Decimal Required Longitude

Location message example

{
    "type": "location",
    "title": "my location",
    "address": "〒150-0002 東京都渋谷区渋谷２丁目２１−１",
    "latitude": 35.65910807942215,
    "longitude": 139.70372892916203
}

Imagemap message

Imagemap messages are messages configured with an image that has multiple tappable areas. You can assign one tappable area for the entire image or different tappable areas on divided areas of the image.

You can also play a video on the image and display a label with a hyperlink after the video is finished.

Property Type Required Description
type String Required imagemap
baseUrl String Required Base URL of the image
Max: 1000 characters
HTTPS over TLS 1.2 or later
For more information about supported images in imagemap messages, see How to configure an image.
altText String Required Alternative text
Max: 400 characters
baseSize.width Number Required Width of base image in pixels. Set to 1040.
baseSize.height Number Required Height of base image. Set to the height that corresponds to a width of 1040 pixels.
video.originalContentUrl String *1 URL of the video file (Max: 1000 characters)
HTTPS over TLS 1.2 or later
mp4
Max: 1 minute
Max: 10 MB

Note: A very wide or tall video may be cropped when played in some environments.
video.previewImageUrl String *1 URL of the preview image (Max: 1000 characters)
HTTPS over TLS 1.2 or later
JPEG
Max: 240 x 240 pixels
Max: 1 MB
video.area.x Number *1 Horizontal position of the video area relative to the left edge of the imagemap area. Value must be 0 or higher.
video.area.y Number *1 Vertical position of the video area relative to the top of the imagemap area. Value must be 0 or higher.
video.area.width Number *1 Width of the video area
video.area.height Number *1 Height of the video area
video.externalLink.linkUri String *2 Webpage URL. Called when the label displayed after the video is tapped.
Max: 1000 characters
The available schemes are http, https, line, and tel. For more information about the LINE URL scheme, see Using the LINE URL scheme.
video.externalLink.label String *2 Label. Displayed after the video is finished.
Max: 30 characters
actions Array of imagemap action objects Required Action when tapped
Max: 50

*1 This property is required if you set a video to play on the imagemap.
*2 This property is required if you set a video to play and a label to display after the video on the imagemap.

How to configure an image

Images used in imagemap messages must meet the following requirements.

  • Image format: JPEG or PNG
  • Image width: 240px, 300px, 460px, 700px, 1040px
  • Maximum file size: Up to 1 MB

Make it possible to access images of 5 different sizes using the baseUrl/{image width} URL format. LINE will then download an image at the appropriate resolution based on the device.

For example, if we had a base URL of https://example.com/images/cats, the URL for the image with a width of 700px would be https://example.com/images/cats/700. To confirm all images display properly, access the image URLs.

Image width Example URL
240px https://example.com/bot/images/rm001/240
300px https://example.com/bot/images/rm001/300
460px https://example.com/bot/images/rm001/460
700px https://example.com/bot/images/rm001/700
1040px https://example.com/bot/images/rm001/1040
note Exclude image extension from URL

Don't include the extension in the image filename. The image will not display in the imagemap message if the URL contains the image file extension (e.g. https://example.com/bot/images/rm001/700.png).

Imagemap action objects

Object which specifies the actions and tappable areas of an imagemap.

When an area is tapped, the user is redirected to the URI specified in uri and the message specified in message is sent.

Imagemap message example with two tappable areas

{
  "type": "imagemap",
  "baseUrl": "https://example.com/bot/images/rm001",
  "altText": "This is an imagemap",
  "baseSize": {
      "width": 1040,
      "height": 1040
  },
  "video": {
      "originalContentUrl": "https://example.com/video.mp4",
      "previewImageUrl": "https://example.com/video_preview.jpg",
      "area": {
          "x": 0,
          "y": 0,
          "width": 1040,
          "height": 585
      },
      "externalLink": {
          "linkUri": "https://example.com/see_more.html",
          "label": "See More"
      }
  },
  "actions": [
      {
          "type": "uri",
          "linkUri": "https://example.com/",
          "area": {
              "x": 0,
              "y": 586,
              "width": 520,
              "height": 454
          }
      },
      {
          "type": "message",
          "text": "Hello",
          "area": {
              "x": 520,
              "y": 586,
              "width": 520,
              "height": 454
          }
      }
  ]
}
Imagemap URI action object
Property Type Required Description
type String Required uri
label String Optional Label for the action. Spoken when the accessibility feature is enabled on the client device.
Max: 50 characters
Supported on LINE 8.2.0 and later for iOS.
linkUri String Required Webpage URL
Max: 1000 characters
The available schemes are http, https, line, and tel. For more information about the LINE URL scheme, see Using the LINE URL scheme.
area Imagemap area object Required Defined tappable area

Example imagemap URI action object

{  
   "type":"uri",
   "label":"https://example.com/",
   "linkUri":"https://example.com/",
   "area":{  
      "x":0,
      "y":0,
      "width":520,
      "height":1040
   }
}
Imagemap message action object
Property Type Required Description
type String Required message
label String Optional Label for the action. Spoken when the accessibility feature is enabled on the client device.
Max: 50 characters
Supported on LINE 8.2.0 and later for iOS.
text String Required Message to send
Max: 400 characters
Supported on LINE for iOS and Android only.
area Imagemap area object Required Defined tappable area

Example imagemap message action object

{  
   "type":"message",
   "label":"hello",
   "text":"hello",
   "area":{  
      "x":520,
      "y":0,
      "width":520,
      "height":1040
   }
}
Imagemap area object

Defines the size of a tappable area. The top left is used as the origin of the area. Set these properties based on the baseSize.width property and the baseSize.height property.

Property Type Required Description
x Number Required Horizontal position relative to the left edge of the area. Value must be 0 or higher.
y Number Required Vertical position relative to the top of the area. Value must be 0 or higher.
width Number Required Width of the tappable area
height Number Required Height of the tappable area

Example imagemap area object

{
   "x":520,
   "y":0,
   "width":520,
   "height":1040
}

Template messages

note Note

Template messages are only supported on LINE 6.7.0 and later for iOS and Android.

Template messages are messages with predefined layouts which you can customize. For more information, see template messages.

The following template types are available:

Common properties of template message objects

The following properties are common to all template message objects.

Property Type Required Description
type String Required template
altText String Required Alternative text.
Max: 400 characters
template Object Required A Buttons, Confirm, Carousel, or Image Carousel object.

Buttons template

Template with an image, title, text, and multiple action buttons.

Property Type Required Description
type String Required buttons
thumbnailImageUrl String Optional Image URL (Max: 1000 characters)
HTTPS over TLS 1.2 or later
JPEG or PNG
Max width: 1024px
Max: 1 MB
imageAspectRatio String Optional Aspect ratio of the image. Specify one of the following values:
  • rectangle: 1.51:1
  • square: 1:1
The default value is rectangle.
imageSize String Optional Size of the image. Specify one of the following values:
  • cover: The image fills the entire image area. Parts of the image that do not fit in the area are not displayed.
  • contain: The entire image is displayed in the image area. A background is displayed in the unused areas to the left and right of vertical images and in the areas above and below horizontal images.
The default value is cover.
imageBackgroundColor String Optional Background color of image. Specify a RGB color value. The default value is #FFFFFF (white).
title String Optional Title
Max: 40 characters
text String Required Message text
Max: 160 characters (no image or title)
Max: 60 characters (message with an image or title)
defaultAction Action object Optional Action when image is tapped; set for the entire image, title, and text area
actions Array of action objects Required Action when tapped
Max: 4

Buttons template message example

{
  "type": "template",
  "altText": "This is a buttons template",
  "template": {
      "type": "buttons",
      "thumbnailImageUrl": "https://example.com/bot/images/image.jpg",
      "imageAspectRatio": "rectangle",
      "imageSize": "cover",
      "imageBackgroundColor": "#FFFFFF",
      "title": "Menu",
      "text": "Please select",
      "defaultAction": {
          "type": "uri",
          "label": "View detail",
          "uri": "http://example.com/page/123"
      },
      "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"
          }
      ]
  }
}

Confirm template

Template with two action buttons.

Property Type Required Description
type String Required confirm
text String Required Message text
Max: 240 characters
actions Array of action objects Required Action when tapped
Set 2 actions for the 2 buttons

Confirm template message example

{
  "type": "template",
  "altText": "this is a confirm template",
  "template": {
      "type": "confirm",
      "text": "Are you sure?",
      "actions": [
          {
            "type": "message",
            "label": "Yes",
            "text": "yes"
          },
          {
            "type": "message",
            "label": "No",
            "text": "no"
          }
      ]
  }
}

Template with multiple columns which can be cycled like a carousel. The columns will be shown in order by scrolling horizontally.

Property Type Required Description
type String Required carousel
columns Array of column objects Required Array of columns
Max: 10
imageAspectRatio String Optional Aspect ratio of the image. Specify one of the following values:
  • rectangle: 1.51:1
  • square: 1:1
Applies to all columns. The default value is rectangle.
imageSize String Optional Size of the image. Specify one of the following values:
  • cover: The image fills the entire image area. Parts of the image that do not fit in the area are not displayed.
  • contain: The entire image is displayed in the image area. A background is displayed in the unused areas to the left and right of vertical images and in the areas above and below horizontal images.
Applies to all columns. The default value is cover.
Property Type Required Description
thumbnailImageUrl String Optional Image URL (Max: 1000 characters)
HTTPS over TLS 1.2 or later
JPEG or PNG
Aspect ratio: 1:1.51
Max width: 1024px
Max: 1 MB
imageBackgroundColor String Optional Background color of image. Specify a RGB color value. The default value is #FFFFFF (white).
title String Optional Title
Max: 40 characters
text String Required Message text
Max: 120 characters (no image or title)
Max: 60 characters (message with an image or title)
defaultAction Action object Optional Action when image is tapped; set for the entire image, title, and text area
actions Array of action objects Required Action when tapped
Max: 3

Carousel template message example

{
  "type": "template",
  "altText": "this is a carousel template",
  "template": {
      "type": "carousel",
      "columns": [
          {
            "thumbnailImageUrl": "https://example.com/bot/images/item1.jpg",
            "imageBackgroundColor": "#FFFFFF",
            "title": "this is menu",
            "text": "description",
            "defaultAction": {
                "type": "uri",
                "label": "View detail",
                "uri": "http://example.com/page/123"
            },
            "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",
            "imageBackgroundColor": "#000000",
            "title": "this is menu",
            "text": "description",
            "defaultAction": {
                "type": "uri",
                "label": "View detail",
                "uri": "http://example.com/page/222"
            },
            "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"
                }
            ]
          }
      ],
      "imageAspectRatio": "rectangle",
      "imageSize": "cover"
  }
}

Template with multiple images which can be cycled like a carousel. The images will be shown in order by scrolling horizontally.

Property Type Required Description
type String Required image_carousel
columns Array of column objects Required Array of columns
Max: 10
Property Type Required Description
imageUrl String Required Image URL (Max: 1000 characters)
HTTPS over TLS 1.2 or later
JPEG or PNG
Aspect ratio: 1:1
Max width: 1024px
Max: 1 MB
action Action object Required Action when image is tapped

Image carousel template message example

{
  "type": "template",
  "altText": "this is a image carousel template",
  "template": {
      "type": "image_carousel",
      "columns": [
          {
            "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"
            }
          }
      ]
  }
}

Flex Message

Flex Messages are messages with a customizable layout. You can customize the layout freely based on the specification for CSS Flexible Box (CSS Flexbox). For more information, see Using Flex Messages in the API documentation.

Property Type Required Description
type String Required flex
altText String Required Alternative text
Max: 400 characters
contents Object Required Flex Message container

Container

A container is the top-level structure of a Flex Message. Here are the types of containers available:

For JSON samples and usage of containers, see Flex Message elements in the API documentation.

Flex Message example

{  
  "type": "flex",
  "altText": "this is a flex message",
  "contents": {
    "type": "bubble",
    "body": {
      "type": "box",
      "layout": "vertical",
      "contents": [
        {
          "type": "text",
          "text": "hello"
        },
        {
          "type": "text",
          "text": "world"
        }
      ]
    }
  }
}
Bubble

This is a container that contains one message bubble. It can contain four blocks: header, hero, body, and footer. For more information about using each block, see Block in the API documentation.

The maximum size of JSON data that defines a bubble is 10 KB.

Property Type Required Description
type String Required bubble
size String Optional The size of the bubble. You can specify one of the following values: nano, micro, kilo, mega, or giga. The default value is mega.
direction String Optional Text directionality and the direction of placement of components in horizontal boxes. Specify one of the following values:
  • ltr: The text is left-to-right horizontal writing, and the components are placed from left to right
  • rtl: The text is right-to-left horizontal writing, and the components are placed from right to left
The default value is ltr.
header Object Optional Header block. Specify a Box.
hero Object Optional Hero block. Specify a box or an image.
body Object Optional Body block. Specify a Box.
footer Object Optional Footer block. Specify a Box.
styles Object Optional Style of each block. Specify a bubble style.
action Object Optional Action performed when this image is tapped. Specify an action object. This property is supported on the following versions of LINE.
  • LINE for iOS and Android: 8.11.0 and later

Bubble example

{
  "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"
  }
}
Objects for the block style

Use the following two objects to define the style of blocks in a bubble.

Bubble style
Property Type Required Description
header Object Optional Header block. Specify a block style.
hero Object Optional Hero block. Specify a block style.
body Object Optional Body block. Specify a block style.
footer Object Optional Footer block. Specify a block style.
Block style
Property Type Required Description
backgroundColor String Optional Background color of the block. Use a hexadecimal color code.
separator Boolean Optional true to place a separator above the block. The default value is false.
separatorColor String Optional Color of the separator. Use a hexadecimal color code.
note Note

You cannot place a separator above the first block.

Example of a bubble style and block style

  "styles": {
    "header": {
      "backgroundColor": "#00ffff"
    },
    "hero": {
      "separator": true,
      "separatorColor": "#000000"
    },
    "footer": {
      "backgroundColor": "#00ffff",
      "separator": true,
      "separatorColor": "#000000"
    }
  }

A carousel is a container that contains multiple bubbles as child elements. Users can scroll horizontally through the bubbles.

The maximum size of JSON data that defines a carousel is 50 KB.

Property Type Required Description
type String Required carousel
contents Array of objects Required Bubbles in the carousel. Max: 10 bubbles
note Bubble width

A carousel cannot contain bubbles of different widths (size property). Each bubble in a carousel should have the same width.

tip Bubble height

The body of each bubble will stretch to match the bubble with the greatest height in the carousel. However, bubbles with no body will not change height.

Component

Components are elements that make up a block. Here are the types of components available:

For JSON samples and usage of each component, see Flex Message elements and Flex Message layout in the API documentation.

Carousel example

{
  "type": "carousel",
  "contents": [
    {
      "type": "bubble",
      "body": {
        "type": "box",
        "layout": "vertical",
        "contents": [
          {
            "type": "text",
            "text": "First bubble"
          }
        ]
      }
    },
    {
      "type": "bubble",
      "body": {
        "type": "box",
        "layout": "vertical",
        "contents": [
          {
            "type": "text",
            "text": "Second bubble"
          }
        ]
      }
    }
  ]
}
Box

This is a component that defines the layout of child components. You can also include a box in a box.

Property Type Required Description
type String Required box
layout String Required The layout style of components in this box. For more information, see Direction of placing components in the API documentation.
contents Array of objects Required Components in this box. Here are the types of components available: Components are rendered in the order specified in the array.
backgroundColor String Optional Background color of the block. In addition to the RGB color, an alpha channel (transparency) can also be set. Use a hexadecimal color code. (Example:#RRGGBBAA) The default value is #00000000.
borderColor String Optional Color of box border. Use a hexadecimal color code.
borderWidth String Optional Width of box border. You can specify a value in pixels or any one of none, light, normal, medium, semi-bold, or bold. none does not render a border while the others become wider in the order of listing.
cornerRadius String Optional Radius at the time of rounding the corners of the border. You can specify a value in pixels or any one of none, xs, sm, md, lg, xl, or xxl. none does not round the corner while the others increase in radius in the order of listing. The default value is none.
width String Optional Width of the box. For more information, see Width of a box in the API documentation.
height String Optional Height of the box. For more information, see Height of a box in the API documentation.
flex Number Optional The ratio of the width or height of this component within the parent box. For more information, see Width and height of components.
spacing String Optional Minimum space between components in this box. The default value is none. For more information, see spacing property of the box in the API documentation.
margin String Optional Minimum space between this component and the previous component in the parent element. For more information, see margin property of the component in the API documentation.
paddingAll String Optional Free space between the borders of this box and the child element. For more information, see Box padding in the API documentation.
paddingTop String Optional Free space between the border at the upper end of this box and the upper end of the child element. For more information, see Box padding in the API documentation.
paddingBottom String Optional Free space between the border at the lower end of this box and the lower end of the child element. For more information, see Box padding in the API documentation.
paddingStart String Optional Free space between the border at the left end of this box and the left end of the child element. For more information, see Box padding in the API documentation.
paddingEnd String Optional Free space between the border at the right end of this box and the right end of the child element. For more information, see Box padding in the API documentation.
position String Optional Reference position for placing this box. Specify one of the following values:
  • relative: Use the previous box as reference.
  • absolute: Use the top left of parent element as reference.
The default value is relative. For more information, see Offset in the API documentation.
offsetTop String Optional The top offset. For more information, see Offset in the API documentation.
offsetBottom String Optional The bottom offset. For more information, see Offset in the API documentation.
offsetStart String Optional The left offset. For more information, see Offset in the API documentation.
offsetEnd String Optional The right offset. For more information, see Offset in the API documentation.
action Object Optional Action performed when this image is tapped. Specify an action object. This property is supported on the following versions of LINE.
  • LINE for iOS and Android: 8.11.0 and later

Box example

{
  "type": "box",
  "layout": "vertical",
  "contents": [
    {
      "type": "image",
      "url": "https://example.com/flex/images/image.jpg"
    },
    {
      "type": "separator"
    },
    {
      "type": "text",
      "text": "Text in the box"
    }
  ]
}
Button

This component renders a button. When the user taps a button, a specified action is performed.

Property Type Required Description
type String Required button
action Object Required Action performed when this button is tapped. Specify an action object.
flex Number Optional The ratio of the width or height of this component within the parent box. For more information, see Width and height of components.
margin String Optional Minimum space between this component and the previous component in the parent element. For more information, see margin property of the component in the API documentation.
position String Optional Reference for offsetTop, offsetBottom, offsetStart, and offsetEnd. Specify one of the following values:
  • relative: Use the previous box as reference.
  • absolute: Use the top left of parent element as reference.
The default value is relative. For more information, see Offset in the API documentation.
offsetTop String Optional The top offset. For more information, see Offset in the API documentation.
offsetBottom String Optional The bottom offset. For more information, see Offset in the API documentation.
offsetStart String Optional The left offset. For more information, see Offset in the API documentation.
offsetEnd String Optional The right offset. For more information, see Offset in the API documentation.
height String Optional Height of the button. You can specify sm or md. The default value is md.
style String Optional Style of the button. Specify one of the following values:
  • primary: Style for dark color buttons
  • secondary: Style for light color buttons
  • link: HTML link style
The default value is link.
color String Optional Character color when the style property is link. Background color when the style property is primary or secondary. Use a hexadecimal color code.
gravity String Optional Alignment style in vertical direction. For more information, see Alignment in vertical direction in the API documentation.

Button example

{
  "type": "button",
  "action": {
    "type": "uri",
    "label": "Tap me",
    "uri": "https://example.com"
  },
  "style": "primary",
  "color": "#0000ff"
}
Image

This component renders an image.

Property Type Required Description
type String Required image
url String Required Image URL
Protocol: HTTPS over TLS 1.2 or later
Image format: JPEG or PNG
Maximum image size: 1024×1024 pixels
Maximum data size: 1 MB
flex Number Optional The ratio of the width or height of this component within the parent box. For more information, see Width and height of components.
margin String Optional Minimum space between this component and the previous component in the parent element. For more information, see margin property of the component in the API documentation.
position String Optional Reference for offsetTop, offsetBottom, offsetStart, and offsetEnd. Specify one of the following values:
  • relative: Use the previous box as reference.
  • absolute: Use the top left of parent element as reference.
The default value is relative. For more information, see Offset in the API documentation.
offsetTop String Optional The top offset. For more information, see Offset in the API documentation.
offsetBottom String Optional The bottom offset. For more information, see Offset in the API documentation.
offsetStart String Optional The left offset. For more information, see Offset in the API documentation.
offsetEnd String Optional The right offset. For more information, see Offset in the API documentation.
align String Optional Alignment style in horizontal direction. For more information, see Alignment in horizontal direction in the API documentation.
gravity String Optional Alignment style in vertical direction. For more information, see Alignment in vertical direction in the API documentation.
size String Optional Maximum size of the image width. You can specify one of the following values: xxs, xs, sm, md, lg, xl, xxl, 3xl, 4xl, 5xl, or full. The size increases in the order of listing. The default value is md.
aspectRatio String Optional Aspect ratio of the image. {width}:{height} format. Specify the value of {width} and {height} in the range from 1 to 100000. However, you cannot set {height} to a value that is more than three times the value of {width}. The default value is 1:1.
aspectMode String Optional The display style of the image if the aspect ratio of the image and that specified by the aspectRatio property do not match. For more information, see About the drawing area.
backgroundColor String Optional Background color of the image. Use a hexadecimal color code.
action Object Optional Action performed when this image is tapped. Specify an action object.
About the drawing area

Specify the max width of the image with the size property and the aspect ratio (horizontal-to-vertical ratio) of the image with the aspectRatio property. The rectangular area determined by the size and aspectRatio properties is called the drawing area. The image is rendered in this drawing area.

  • If the image width specified by the flex property is larger than that calculated from the size property, the width of the drawing area is scaled down to the width of the component.
  • If the aspect ratio of the image and that specified by the aspectRatio property do not match, the image is displayed according to the aspectMode property. The default value is fit.
    • If the value of aspectMode is cover: The image fills the entire drawing area. Parts of the image that do not fit in the drawing area are not displayed.
    • If the value of aspectMode is fit: The entire image is displayed in the drawing area. The background is displayed in the unused areas to the left and right of vertical images and in the areas above and below horizontal images.

Image example

{
  "type": "image",
  "url": "https://example.com/flex/images/image.jpg",
  "size": "full",
  "aspectRatio": "1.91:1"
}
Icon

This component renders an icon for decorating the adjacent text.

This component can be used only in a baseline box.

Property Type Required Description
type String Required icon
url String Required Image URL
Protocol: HTTPS over TLS 1.2 or later
Image format: JPEG or PNG
Maximum image size: 1024×1024 pixels
Maximum data size: 1 MB
margin String Optional Minimum space between this component and the previous component in the parent element. For more information, see margin property of the component in the API documentation.
position String Optional Reference for offsetTop, offsetBottom, offsetStart, and offsetEnd. Specify one of the following values:
  • relative: Use the previous box as reference.
  • absolute: Use the top left of parent element as reference.
The default value is relative. For more information, see Offset in the API documentation.
offsetTop String Optional The top offset. For more information, see Offset in the API documentation.
offsetBottom String Optional The bottom offset. For more information, see Offset in the API documentation.
offsetStart String Optional The left offset. For more information, see Offset in the API documentation.
offsetEnd String Optional The right offset. For more information, see Offset in the API documentation.
size String Optional Maximum size of the icon width. You can specify one of the following values: xxs, xs, sm, md, lg, xl, xxl, 3xl, 4xl, or 5xl. The size increases in the order of listing. The default value is md.
aspectRatio String Optional Aspect ratio of the icon. {width}:{height} format. The values of {width} and {height} must be in the range 1–100000. {height} can't be more than three times the value of {width}. The default value is 1:1.

The icon's flex property is fixed to 0.

Icon example

{
  "type": "icon",
  "url": "https://example.com/icon/png/caution.png",
  "size": "lg",
  "aspectRatio": "1.91:1"
}
Text

This component renders a text string in one row. You can specify font color, size, and weight.

Property Type Required Description
type String Required text
text String Required Text Be sure to set either one of the text property or contents property. If you set the contents property, text is ignored.
contents Array of objects Optional Array of spans. Be sure to set either one of the text property or contents property. If you set the contents property, text is ignored.
flex Number Optional The ratio of the width or height of this component within the parent box. For more information, see Width and height of components.
margin String Optional Minimum space between this component and the previous component in the parent element. For more information, see margin property of the component in the API documentation.
position String Optional Reference for offsetTop, offsetBottom, offsetStart, and offsetEnd. Specify one of the following values:
  • relative: Use the previous box as reference.
  • absolute: Use the top left of parent element as reference.
The default value is relative. For more information, see Offset in the API documentation.
offsetTop String Optional The top offset. For more information, see Offset in the API documentation.
offsetBottom String Optional The bottom offset. For more information, see Offset in the API documentation.
offsetStart String Optional The left offset. For more information, see Offset in the API documentation.
offsetEnd String Optional The right offset. For more information, see Offset in the API documentation.
size String Optional Font size. You can specify one of the following values: xxs, xs, sm, md, lg, xl, xxl, 3xl, 4xl, or 5xl. The size increases in the order of listing. The default value is md.
align String Optional Alignment style in horizontal direction. For more information, see Alignment in horizontal direction in the API documentation.
gravity String Optional Alignment style in vertical direction. The default value is top. For more information, see Alignment in vertical direction in the API documentation.
wrap Boolean Optional true to wrap text. The default value is false. If set to true, you can use a new line character (\n) to begin on a new line. For more information, see Wrapping text in the API documentation.
maxLines Number Optional Max number of lines. If the text does not fit in the specified number of lines, an ellipsis (…) is displayed at the end of the last line. If set to 0, all the text is displayed. The default value is 0. This property is supported on the following versions of LINE.
  • LINE for iOS and Android: 8.11.0 and later
weight String Optional Font weight. You can specify one of the following values: regular or bold. Specifying bold makes the font bold. The default value is regular.
color String Optional Font color. Use a hexadecimal color code.
action Object Optional Action performed when this image is tapped. Specify an action object.
style String Optional Style of the text. Specify one of the following values:
  • normal: Normal
  • italic: Italic
The default value is normal.
decoration String Optional Decoration of the text. Specify one of the following values:
  • none: No decoration
  • underline: Underline
  • line-through: Strikethrough
The default value is none.

Text example

{
  "type": "text",
  "text": "Hello, World!",
  "size": "xl",
  "weight": "bold",
  "color": "#0000ff"