How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

LINE Messaging API

The core LINE bot API — 73 operations for replying, pushing, multicasting, broadcasting and narrowcasting messages to LINE users, plus rich menus, Flex messages, group and room membership, profiles, followers, message quota, delivery statistics, coupons, memberships and webhook endpoint configuration. Supports idempotent retries via the X-Line-Retry-Key header on the four metered send operations. Binary content (message media, rich menu images) is served from api-data.line.me rather than api.line.me.

LINE Messaging API is one of 10 APIs that LINE publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Messaging, Chatbots, Rich Menu, and Webhook. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, and an AsyncAPI specification.

This API exposes 73 operations across 65 paths, organized into 2 resource areas, and defines 203 schemas. It is described by OpenAPI 3.0.0, at version 0.0.1.

Requests are made against a single base URL, https://api.line.me.

73 operations 65 paths 203 schemas 4 DELETE37 GET30 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
0.0.1
Base URL
https://api.line.me
Authentication
HTTP Bearer
Resource Areas
2

Authentication & Security 1

LINE Messaging API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (Bearer). By default, every request must be authenticated.

  • Bearer — Channel access token

Paths & Operations 73

Across 65 paths, the API surfaces 73 operations — 4 DELETE, 37 GET, 30 POST, 2 PUT. They span 2 resource areas: messaging-api, messaging-api-blob. Each is listed below with its method, path, parameters, and response codes.

messaging-api 68
GET
/v2/bot/channel/webhook/endpoint
Get webhook endpoint information
getWebhookEndpoint → 200
PUT
/v2/bot/channel/webhook/endpoint
Set webhook endpoint URL
setWebhookEndpoint body → 200
POST
/v2/bot/channel/webhook/test
Test webhook endpoint
testWebhookEndpoint body → 200
POST
/v2/bot/message/reply
Send reply message
replyMessage body → 200400429
POST
/v2/bot/message/push
Sends a message to a user, group chat, or multi-person chat at any time.
pushMessage 1 param body → 200400403409429
POST
/v2/bot/message/multicast
An API that efficiently sends the same message to multiple user IDs. You can't send messages to group chats or multi-person chats.
multicast 1 param body → 200400403409429
POST
/v2/bot/message/narrowcast
Send narrowcast message
narrowcast 1 param body → 202400403409429
GET
/v2/bot/message/progress/narrowcast
Gets the status of a narrowcast message.
getNarrowcastProgress 1 param → 200
POST
/v2/bot/message/broadcast
Sends a message to multiple users at any time.
broadcast 1 param body → 200400403409429
GET
/v2/bot/message/quota
Gets the target limit for sending messages in the current month. The total number of the free messages and the additional messages is returned.
getMessageQuota → 200
GET
/v2/bot/message/quota/consumption
Gets the number of messages sent in the current month.
getMessageQuotaConsumption → 200
GET
/v2/bot/message/delivery/reply
Get number of sent reply messages
getNumberOfSentReplyMessages 1 param → 200
GET
/v2/bot/message/delivery/push
Get number of sent push messages
getNumberOfSentPushMessages 1 param → 200
GET
/v2/bot/message/delivery/multicast
Get number of sent multicast messages
getNumberOfSentMulticastMessages 1 param → 200
GET
/v2/bot/message/delivery/broadcast
Get number of sent broadcast messages
getNumberOfSentBroadcastMessages 1 param → 200
POST
/v2/bot/message/validate/reply
Validate message objects of a reply message
validateReply body → 200
POST
/v2/bot/message/validate/push
Validate message objects of a push message
validatePush body → 200
POST
/v2/bot/message/validate/multicast
Validate message objects of a multicast message
validateMulticast body → 200
POST
/v2/bot/message/validate/narrowcast
Validate message objects of a narrowcast message
validateNarrowcast body → 200
POST
/v2/bot/message/validate/broadcast
Validate message objects of a broadcast message
validateBroadcast body → 200
GET
/v2/bot/message/aggregation/info
Get number of units used this month
getAggregationUnitUsage → 200
GET
/v2/bot/message/aggregation/list
Get name list of units used this month
getAggregationUnitNameList 2 params → 200
GET
/v2/bot/profile/{userId}
Get profile
getProfile 1 param → 200
GET
/v2/bot/followers/ids
Get a list of users who added your LINE Official Account as a friend
getFollowers 2 params → 200
GET
/v2/bot/info
Get bot info
getBotInfo → 200
GET
/v2/bot/group/{groupId}/member/{userId}
Get group chat member profile
getGroupMemberProfile 2 params → 200
GET
/v2/bot/room/{roomId}/member/{userId}
Get multi-person chat member profile
getRoomMemberProfile 2 params → 200
GET
/v2/bot/group/{groupId}/members/ids
Get group chat member user IDs
getGroupMembersIds 2 params → 200
GET
/v2/bot/room/{roomId}/members/ids
Get multi-person chat member user IDs
getRoomMembersIds 2 params → 200
POST
/v2/bot/group/{groupId}/leave
Leave group chat
leaveGroup 1 param → 200400404
POST
/v2/bot/room/{roomId}/leave
Leave multi-person chat
leaveRoom 1 param → 200
GET
/v2/bot/group/{groupId}/summary
Get group chat summary
getGroupSummary 1 param → 200
GET
/v2/bot/group/{groupId}/members/count
Get number of users in a group chat
getGroupMemberCount 1 param → 200
GET
/v2/bot/room/{roomId}/members/count
Get number of users in a multi-person chat
getRoomMemberCount 1 param → 200
POST
/v2/bot/richmenu
Create rich menu
createRichMenu body → 200
POST
/v2/bot/richmenu/validate
Validate rich menu object
validateRichMenuObject body → 200
GET
/v2/bot/richmenu/{richMenuId}
Gets a rich menu via a rich menu ID.
getRichMenu 1 param → 200
DELETE
/v2/bot/richmenu/{richMenuId}
Deletes a rich menu.
deleteRichMenu 1 param → 200
GET
/v2/bot/richmenu/list
Get rich menu list
getRichMenuList → 200
POST
/v2/bot/user/all/richmenu/{richMenuId}
Set default rich menu
setDefaultRichMenu 1 param → 200
GET
/v2/bot/user/all/richmenu
Gets the ID of the default rich menu set with the Messaging API.
getDefaultRichMenuId → 200
DELETE
/v2/bot/user/all/richmenu
Cancel default rich menu
cancelDefaultRichMenu → 200
POST
/v2/bot/richmenu/alias
Create rich menu alias
createRichMenuAlias body → 200400
GET
/v2/bot/richmenu/alias/{richMenuAliasId}
Get rich menu alias information
getRichMenuAlias 1 param → 200
POST
/v2/bot/richmenu/alias/{richMenuAliasId}
Update rich menu alias
updateRichMenuAlias 1 param body → 200400
DELETE
/v2/bot/richmenu/alias/{richMenuAliasId}
Delete rich menu alias
deleteRichMenuAlias 1 param → 200400
GET
/v2/bot/richmenu/alias/list
Get list of rich menu alias
getRichMenuAliasList → 200
GET
/v2/bot/user/{userId}/richmenu
Get rich menu ID of user
getRichMenuIdOfUser 1 param → 200
DELETE
/v2/bot/user/{userId}/richmenu
Unlink rich menu from user
unlinkRichMenuIdFromUser 1 param → 200
POST
/v2/bot/user/{userId}/richmenu/{richMenuId}
Link rich menu to user.
linkRichMenuIdToUser 2 params → 200
POST
/v2/bot/richmenu/bulk/link
Link rich menu to multiple users
linkRichMenuIdToUsers body → 202
POST
/v2/bot/richmenu/bulk/unlink
Unlink rich menus from multiple users
unlinkRichMenuIdFromUsers body → 202
POST
/v2/bot/richmenu/batch
You can use this endpoint to batch control the rich menu linked to the users using the endpoint such as Link rich menu to user. The following operations are available: 1. Replace a rich menu with ano…
richMenuBatch body → 202
POST
/v2/bot/richmenu/validate/batch
Validate a request body of the Replace or unlink the linked rich menus in batches endpoint.
validateRichMenuBatchRequest body → 200
GET
/v2/bot/richmenu/progress/batch
Get the status of Replace or unlink a linked rich menus in batches.
getRichMenuBatchProgress 1 param → 200
POST
/v2/bot/user/{userId}/linkToken
Issue link token
issueLinkToken 1 param → 200
POST
/v2/bot/message/markAsRead
Mark messages from users as read
markMessagesAsRead body → 200
POST
/bot/pnp/push
Send LINE notification message
pushMessagesByPhone 1 param body → 200422
GET
/v2/bot/message/delivery/pnp
Get number of sent LINE notification messages
getPNPMessageStatistics 1 param → 200
GET
/v2/bot/membership/subscription/{userId}
Get a user's membership subscription.
getMembershipSubscription 1 param → 200400404
GET
/v2/bot/membership/list
Get a list of memberships.
getMembershipList → 200404
GET
/v2/bot/membership/{membershipId}/users/ids
Get a list of user IDs who joined the membership.
getJoinedMembershipUsers 3 params → 200400404
GET
/v2/bot/coupon
Get a paginated list of coupons.
listCoupon 3 params → 200400
POST
/v2/bot/coupon
Create a new coupon. Define coupon details such as type, title, and validity period.
createCoupon body → 200400
GET
/v2/bot/coupon/{couponId}
Get coupon detail
getCouponDetail 1 param → 200400404
PUT
/v2/bot/coupon/{couponId}/close
Close coupon
closeCoupon 1 param → 200400404410
POST
/v2/bot/chat/loading/start
Display a loading animation in one-on-one chats between users and LINE Official Accounts.
showLoadingAnimation body → 202400
POST
/v2/bot/chat/markAsRead
Mark messages from users as read by token
markMessagesAsReadByToken body → 200400
messaging-api-blob 5
GET
/v2/bot/message/{messageId}/content
Download image, video, and audio data sent from users.
getMessageContent 1 param → 200
GET
/v2/bot/message/{messageId}/content/preview
Get a preview image of the image or video
getMessageContentPreview 1 param → 200
GET
/v2/bot/message/{messageId}/content/transcoding
Verify the preparation status of a video or audio for getting
getMessageContentTranscodingByMessageId 1 param → 200
GET
/v2/bot/richmenu/{richMenuId}/content
Download rich menu image.
getRichMenuImage 1 param → 200
POST
/v2/bot/richmenu/{richMenuId}/content
Upload rich menu image
setRichMenuImage 1 param body → 200

Schemas 203

The contract defines 203 schemas that model the data the API accepts and returns. The most detailed are CouponResponse (18 properties), CouponCreateRequest (13 properties), Membership (10 properties), NarrowcastProgressResponse (8 properties). Each schema is shown below with its type and property counts.

GetWebhookEndpointResponse
object
2 properties 2 required
SetWebhookEndpointRequest
object
1 property 1 required
TestWebhookEndpointRequest
object
1 property
TestWebhookEndpointResponse
object
5 properties 4 required
GetMessageContentTranscodingResponse
object
Transcoding response
1 property 1 required
ReplyMessageRequest
object
3 properties 2 required
ReplyMessageResponse
object
1 property 1 required
SentMessage
object
2 properties 1 required
PushMessageRequest
object
4 properties 2 required
NotificationDisabled
boolean
true: The user doesn’t receive a push notification when a message is sent. false: The user receives a push notification when the message is sent (unless they h…
PushMessageResponse
object
1 property 1 required
MulticastRequest
object
4 properties 2 required
MulticastResponse
object
NarrowcastRequest
object
5 properties 1 required
NarrowcastResponse
object
Recipient
object
Recipient
1 property
OperatorRecipient
object
AudienceRecipient
object
RedeliveryRecipient
object
Filter
object
Filter for narrowcast
1 property
DemographicFilter
object
Demographic filter
1 property
AgeDemographicFilter
object
AgeDemographic
string
AppTypeDemographicFilter
object
AppTypeDemographic
string
AreaDemographicFilter
object
AreaDemographic
string
GenderDemographicFilter
object
GenderDemographic
string
OperatorDemographicFilter
object
SubscriptionPeriodDemographicFilter
object
SubscriptionPeriodDemographic
string
Limit
object
Limit of the Narrowcast
3 properties
NarrowcastProgressResponse
object
8 properties 2 required
BroadcastRequest
object
2 properties 1 required
BroadcastResponse
object
MessageQuotaResponse
object
2 properties 1 required
QuotaType
string
One of the following values to indicate whether a target limit is set or not.
QuotaConsumptionResponse
object
1 property 1 required
NumberOfMessagesResponse
object
2 properties 1 required
ValidateMessageRequest
object
1 property 1 required
GetAggregationUnitUsageResponse
object
1 property 1 required
GetAggregationUnitNameListResponse
object
2 properties 1 required
UserProfileResponse
object
5 properties 2 required
GetFollowersResponse
object
2 properties 1 required
BotInfoResponse
object
7 properties 5 required
GroupUserProfileResponse
object
3 properties 2 required
RoomUserProfileResponse
object
3 properties 2 required
MembersIdsResponse
object
2 properties 1 required
GroupSummaryResponse
object
3 properties 2 required
GroupMemberCountResponse
object
1 property 1 required
RoomMemberCountResponse
object
1 property 1 required
RichMenuRequest
object
5 properties
RichMenuSize
object
Rich menu size
2 properties
RichMenuArea
object
Rich menu area
2 properties
RichMenuBounds
object
Rich menu bounds
4 properties
RichMenuIdResponse
object
1 property 1 required
RichMenuResponse
object
6 properties 6 required
RichMenuListResponse
object
1 property 1 required
CreateRichMenuAliasRequest
object
2 properties 2 required
RichMenuAliasResponse
object
2 properties 2 required
UpdateRichMenuAliasRequest
object
1 property 1 required
RichMenuAliasListResponse
object
1 property 1 required
RichMenuBulkLinkRequest
object
2 properties 2 required
RichMenuBulkUnlinkRequest
object
1 property 1 required
RichMenuBatchRequest
object
2 properties 1 required
RichMenuBatchOperation
object
Rich menu operation object represents the batch operation to the rich menu linked to the user.
1 property 1 required
RichMenuBatchLinkOperation
object
Replace the rich menu with the rich menu specified in the to property for all users linked to the rich menu specified in the from property.
2 required
RichMenuBatchUnlinkOperation
object
Unlink the rich menu for all users linked to the rich menu specified in the from property.
1 required
RichMenuBatchUnlinkAllOperation
object
Unlink the rich menu from all users linked to the rich menu.
RichMenuBatchProgressResponse
object
3 properties 2 required
RichMenuBatchProgressPhase
string
The current status. One of: ongoing: Rich menu batch control is in progress. succeeded: Rich menu batch control is complete. failed: Rich menu batch control fa…
IssueLinkTokenResponse
object
1 property 1 required
MarkMessagesAsReadRequest
object
1 property 1 required
ChatReference
object
Chat reference
1 property 1 required
PnpMessagesRequest
object
3 properties 2 required
Message
object
3 properties 1 required
QuickReply
object
Quick reply
1 property
QuickReplyItem
object
3 properties
Sender
object
Change icon and display name
2 properties
TextMessage
object
1 required
Emoji
object
3 properties
TextMessageV2
object
1 required
SubstitutionObject
object
An object that defines the replacement value for a placeholder in the text.
1 property 1 required
MentionSubstitutionObject
An object representing a mention substitution.
MentionTarget
object
1 property 1 required
UserMentionTarget
AllMentionTarget
EmojiSubstitutionObject
An object representing a emoji substitution.
StickerMessage
object
2 required
ImageMessage
object
2 required
VideoMessage
object
2 required
AudioMessage
object
2 required
LocationMessage
object
4 required
ImagemapMessage
object
4 required
ImagemapBaseSize
object
2 properties 2 required
ImagemapAction
object
2 properties 2 required
MessageImagemapAction
object
1 required
URIImagemapAction
object
1 required
ClipboardImagemapAction
object
1 required
ImagemapArea
object
4 properties 4 required
ImagemapVideo
object
4 properties
ImagemapExternalLink
object
2 properties
TemplateMessage
object
2 required
Template
object
1 property 1 required
ButtonsTemplate
object
2 required
TemplateImageAspectRatio
string
Aspect ratio of the image. This is only for the imageAspectRatio in ButtonsTemplate. Specify one of the following values: rectangle: 1.51:1 square: 1:1
TemplateImageSize
string
Size of the image. This is only for the imageSize in ButtonsTemplate. Specify one of the following values: cover: The image fills the entire image area. Parts…
ConfirmTemplate
object
2 required
CarouselTemplate
object
1 required
CarouselColumn
object
Column object for carousel template.
6 properties 2 required
ImageCarouselTemplate
object
1 required
ImageCarouselColumn
object
2 properties 2 required
CouponMessage
object
1 required
FlexMessage
object
2 required
FlexContainer
object
1 property 1 required
FlexBubble
object
FlexCarousel
object
1 required
FlexBubbleStyles
object
4 properties
FlexBlockStyle
object
3 properties
FlexComponent
object
1 property 1 required
FlexBox
object
2 required
FlexBoxBorderWidth
string
Width of box border. This is only for borderWidth in FlexBox. A value of none means that borders are not rendered; the other values are listed in order of incr…
FlexBoxCornerRadius
string
Radius at the time of rounding the corners of the box. This is only for cornerRadius in FlexBox. A value of none means that corners are not rounded; the other…
FlexBoxSpacing
string
You can specify the minimum space between two components with the spacing property of the parent box component, in pixels or with a keyword. FlexBoxSpacing jus…
FlexMargin
string
You can specify the minimum space before a child component with the margin property of the child component, in pixels or with a keyword. FlexMargin just provid…
FlexBoxPadding
string
Padding can be specified in pixels, percentage (to the parent box width) or with a keyword. FlexBoxPadding just provides only keywords.
FlexImageSize
string
You can set the width of an Flex image component with the size property, in pixels, as a percentage, or with a keyword. FlexImageSize just provides only keywor…
FlexIconSize
string
You can set the width of an Flex icon component with the size property, in pixels, as a percentage, or with a keyword. FlexIconSize just provides only keywords.
FlexTextFontSize
string
Font size in the size property of the Flex text component. You can specify the size in pixels or with a keyword. FlexTextFontSize just provides only keywords.
FlexSpanSize
string
Font size in the size property of the Flex span component. You can specify the size in pixels or with a keyword. FlexSpanSize just provides only keywords.
FlexOffset
string
You can specify the offset of a component with the offset property, in pixels or with a keyword. You can also specify the percentage to the box width for offse…
FlexButton
object
1 required
FlexImage
object
2 required
FlexVideo
object
3 required
FlexIcon
object
1 required
FlexText
object
FlexSpan
object
FlexSeparator
object
FlexFiller
object
FlexBoxBackground
object
1 property 1 required
FlexBoxLinearGradient
object
Action
object
Action
2 properties
CameraAction
object
CameraRollAction
object
ClipboardAction
object
DatetimePickerAction
object
LocationAction
object
MessageAction
object
PostbackAction
object
RichMenuSwitchAction
object
URIAction
object
AltUri
object
1 property
GetMembershipSubscriptionResponse
object
A user's membership subscription status
1 property 1 required
MembershipListResponse
object
List of memberships
1 property 1 required
GetJoinedMembershipUsersResponse
object
List of users who have joined the membership
2 properties 1 required
Subscription
object
An array of memberships.
2 properties 2 required
SubscribedMembershipPlan
object
Object containing information about the membership plan.
6 properties 6 required
SubscribedMembershipUser
object
Object containing user membership subscription information.
4 properties 4 required
Membership
object
10 properties 10 required
CouponCreateRequest
object
Request object for creating a coupon. Contains all configurable coupon properties.
13 properties 7 required
AcquisitionConditionRequest
object
1 property 1 required
NormalAcquisitionConditionRequest
object
LotteryAcquisitionConditionRequest
object
CouponRewardRequest
object
1 property 1 required
CouponCashBackRewardRequest
object
CouponDiscountRewardRequest
object
CouponFreeRewardRequest
object
CouponGiftRewardRequest
object
CouponOthersRewardRequest
object
CashBackPriceInfoRequest
object
1 property 1 required
CashBackFixedPriceInfoRequest
object
CashBackPercentagePriceInfoRequest
object
DiscountPriceInfoRequest
object
1 property 1 required
DiscountFixedPriceInfoRequest
object
DiscountPercentagePriceInfoRequest
object
DiscountExplicitPriceInfoRequest
object
CouponCreateResponse
object
Response object returned after creating a coupon. Contains the coupon ID.
1 property 1 required
CouponResponse
object
Detailed information about a coupon, including all properties and current status.
18 properties
AcquisitionConditionResponse
object
1 property 1 required
NormalAcquisitionConditionResponse
object
LotteryAcquisitionConditionResponse
object
ReferralAcquisitionConditionResponse
object
CouponRewardResponse
object
1 property 1 required
CouponCashBackRewardResponse
object
CouponDiscountRewardResponse
object
CouponFreeRewardResponse
object
CouponGiftRewardResponse
object
CouponOthersRewardResponse
object
CashBackPriceInfoResponse
object
1 property 1 required
CashBackFixedPriceInfoResponse
object
CashBackPercentagePriceInfoResponse
object
DiscountPriceInfoResponse
object
1 property 1 required
DiscountFixedPriceInfoResponse
object
DiscountPercentagePriceInfoResponse
object
DiscountExplicitPriceInfoResponse
object
MessagingApiPagerCouponListResponse
object
Paginated response object containing a list of coupons.
2 properties 1 required
CouponListResponse
object
Summary information about a coupon, used in coupon lists.
2 properties 2 required
ShowLoadingAnimationRequest
object
2 properties 1 required
ShowLoadingAnimationResponse
object
MarkMessagesAsReadByTokenRequest
object
1 property 1 required
ErrorResponse
object
3 properties 1 required
ErrorDetail
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

line-messaging-api-openapi.yml Raw ↑

Other APIs LINE publishes across the network.

LINE Messaging API Webhook
LINE Channel Access Token API
LINE Insight API
LINE Manage Audience API
LIFF Server API
LINE Module API
LINE Module Attach API
LINE Mission Sticker API
LINE Login v2.1
Where this information came from

This is an independent, third-party profile of LINE Messaging API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.