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.
The identity and technical contract details declared by the specification.
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
NarrowcastRequest
object
5 properties
1 required
NarrowcastResponse
object
Recipient
object
Recipient
1 property
RedeliveryRecipient
object
Filter
object
Filter for narrowcast
1 property
DemographicFilter
object
Demographic filter
1 property
AgeDemographicFilter
object
AppTypeDemographicFilter
object
AppTypeDemographic
string
AreaDemographicFilter
object
GenderDemographicFilter
object
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
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
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
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
FlexBoxBackground
object
1 property
1 required
FlexBoxLinearGradient
object
Action
object
Action
2 properties
DatetimePickerAction
object
RichMenuSwitchAction
object
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
The full machine-readable OpenAPI contract behind this narrative.
Other APIs LINE publishes across the network.