Table of Contents

Namespace Line.OpenApi.Messaging.Generated.Api.Models

Classes

AcquisitionConditionRequest
AcquisitionConditionResponse
ActionObject

Action

AgeDemographicFilter
AltUri
AppTypeDemographicFilter
AreaDemographicFilter
AudienceRecipient
AudioMessage
BotInfoResponse
BroadcastRequest
BroadcastResponse
ButtonsTemplate
CameraAction
CameraRollAction
CarouselColumn

Column object for carousel template.

CarouselTemplate
CashBackFixedPriceInfoRequest
CashBackFixedPriceInfoResponse
CashBackPercentagePriceInfoRequest
CashBackPercentagePriceInfoResponse
CashBackPriceInfoRequest
CashBackPriceInfoResponse
ChatReference

Chat reference

ClipboardAction
ClipboardImagemapAction
ConfirmTemplate
CouponCashBackRewardRequest
CouponCashBackRewardResponse
CouponCreateRequest

Request object for creating a coupon. Contains all configurable coupon properties.

CouponCreateResponse

Response object returned after creating a coupon. Contains the coupon ID.

CouponDiscountRewardRequest
CouponDiscountRewardResponse
CouponFreeRewardRequest
CouponFreeRewardResponse
CouponGiftRewardRequest
CouponGiftRewardResponse
CouponListResponse

Summary information about a coupon, used in coupon lists.

CouponMessage
CouponOthersRewardRequest
CouponOthersRewardResponse
CouponResponse

Detailed information about a coupon, including all properties and current status.

CouponRewardRequest
CouponRewardResponse
CreateRichMenuAliasRequest
DatetimePickerAction
DemographicFilter

Demographic filter

DiscountExplicitPriceInfoRequest
DiscountExplicitPriceInfoResponse
DiscountFixedPriceInfoRequest
DiscountFixedPriceInfoResponse
DiscountPercentagePriceInfoRequest
DiscountPercentagePriceInfoResponse
DiscountPriceInfoRequest
DiscountPriceInfoResponse
Emoji
ErrorDetail
ErrorResponse
Filter

Filter for narrowcast

FlexBlockStyle
FlexBox
FlexBoxBackground
FlexBoxLinearGradient
FlexBubble
FlexBubbleStyles
FlexButton
FlexCarousel
FlexComponent
FlexContainer
FlexFiller
FlexIcon
FlexImage
FlexMessage
FlexSeparator
FlexSpan
FlexText
FlexVideo
GenderDemographicFilter
GetAggregationUnitNameListResponse
GetAggregationUnitUsageResponse
GetFollowersResponse
GetJoinedMembershipUsersResponse

List of users who have joined the membership

GetMembershipSubscriptionResponse

A user's membership subscription status

GetWebhookEndpointResponse
GroupMemberCountResponse
GroupSummaryResponse
GroupUserProfileResponse
ImageCarouselColumn
ImageCarouselTemplate
ImageMessage
ImagemapAction
ImagemapArea
ImagemapBaseSize
ImagemapExternalLink
ImagemapMessage
ImagemapVideo
IssueLinkTokenResponse
Limit

Limit of the Narrowcast

LocationAction
LocationMessage
LotteryAcquisitionConditionRequest
LotteryAcquisitionConditionResponse
MarkMessagesAsReadByTokenRequest
MarkMessagesAsReadRequest
MembersIdsResponse
Membership
MembershipListResponse

List of memberships

Message
MessageAction
MessageImagemapAction
MessageQuotaResponse
MessagingApiPagerCouponListResponse

Paginated response object containing a list of coupons.

MulticastRequest
MulticastResponse
NarrowcastProgressResponse
NarrowcastRequest
NarrowcastResponse
NormalAcquisitionConditionRequest
NormalAcquisitionConditionResponse
NumberOfMessagesResponse
OperatorDemographicFilter
OperatorRecipient
PnpMessagesRequest
PostbackAction
PushMessageRequest
PushMessageResponse
QuickReply

Quick reply

QuickReplyItem
QuotaConsumptionResponse
Recipient

Recipient

RedeliveryRecipient
ReferralAcquisitionConditionResponse
ReplyMessageRequest
ReplyMessageResponse
RichMenuAliasListResponse
RichMenuAliasResponse
RichMenuArea

Rich menu area

RichMenuBatchLinkOperation

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.

RichMenuBatchOperation

Rich menu operation object represents the batch operation to the rich menu linked to the user.

RichMenuBatchProgressResponse
RichMenuBatchRequest
RichMenuBatchUnlinkAllOperation

Unlink the rich menu from all users linked to the rich menu.

RichMenuBatchUnlinkOperation

Unlink the rich menu for all users linked to the rich menu specified in the from property.

RichMenuBounds

Rich menu bounds

RichMenuBulkLinkRequest
RichMenuBulkUnlinkRequest
RichMenuIdResponse
RichMenuListResponse
RichMenuRequest
RichMenuResponse
RichMenuSize

Rich menu size

RichMenuSwitchAction
RoomMemberCountResponse
RoomUserProfileResponse
Sender

Change icon and display name

SentMessage
SetWebhookEndpointRequest
ShowLoadingAnimationRequest
ShowLoadingAnimationResponse
StickerMessage
SubscribedMembershipPlan

Object containing information about the membership plan.

SubscribedMembershipUser

Object containing user membership subscription information.

Subscription

An array of memberships.

SubscriptionPeriodDemographicFilter
Template
TemplateMessage
TestWebhookEndpointRequest
TestWebhookEndpointResponse
TextMessage
TextMessageV2
TextMessageV2_substitution

A mapping that specifies substitutions for parts enclosed in {} within the text field.

URIAction
URIImagemapAction
UpdateRichMenuAliasRequest
UserProfileResponse
ValidateMessageRequest
VideoMessage

Enums

AgeDemographic
AppTypeDemographic
AreaDemographic
BotInfoResponse_chatMode

Chat settings set in the LINE Official Account Manager. One of:chat: Chat is set to "On".bot: Chat is set to "Off".

BotInfoResponse_markAsReadMode

Automatic read setting for messages. If the chat is set to "Off", auto is returned. If the chat is set to "On", manual is returned.auto: Auto read setting is enabled.manual: Auto read setting is disabled.

CashBackFixedPriceInfoResponse_currency

Currency code (e.g., JPY, THB, TWD).

CouponCreateRequest_timezone

Timezone for interpreting start and end timestamps.

CouponCreateRequest_visibility

Visibility of the coupon. Determines who can see or acquire the coupon.

CouponResponse_status

Current status of the coupon.

CouponResponse_timezone

Timezone for interpreting start and end timestamps.

CouponResponse_visibility

Visibility of the coupon. Determines who can see or acquire the coupon.

DatetimePickerAction_mode
DiscountExplicitPriceInfoResponse_currency

Currency code (e.g., JPY, THB, TWD).

DiscountFixedPriceInfoResponse_currency

Currency code (e.g., JPY, THB, TWD).

FlexBox_alignItems
FlexBox_justifyContent
FlexBox_layout
FlexBox_position
FlexBubble_direction
FlexBubble_size
FlexButton_adjustMode
FlexButton_gravity
FlexButton_height
FlexButton_position
FlexButton_style
FlexIcon_position
FlexImage_align

Alignment style in horizontal direction.

FlexImage_aspectMode

The display style of the image if the aspect ratio of the image and that specified by the aspectRatio property do not match.

FlexImage_gravity

Alignment style in vertical direction.

FlexImage_position

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.

FlexSpan_decoration
FlexSpan_style
FlexSpan_weight
FlexText_adjustMode
FlexText_align
FlexText_decoration
FlexText_gravity
FlexText_position
FlexText_style
FlexText_weight
GenderDemographic
Membership_currency

The currency of membership.price.

NarrowcastProgressResponse_phase

The current status. One of:waiting: Messages are not yet ready to be sent. They are currently being filtered or processed in some way.sending: Messages are currently being sent.succeeded: Messages were sent successfully. This may not mean the messages were successfully received.failed: Messages failed to be sent. Use the failedDescription property to find the cause of the failure.

NumberOfMessagesResponse_status

Aggregation process status. One of:ready: The number of messages can be obtained.unready: We haven't finished calculating the number of sent messages for the specified in date. For example, this property is returned when the delivery date or a future date is specified. Calculation usually takes about a day.unavailable_for_privacy: The total number of messages on the specified day is less than 20.out_of_service: The specified date is earlier than the date on which we first started calculating sent messages (March 31, 2018).

PostbackAction_inputOption
QuotaType

One of the following values to indicate whether a target limit is set or not.

RichMenuBatchProgressPhase

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 failed. This means that the rich menu for one or more users couldn't be controlled. There may also be users whose operations have been successfully completed.

SubscribedMembershipPlan_currency

The currency of membership.price.

SubscriptionPeriodDemographic