English

# Messaging API reference

# Common specifications

Common specifications for Messaging API, such as the domain name of endpoints, response when a request succeeds or fails, and rate limit.

# Webhooks

When an event occurs, such as when a user adds your LINE Official Account as a friend or sends a message, the LINE Platform sends an HTTPS POST request to the webhook URL (bot server).

The webhook URL is configured for each channel in the LINE Developers Console.

# Webhook Event Objects

These are JSON objects containing events generated by the LINE platform.

# Webhook settings

You can configure, test, and get information on channel webhook endpoints.

Endpoints 

PUT  /v2/bot/channel/webhook/endpoint
GET  /v2/bot/channel/webhook/endpoint
POST /v2/bot/channel/webhook/test

# Getting content

You can get the content that a user has sent to your LINE Official Account by using the message IDs received via the webhook.

Endpoints 

GET /v2/bot/message/{messageId}/content
GET /v2/bot/message/{messageId}/content/transcoding
GET /v2/bot/message/{messageId}/content/preview

# Channel access token

You can issue, get, or revoke the channel access token required when calling the Messaging API from the app.

Endpoints 

POST /oauth2/v2.1/token
GET  /oauth2/v2.1/verify
GET  /oauth2/v2.1/tokens/kid
POST /oauth2/v2.1/revoke
POST /v2/oauth/accessToken
POST /v2/oauth/verify
POST /v2/oauth/revoke

# Message

You can send a message and obtain information about the sent message.

Endpoints 

POST /v2/bot/message/reply
POST /v2/bot/message/push
POST /v2/bot/message/multicast
POST /v2/bot/message/narrowcast
GET  /v2/bot/message/progress/narrowcast
POST /v2/bot/message/broadcast
GET  /v2/bot/message/quota
GET  /v2/bot/message/quota/consumption
GET  /v2/bot/message/delivery/reply
GET  /v2/bot/message/delivery/push
GET  /v2/bot/message/delivery/multicast
GET  /v2/bot/message/delivery/broadcast
POST /v2/bot/message/validate/reply
POST /v2/bot/message/validate/push
POST /v2/bot/message/validate/multicast
POST /v2/bot/message/validate/narrowcast
POST /v2/bot/message/validate/broadcast
GET  /v2/bot/message/aggregation/info
GET  /v2/bot/message/aggregation/list

# Managing Audience

You can create, update, activate, or delete an audience. Specify the audience when sending narrowcast messages.

Endpoints 

POST   /v2/bot/audienceGroup/upload
POST   /v2/bot/audienceGroup/upload/byFile
PUT    /v2/bot/audienceGroup/upload
PUT    /v2/bot/audienceGroup/upload/byFile
POST   /v2/bot/audienceGroup/click
POST   /v2/bot/audienceGroup/imp
PUT    /v2/bot/audienceGroup/{audienceGroupId}/updateDescription
PUT    /v2/bot/audienceGroup/{audienceGroupId}/activate
DELETE /v2/bot/audienceGroup/{audienceGroupId}
GET    /v2/bot/audienceGroup/{audienceGroupId}
GET    /v2/bot/audienceGroup/list
GET    /v2/bot/audienceGroup/authorityLevel
PUT    /v2/bot/audienceGroup/authorityLevel

# Insight

You can obtain information on the number of messages sent from the LINE Official Account, number of friends, and other statistical data.

Endpoints 

GET /v2/bot/insight/message/delivery?date={date}
GET /v2/bot/insight/followers?date={date}
GET /v2/bot/insight/demographic
GET /v2/bot/insight/message/event?requestId={requestId}
GET /v2/bot/insight/message/event/aggregation?customAggregationUnit={customAggregationUnit}&from={from}&to={to}

# Users

You can get information of users who have added your LINE Official Account as a friend.

Accessing your own user ID

You can access your user ID under the Basic settings tab of your channel on the LINE Developers Console. For more information on permissions per role in the LINE Developers Console, see Channel roles in Managing roles. There is no API available for retrieving your own user ID.

Endpoints 

GET /v2/bot/profile/{userId}
GET /v2/bot/followers/ids

# Bot

You can obtain basic information on the LINE Official Account's bots.

Endpoints 

GET /v2/bot/info

# Group chats

You can obtain information about the group chats and their members that the LINE Official Account is a member of.

Endpoints 

GET  /v2/bot/group/{groupId}/summary
GET  /v2/bot/group/{groupId}/members/count
GET  /v2/bot/group/{groupId}/members/ids
GET  /v2/bot/group/{groupId}/member/{userId}
POST /v2/bot/group/{groupId}/leave

# Multi-person chats

You can obtain information about the multi-person chats and their members that the LINE Official Account is a member of.

Endpoints 

GET  /v2/bot/room/{roomId}/members/count
GET  /v2/bot/room/{roomId}/members/ids
GET  /v2/bot/room/{roomId}/member/{userId}
POST /v2/bot/room/{roomId}/leave

# Rich menu

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

Endpoints 

POST   /v2/bot/richmenu
POST   /v2/bot/richmenu/validate
POST   /v2/bot/richmenu/{richMenuId}/content
GET    /v2/bot/richmenu/{richMenuId}/content
GET    /v2/bot/richmenu/list
GET    /v2/bot/richmenu/{richMenuId}
DELETE /v2/bot/richmenu/{richMenuId}
POST   /v2/bot/user/all/richmenu/{richMenuId}
GET    /v2/bot/user/all/richmenu
DELETE /v2/bot/user/all/richmenu
POST   /v2/bot/richmenu/alias
DELETE /v2/bot/richmenu/alias/{richMenuAliasId}
POST   /v2/bot/richmenu/alias/{richMenuAliasId}
GET    /v2/bot/richmenu/alias/{richMenuAliasId}
GET    /v2/bot/richmenu/alias/list
POST   /v2/bot/user/{userId}/richmenu/{richMenuId}
POST   /v2/bot/richmenu/bulk/link
GET    /v2/bot/user/{userId}/richmenu
DELETE /v2/bot/user/{userId}/richmenu
POST   /v2/bot/richmenu/bulk/unlink

You can link the service account provided by the provider (corporate and developer) with the account of the LINE user.

Endpoints 

POST /v2/bot/user/{userId}/linkToken

# Message objects

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

Validating message objects

By using the following endpoints, you can validate message objects:

# Action objects

These are types of actions for your bot to take when a user taps a button or an image in a message.

# Rich menu structure

Rich menus consist of either of these objects.

Area objects and action objects are included in these objects.