LINE Messaging API is one of 12 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 API. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, an AsyncAPI specification, and authentication docs.
This API exposes
68 operations
across 61 paths,
and defines 84 schemas.
It is described by OpenAPI 3.2.0, at version 0.0.1.
Requests are made against a single base URL, https://api.line.me.
68 operations61 paths84 schemas4 DELETE33 GET29 POST2 PUT
Metadata
The identity and technical contract details declared by the specification.
Specification
OpenAPI 3.2.0
API Version
0.0.1
Base URL
https://api.line.me
Authentication
HTTP Bearer
Resource Areas
1
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 68
Across 61 paths, the API surfaces 68 operations — 4 DELETE, 33 GET, 29 POST, 2 PUT. 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
setWebhookEndpointbody→ 200
POST
/v2/bot/channel/webhook/test
Test webhook endpoint
testWebhookEndpointbody→ 200
POST
/v2/bot/message/reply
Send reply message
replyMessagebody→ 200400429
POST
/v2/bot/message/push
Sends a message to a user, group chat, or multi-person chat at any time.
pushMessage1 parambody→ 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.
multicast1 parambody→ 200400403409429
POST
/v2/bot/message/narrowcast
Send narrowcast message
narrowcast1 parambody→ 202400403409429
GET
/v2/bot/message/progress/narrowcast
Gets the status of a narrowcast message.
getNarrowcastProgress1 param→ 200
POST
/v2/bot/message/broadcast
Sends a message to multiple users at any time.
broadcast1 parambody→ 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
getNumberOfSentReplyMessages1 param→ 200
GET
/v2/bot/message/delivery/push
Get number of sent push messages
getNumberOfSentPushMessages1 param→ 200
GET
/v2/bot/message/delivery/multicast
Get number of sent multicast messages
getNumberOfSentMulticastMessages1 param→ 200
GET
/v2/bot/message/delivery/broadcast
Get number of sent broadcast messages
getNumberOfSentBroadcastMessages1 param→ 200
POST
/v2/bot/message/validate/reply
Validate message objects of a reply message
validateReplybody→ 200
POST
/v2/bot/message/validate/push
Validate message objects of a push message
validatePushbody→ 200
POST
/v2/bot/message/validate/multicast
Validate message objects of a multicast message
validateMulticastbody→ 200
POST
/v2/bot/message/validate/narrowcast
Validate message objects of a narrowcast message
validateNarrowcastbody→ 200
POST
/v2/bot/message/validate/broadcast
Validate message objects of a broadcast message
validateBroadcastbody→ 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
getAggregationUnitNameList2 params→ 200
GET
/v2/bot/profile/{userId}
Get profile
getProfile1 param→ 200
GET
/v2/bot/followers/ids
Get a list of users who added your LINE Official Account as a friend
getFollowers2 params→ 200
GET
/v2/bot/info
Get bot info
getBotInfo→ 200
GET
/v2/bot/group/{groupId}/member/{userId}
Get group chat member profile
getGroupMemberProfile2 params→ 200
GET
/v2/bot/room/{roomId}/member/{userId}
Get multi-person chat member profile
getRoomMemberProfile2 params→ 200
GET
/v2/bot/group/{groupId}/members/ids
Get group chat member user IDs
getGroupMembersIds2 params→ 200
GET
/v2/bot/room/{roomId}/members/ids
Get multi-person chat member user IDs
getRoomMembersIds2 params→ 200
POST
/v2/bot/group/{groupId}/leave
Leave group chat
leaveGroup1 param→ 200400404
POST
/v2/bot/room/{roomId}/leave
Leave multi-person chat
leaveRoom1 param→ 200
GET
/v2/bot/group/{groupId}/summary
Get group chat summary
getGroupSummary1 param→ 200
GET
/v2/bot/group/{groupId}/members/count
Get number of users in a group chat
getGroupMemberCount1 param→ 200
GET
/v2/bot/room/{roomId}/members/count
Get number of users in a multi-person chat
getRoomMemberCount1 param→ 200
POST
/v2/bot/richmenu
Create rich menu
createRichMenubody→ 200
POST
/v2/bot/richmenu/validate
Validate rich menu object
validateRichMenuObjectbody→ 200
GET
/v2/bot/richmenu/{richMenuId}
Gets a rich menu via a rich menu ID.
getRichMenu1 param→ 200
DELETE
/v2/bot/richmenu/{richMenuId}
Deletes a rich menu.
deleteRichMenu1 param→ 200
GET
/v2/bot/richmenu/list
Get rich menu list
getRichMenuList→ 200
POST
/v2/bot/user/all/richmenu/{richMenuId}
Set default rich menu
setDefaultRichMenu1 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
createRichMenuAliasbody→ 200400
GET
/v2/bot/richmenu/alias/{richMenuAliasId}
Get rich menu alias information
getRichMenuAlias1 param→ 200
POST
/v2/bot/richmenu/alias/{richMenuAliasId}
Update rich menu alias
updateRichMenuAlias1 parambody→ 200400
DELETE
/v2/bot/richmenu/alias/{richMenuAliasId}
Delete rich menu alias
deleteRichMenuAlias1 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
getRichMenuIdOfUser1 param→ 200
DELETE
/v2/bot/user/{userId}/richmenu
Unlink rich menu from user
unlinkRichMenuIdFromUser1 param→ 200
POST
/v2/bot/user/{userId}/richmenu/{richMenuId}
Link rich menu to user.
linkRichMenuIdToUser2 params→ 200
POST
/v2/bot/richmenu/bulk/link
Link rich menu to multiple users
linkRichMenuIdToUsersbody→ 202
POST
/v2/bot/richmenu/bulk/unlink
Unlink rich menus from multiple users
unlinkRichMenuIdFromUsersbody→ 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…
richMenuBatchbody→ 202
POST
/v2/bot/richmenu/validate/batch
Validate a request body of the Replace or unlink the linked rich menus in batches endpoint.
validateRichMenuBatchRequestbody→ 200
GET
/v2/bot/richmenu/progress/batch
Get the status of Replace or unlink a linked rich menus in batches.
getRichMenuBatchProgress1 param→ 200
POST
/v2/bot/user/{userId}/linkToken
Issue link token
issueLinkToken1 param→ 200
POST
/v2/bot/message/markAsRead
Mark messages from users as read
markMessagesAsReadbody→ 200
POST
/bot/pnp/push
Send LINE notification message
pushMessagesByPhone1 parambody→ 200422
GET
/v2/bot/message/delivery/pnp
Get number of sent LINE notification messages
getPNPMessageStatistics1 param→ 200
GET
/v2/bot/membership/subscription/{userId}
Get a user's membership subscription.
getMembershipSubscription1 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.
getJoinedMembershipUsers3 params→ 200400404
GET
/v2/bot/coupon
Get a paginated list of coupons.
listCoupon3 params→ 200400
POST
/v2/bot/coupon
Create a new coupon. Define coupon details such as type, title, and validity period.
createCouponbody→ 200400
GET
/v2/bot/coupon/{couponId}
Get coupon detail
getCouponDetail1 param→ 200400404
PUT
/v2/bot/coupon/{couponId}/close
Close coupon
closeCoupon1 param→ 200400404410
POST
/v2/bot/chat/loading/start
Display a loading animation in one-on-one chats between users and LINE Official Accounts.
showLoadingAnimationbody→ 202400
POST
/v2/bot/chat/markAsRead
Mark messages from users as read by token
markMessagesAsReadByTokenbody→ 200400
Schemas 84
The contract defines 84 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.
RoomMemberCountResponse
object
1 property1 required
SubscribedMembershipPlan
object
Object containing information about the membership plan.
6 properties6 required
RoomUserProfileResponse
object
3 properties2 required
ValidateMessageRequest
object
1 property1 required
MembersIdsResponse
object
2 properties1 required
CouponCreateRequest
object
Request object for creating a coupon. Contains all configurable coupon properties.
13 properties7 required
Subscription
object
An array of memberships.
2 properties2 required
QuickReplyItem
object
3 properties
ShowLoadingAnimationResponse
object
QuickReply
object
Quick reply
1 property
QuotaConsumptionResponse
object
1 property1 required
MessagingApiPagerCouponListResponse
object
Paginated response object containing a list of coupons.
2 properties1 required
GroupSummaryResponse
object
3 properties2 required
MulticastResponse
object
NarrowcastProgressResponse
object
8 properties2 required
UserProfileResponse
object
5 properties2 required
CreateRichMenuAliasRequest
object
2 properties2 required
ReplyMessageResponse
object
1 property1 required
GetFollowersResponse
object
2 properties1 required
RichMenuBatchRequest
object
2 properties1 required
CouponListResponse
object
Summary information about a coupon, used in coupon lists.
2 properties2 required
BroadcastRequest
object
2 properties1 required
Membership
object
10 properties10 required
RichMenuRequest
object
5 properties
QuotaType
string
One of the following values to indicate whether a target limit is set or not.
DemographicFilter
object
Demographic filter
1 property
Limit
object
Limit of the Narrowcast
3 properties
SentMessage
object
2 properties1 required
NarrowcastRequest
object
5 properties1 required
RichMenuResponse
object
6 properties6 required
ShowLoadingAnimationRequest
object
2 properties1 required
RichMenuBatchOperation
object
Rich menu operation object represents the batch operation to the rich menu linked to the user.
1 property1 required
BroadcastResponse
object
RichMenuSize
object
Rich menu size
2 properties
NumberOfMessagesResponse
object
2 properties1 required
GroupMemberCountResponse
object
1 property1 required
SetWebhookEndpointRequest
object
1 property1 required
TestWebhookEndpointResponse
object
5 properties4 required
PnpMessagesRequest
object
3 properties2 required
RichMenuBulkLinkRequest
object
2 properties2 required
TestWebhookEndpointRequest
object
1 property
UpdateRichMenuAliasRequest
object
1 property1 required
RichMenuArea
object
Rich menu area
2 properties
Recipient
object
Recipient
1 property
SubscribedMembershipUser
object
Object containing user membership subscription information.
4 properties4 required
CouponRewardResponse
object
1 property1 required
NarrowcastResponse
object
RichMenuListResponse
object
1 property1 required
Action
object
Action
2 properties
PushMessageRequest
object
4 properties2 required
RichMenuAliasResponse
object
2 properties2 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…
GetMembershipSubscriptionResponse
object
A user's membership subscription status
1 property1 required
CouponResponse
object
Detailed information about a coupon, including all properties and current status.
18 properties
ErrorDetail
object
2 properties
BotInfoResponse
object
7 properties5 required
RichMenuIdResponse
object
1 property1 required
AcquisitionConditionResponse
object
1 property1 required
MembershipListResponse
object
List of memberships
1 property1 required
GroupUserProfileResponse
object
3 properties2 required
PushMessageResponse
object
1 property1 required
ChatReference
object
Chat reference
1 property1 required
GetJoinedMembershipUsersResponse
object
List of users who have joined the membership
2 properties1 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…
AcquisitionConditionRequest
object
1 property1 required
IssueLinkTokenResponse
object
1 property1 required
MessageQuotaResponse
object
2 properties1 required
GetWebhookEndpointResponse
object
2 properties2 required
MarkMessagesAsReadByTokenRequest
object
1 property1 required
RichMenuAliasListResponse
object
1 property1 required
RichMenuBulkUnlinkRequest
object
1 property1 required
GetAggregationUnitUsageResponse
object
1 property1 required
RichMenuBounds
object
Rich menu bounds
4 properties
ErrorResponse
object
3 properties1 required
CouponCreateResponse
object
Response object returned after creating a coupon. Contains the coupon ID.
1 property1 required
MarkMessagesAsReadRequest
object
1 property1 required
RichMenuBatchProgressResponse
object
3 properties2 required
ReplyMessageRequest
object
3 properties2 required
Sender
object
Change icon and display name
2 properties
Filter
object
Filter for narrowcast
1 property
Message
object
3 properties1 required
MulticastRequest
object
4 properties2 required
GetAggregationUnitNameListResponse
object
2 properties1 required
CouponRewardRequest
object
1 property1 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.
Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.
MCP tools for apis
4 tools reach this content
search_api_evangelistSearch every content type across the network at once.
find_relatedThe shared-tag relevance graph — what else covers this.
get_tagEverything one tag labels, across all content types.
guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
A second provider on the same verified email joins the account you already have.
Your account
ⓘ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.