Appearance
@line/bot-sdk / Exports / messagingApi
Namespace: messagingApi
Table of contents
Namespaces
- AgeDemographicFilter
- BotInfoResponse
- DatetimePickerAction
- FlexBox
- FlexBubble
- FlexButton
- FlexIcon
- FlexImage
- FlexSpan
- FlexText
- GetMessageContentTranscodingResponse
- Membership
- MessageQuotaResponse
- NarrowcastProgressResponse
- NumberOfMessagesResponse
- PostbackAction
- RichMenuBatchProgressResponse
- SubscribedMembershipPlan
- SubscriptionPeriodDemographicFilter
Classes
Type Aliases
- Action
- ActionBase
- AgeDemographic
- AgeDemographicFilter
- AltUri
- AppTypeDemographic
- AppTypeDemographicFilter
- AreaDemographic
- AreaDemographicFilter
- AudienceMatchMessagesRequest
- AudienceRecipient
- AudioMessage
- BotInfoResponse
- BroadcastRequest
- ButtonsTemplate
- CameraAction
- CameraRollAction
- CarouselColumn
- CarouselTemplate
- ChatReference
- ClipboardAction
- ClipboardImagemapAction
- ConfirmTemplate
- CreateRichMenuAliasRequest
- DatetimePickerAction
- DemographicFilter
- DemographicFilterBase
- Emoji
- ErrorDetail
- ErrorResponse
- Filter
- FlexBlockStyle
- FlexBox
- FlexBoxBackground
- FlexBoxBackgroundBase
- FlexBoxBorderWidth
- FlexBoxCornerRadius
- FlexBoxLinearGradient
- FlexBoxPadding
- FlexBoxSpacing
- FlexBubble
- FlexBubbleStyles
- FlexButton
- FlexCarousel
- FlexComponent
- FlexComponentBase
- FlexContainer
- FlexContainerBase
- FlexFiller
- FlexIcon
- FlexIconSize
- FlexImage
- FlexImageSize
- FlexMargin
- FlexMessage
- FlexOffset
- FlexSeparator
- FlexSpan
- FlexSpanSize
- FlexText
- FlexTextFontSize
- FlexVideo
- GenderDemographic
- GenderDemographicFilter
- GetAggregationUnitNameListResponse
- GetAggregationUnitUsageResponse
- GetFollowersResponse
- GetMembershipSubscriptionResponse
- GetMessageContentTranscodingResponse
- GetWebhookEndpointResponse
- GroupMemberCountResponse
- GroupSummaryResponse
- GroupUserProfileResponse
- ImageCarouselColumn
- ImageCarouselTemplate
- ImageMessage
- ImagemapAction
- ImagemapActionBase
- ImagemapArea
- ImagemapBaseSize
- ImagemapExternalLink
- ImagemapMessage
- ImagemapVideo
- IssueLinkTokenResponse
- Limit
- LocationAction
- LocationMessage
- MarkMessagesAsReadRequest
- MembersIdsResponse
- Membership
- MembershipListResponse
- Message
- MessageAction
- MessageBase
- MessageImagemapAction
- MessageQuotaResponse
- MulticastRequest
- NarrowcastProgressResponse
- NarrowcastRequest
- NumberOfMessagesResponse
- OperatorDemographicFilter
- OperatorRecipient
- PnpMessagesRequest
- PostbackAction
- PushMessageRequest
- PushMessageResponse
- QuickReply
- QuickReplyItem
- QuotaConsumptionResponse
- QuotaType
- Recipient
- RecipientBase
- RedeliveryRecipient
- ReplyMessageRequest
- ReplyMessageResponse
- RichMenuAliasListResponse
- RichMenuAliasResponse
- RichMenuArea
- RichMenuBatchLinkOperation
- RichMenuBatchOperation
- RichMenuBatchOperationBase
- RichMenuBatchProgressPhase
- RichMenuBatchProgressResponse
- RichMenuBatchRequest
- RichMenuBatchUnlinkAllOperation
- RichMenuBatchUnlinkOperation
- RichMenuBounds
- RichMenuBulkLinkRequest
- RichMenuBulkUnlinkRequest
- RichMenuIdResponse
- RichMenuListResponse
- RichMenuRequest
- RichMenuResponse
- RichMenuSize
- RichMenuSwitchAction
- RoomMemberCountResponse
- RoomUserProfileResponse
- Sender
- SentMessage
- SetWebhookEndpointRequest
- ShowLoadingAnimationRequest
- StickerMessage
- SubscribedMembershipPlan
- SubscribedMembershipUser
- Subscription
- SubscriptionPeriodDemographic
- SubscriptionPeriodDemographicFilter
- Template
- TemplateBase
- TemplateImageAspectRatio
- TemplateImageSize
- TemplateMessage
- TestWebhookEndpointRequest
- TestWebhookEndpointResponse
- TextMessage
- URIAction
- URIImagemapAction
- UpdateRichMenuAliasRequest
- UserProfileResponse
- ValidateMessageRequest
- VideoMessage
Type Aliases
Action
Ƭ Action: CameraAction | CameraRollAction | ClipboardAction | DatetimePickerAction | LocationAction | MessageAction | PostbackAction | RichMenuSwitchAction | URIAction
Defined in
lib/messaging-api/model/action.ts:23
ActionBase
Ƭ ActionBase: Object
Action
Type declaration
| Name | Type | Description |
|---|---|---|
label? | string | Label for the action. See label Documentation |
type? | string | Type of action See type Documentation |
Defined in
lib/messaging-api/model/action.ts:37
AgeDemographic
Ƭ AgeDemographic: "age_15" | "age_20" | "age_25" | "age_30" | "age_35" | "age_40" | "age_45" | "age_50"
LINE Messaging API This document describes LINE Messaging API.
The version of the OpenAPI document: 0.0.1
NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.
Defined in
lib/messaging-api/model/ageDemographic.ts:13
AgeDemographicFilter
Ƭ AgeDemographicFilter: DemographicFilterBase & { gte?: AgeDemographic ; lt?: AgeDemographic ; type: "age" }
Defined in
lib/messaging-api/model/ageDemographicFilter.ts:18
lib/messaging-api/model/ageDemographicFilter.ts:28
AltUri
Ƭ AltUri: Object
LINE Messaging API This document describes LINE Messaging API.
The version of the OpenAPI document: 0.0.1
NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.
Type declaration
| Name | Type |
|---|---|
desktop? | string |
Defined in
lib/messaging-api/model/altUri.ts:13
AppTypeDemographic
Ƭ AppTypeDemographic: "ios" | "android"
LINE Messaging API This document describes LINE Messaging API.
The version of the OpenAPI document: 0.0.1
NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.
Defined in
lib/messaging-api/model/appTypeDemographic.ts:13
AppTypeDemographicFilter
Ƭ AppTypeDemographicFilter: DemographicFilterBase & { oneOf?: AppTypeDemographic[] ; type: "appType" }
Defined in
lib/messaging-api/model/appTypeDemographicFilter.ts:18
AreaDemographic
Ƭ AreaDemographic: "jp_01" | "jp_02" | "jp_03" | "jp_04" | "jp_05" | "jp_06" | "jp_07" | "jp_08" | "jp_09" | "jp_10" | "jp_11" | "jp_12" | "jp_13" | "jp_14" | "jp_15" | "jp_16" | "jp_17" | "jp_18" | "jp_19" | "jp_20" | "jp_21" | "jp_22" | "jp_23" | "jp_24" | "jp_25" | "jp_26" | "jp_27" | "jp_28" | "jp_29" | "jp_30" | "jp_31" | "jp_32" | "jp_33" | "jp_34" | "jp_35" | "jp_36" | "jp_37" | "jp_38" | "jp_39" | "jp_40" | "jp_41" | "jp_42" | "jp_43" | "jp_44" | "jp_45" | "jp_46" | "jp_47" | "tw_01" | "tw_02" | "tw_03" | "tw_04" | "tw_05" | "tw_06" | "tw_07" | "tw_08" | "tw_09" | "tw_10" | "tw_11" | "tw_12" | "tw_13" | "tw_14" | "tw_15" | "tw_16" | "tw_17" | "tw_18" | "tw_19" | "tw_20" | "tw_21" | "tw_22" | "th_01" | "th_02" | "th_03" | "th_04" | "th_05" | "th_06" | "th_07" | "th_08" | "id_01" | "id_02" | "id_03" | "id_04" | "id_05" | "id_06" | "id_07" | "id_08" | "id_09" | "id_10" | "id_11" | "id_12"
LINE Messaging API This document describes LINE Messaging API.
The version of the OpenAPI document: 0.0.1
NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.
Defined in
lib/messaging-api/model/areaDemographic.ts:13
AreaDemographicFilter
Ƭ AreaDemographicFilter: DemographicFilterBase & { oneOf?: AreaDemographic[] ; type: "area" }
Defined in
lib/messaging-api/model/areaDemographicFilter.ts:18
AudienceMatchMessagesRequest
Ƭ AudienceMatchMessagesRequest: Object
Type declaration
| Name | Type | Description |
|---|---|---|
messages | Message[] | Destination of the message (A value obtained by hashing the telephone number, which is another value normalized to E.164 format, with SHA256). See messages Documentation |
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 have disabled push notifications in LINE and/or their device). The default value is false. See notificationDisabled Documentation |
to | string[] | Message to send. See to Documentation |
Defined in
lib/messaging-api/model/audienceMatchMessagesRequest.ts:15
AudienceRecipient
Ƭ AudienceRecipient: RecipientBase & { audienceGroupId?: number ; type: "audience" }
Defined in
lib/messaging-api/model/audienceRecipient.ts:17
AudioMessage
Ƭ AudioMessage: MessageBase & { duration: number ; originalContentUrl: string ; type: "audio" }
Defined in
lib/messaging-api/model/audioMessage.ts:19
BotInfoResponse
Ƭ BotInfoResponse: Object
LINE Messaging API This document describes LINE Messaging API.
The version of the OpenAPI document: 0.0.1
NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.
Type declaration
| Name | Type | Description |
|---|---|---|
basicId | string | Bot's basic ID See basicId Documentation |
chatMode | ChatModeEnum | Chat settings set in the LINE Official Account Manager. One of: chat: Chat is set to "On". bot: Chat is set to "Off". See chatMode Documentation |
displayName | string | Bot's display name See displayName Documentation |
markAsReadMode | MarkAsReadModeEnum | 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. See markAsReadMode Documentation |
pictureUrl? | string | Profile image URL. https image URL. Not included in the response if the bot doesn't have a profile image. See pictureUrl Documentation |
premiumId? | string | Bot's premium ID. Not included in the response if the premium ID isn't set. See premiumId Documentation |
userId | string | Bot's user ID See userId Documentation |
Defined in
lib/messaging-api/model/botInfoResponse.ts:13
lib/messaging-api/model/botInfoResponse.ts:58
BroadcastRequest
Ƭ BroadcastRequest: Object
Type declaration
| Name | Type | Description |
|---|---|---|
messages | Message[] | List of Message objects. See messages Documentation |
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 have disabled push notifications in LINE and/or their device). The default value is false. See notificationDisabled Documentation |
Defined in
lib/messaging-api/model/broadcastRequest.ts:15
ButtonsTemplate
Ƭ ButtonsTemplate: TemplateBase & { actions: Action[] ; defaultAction?: Action ; imageAspectRatio?: string ; imageBackgroundColor?: string ; imageSize?: string ; text: string ; thumbnailImageUrl?: string ; title?: string ; type: "buttons" }
Defined in
lib/messaging-api/model/buttonsTemplate.ts:18
CameraAction
Ƭ CameraAction: ActionBase & { type: "camera" }
Defined in
lib/messaging-api/model/cameraAction.ts:17
CameraRollAction
Ƭ CameraRollAction: ActionBase & { type: "cameraRoll" }
Defined in
lib/messaging-api/model/cameraRollAction.ts:17
CarouselColumn
Ƭ CarouselColumn: Object
Column object for carousel template.
Type declaration
| Name | Type |
|---|---|
actions | Action[] |
defaultAction? | Action |
imageBackgroundColor? | string |
text | string |
thumbnailImageUrl? | string |
title? | string |
Defined in
lib/messaging-api/model/carouselColumn.ts:18
CarouselTemplate
Ƭ CarouselTemplate: TemplateBase & { columns: CarouselColumn[] ; imageAspectRatio?: string ; imageSize?: string ; type: "carousel" }
Defined in
lib/messaging-api/model/carouselTemplate.ts:18
ChatReference
Ƭ ChatReference: Object
Chat reference
Type declaration
| Name | Type | Description |
|---|---|---|
userId | string | The target user ID See userId Documentation |
Defined in
lib/messaging-api/model/chatReference.ts:16
ClipboardAction
Ƭ ClipboardAction: ActionBase & { clipboardText: string ; type: "clipboard" }
Defined in
lib/messaging-api/model/clipboardAction.ts:17
ClipboardImagemapAction
Ƭ ClipboardImagemapAction: ImagemapActionBase & { clipboardText: string ; label?: string ; type: "clipboard" }
Defined in
lib/messaging-api/model/clipboardImagemapAction.ts:18
ConfirmTemplate
Ƭ ConfirmTemplate: TemplateBase & { actions: Action[] ; text: string ; type: "confirm" }
Defined in
lib/messaging-api/model/confirmTemplate.ts:18
CreateRichMenuAliasRequest
Ƭ CreateRichMenuAliasRequest: Object
LINE Messaging API This document describes LINE Messaging API.
The version of the OpenAPI document: 0.0.1
NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.
Type declaration
| Name | Type | Description |
|---|---|---|
richMenuAliasId | string | Rich menu alias ID, which can be any ID, unique for each channel. See richMenuAliasId Documentation |
richMenuId | string | The rich menu ID to be associated with the rich menu alias. See richMenuId Documentation |
Defined in
lib/messaging-api/model/createRichMenuAliasRequest.ts:13
DatetimePickerAction
Ƭ DatetimePickerAction: ActionBase & { data?: string ; initial?: string ; max?: string ; min?: string ; mode?: ModeEnum ; type: "datetimepicker" }
Defined in
lib/messaging-api/model/datetimePickerAction.ts:17
lib/messaging-api/model/datetimePickerAction.ts:46
DemographicFilter
Ƭ DemographicFilter: AgeDemographicFilter | AppTypeDemographicFilter | AreaDemographicFilter | GenderDemographicFilter | OperatorDemographicFilter | SubscriptionPeriodDemographicFilter
Defined in
lib/messaging-api/model/demographicFilter.ts:20
DemographicFilterBase
Ƭ DemographicFilterBase: Object
Demographic filter
Type declaration
| Name | Type | Description |
|---|---|---|
type? | string | Type of demographic filter |
Defined in
lib/messaging-api/model/demographicFilter.ts:31
Emoji
Ƭ Emoji: Object
LINE Messaging API This document describes LINE Messaging API.
The version of the OpenAPI document: 0.0.1
NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.
Type declaration
| Name | Type |
|---|---|
emojiId? | string |
index? | number |
productId? | string |
Defined in
lib/messaging-api/model/emoji.ts:13
ErrorDetail
Ƭ ErrorDetail: Object
LINE Messaging API This document describes LINE Messaging API.
The version of the OpenAPI document: 0.0.1
NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.
Type declaration
| Name | Type | Description |
|---|---|---|
message? | string | Details of the error. Not included in the response under certain situations. |
property? | string | Location of where the error occurred. Returns the JSON field name or query parameter name of the request. Not included in the response under certain situations. |
Defined in
lib/messaging-api/model/errorDetail.ts:13
ErrorResponse
Ƭ ErrorResponse: Object
Type declaration
| Name | Type | Description |
|---|---|---|
details? | ErrorDetail[] | An array of error details. If the array is empty, this property will not be included in the response. See details Documentation |
message | string | Message containing information about the error. See message Documentation |
sentMessages? | SentMessage[] | Array of sent messages. See sentMessages Documentation |
Defined in
lib/messaging-api/model/errorResponse.ts:16
Filter
Ƭ Filter: Object
Filter for narrowcast
Type declaration
| Name | Type |
|---|---|
demographic? | DemographicFilter |
Defined in
lib/messaging-api/model/filter.ts:18
FlexBlockStyle
Ƭ FlexBlockStyle: Object
LINE Messaging API This document describes LINE Messaging API.
The version of the OpenAPI document: 0.0.1
NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.
Type declaration
| Name | Type |
|---|---|
backgroundColor? | string |
separator? | boolean |
separatorColor? | string |
Defined in
lib/messaging-api/model/flexBlockStyle.ts:13
FlexBox
Ƭ FlexBox: FlexComponentBase & { action?: Action ; alignItems?: AlignItemsEnum ; background?: FlexBoxBackground ; backgroundColor?: string ; borderColor?: string ; borderWidth?: string ; contents: FlexComponent[] ; cornerRadius?: string ; flex?: number ; height?: string ; justifyContent?: JustifyContentEnum ; layout: LayoutEnum ; margin?: string ; maxHeight?: string ; maxWidth?: string ; offsetBottom?: string ; offsetEnd?: string ; offsetStart?: string ; offsetTop?: string ; paddingAll?: string ; paddingBottom?: string ; paddingEnd?: string ; paddingStart?: string ; paddingTop?: string ; position?: PositionEnum ; spacing?: string ; type: "box" ; width?: string }
Defined in
lib/messaging-api/model/flexBox.ts:19
lib/messaging-api/model/flexBox.ts:104
FlexBoxBackground
Ƭ FlexBoxBackground: FlexBoxLinearGradient
Defined in
lib/messaging-api/model/flexBoxBackground.ts:15
FlexBoxBackgroundBase
Ƭ FlexBoxBackgroundBase: Object
Type declaration
| Name | Type |
|---|---|
type | string |
Defined in
lib/messaging-api/model/flexBoxBackground.ts:17
FlexBoxBorderWidth
Ƭ FlexBoxBorderWidth: "none" | "light" | "normal" | "medium" | "semi-bold" | "bold"
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 increasing width.
Defined in
lib/messaging-api/model/flexBoxBorderWidth.ts:17
FlexBoxCornerRadius
Ƭ FlexBoxCornerRadius: "none" | "xs" | "sm" | "md" | "lg" | "xl" | "xxl"
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 values are listed in order of increasing radius.
Defined in
lib/messaging-api/model/flexBoxCornerRadius.ts:17
FlexBoxLinearGradient
Ƭ FlexBoxLinearGradient: FlexBoxBackgroundBase & { angle?: string ; centerColor?: string ; centerPosition?: string ; endColor?: string ; startColor?: string ; type: "linearGradient" }
Defined in
lib/messaging-api/model/flexBoxLinearGradient.ts:17
FlexBoxPadding
Ƭ FlexBoxPadding: "none" | "xs" | "sm" | "md" | "lg" | "xl" | "xxl"
Padding can be specified in pixels, percentage (to the parent box width) or with a keyword. FlexBoxPadding just provides only keywords.
Defined in
lib/messaging-api/model/flexBoxPadding.ts:17
FlexBoxSpacing
Ƭ FlexBoxSpacing: "none" | "xs" | "sm" | "md" | "lg" | "xl" | "xxl"
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 just provides only keywords.
Defined in
lib/messaging-api/model/flexBoxSpacing.ts:17
FlexBubble
Ƭ FlexBubble: FlexContainerBase & { action?: Action ; body?: FlexBox ; direction?: DirectionEnum ; footer?: FlexBox ; header?: FlexBox ; hero?: FlexComponent ; size?: SizeEnum ; styles?: FlexBubbleStyles ; type: "bubble" }
Defined in
lib/messaging-api/model/flexBubble.ts:21
lib/messaging-api/model/flexBubble.ts:49
FlexBubbleStyles
Ƭ FlexBubbleStyles: Object
Type declaration
| Name | Type |
|---|---|
body? | FlexBlockStyle |
footer? | FlexBlockStyle |
header? | FlexBlockStyle |
hero? | FlexBlockStyle |
Defined in
lib/messaging-api/model/flexBubbleStyles.ts:15
FlexButton
Ƭ FlexButton: FlexComponentBase & { action: Action ; adjustMode?: AdjustModeEnum ; color?: string ; flex?: number ; gravity?: GravityEnum ; height?: HeightEnum ; margin?: string ; offsetBottom?: string ; offsetEnd?: string ; offsetStart?: string ; offsetTop?: string ; position?: PositionEnum ; scaling?: boolean ; style?: StyleEnum ; type: "button" }
Defined in
lib/messaging-api/model/flexButton.ts:18
lib/messaging-api/model/flexButton.ts:64
FlexCarousel
Ƭ FlexCarousel: FlexContainerBase & { contents: FlexBubble[] ; type: "carousel" }
Defined in
lib/messaging-api/model/flexCarousel.ts:18
FlexComponent
Ƭ FlexComponent: FlexBox | FlexButton | FlexFiller | FlexIcon | FlexImage | FlexSeparator | FlexSpan | FlexText | FlexVideo
Defined in
lib/messaging-api/model/flexComponent.ts:23
FlexComponentBase
Ƭ FlexComponentBase: Object
Type declaration
| Name | Type |
|---|---|
type | string |
Defined in
lib/messaging-api/model/flexComponent.ts:34
FlexContainer
Ƭ FlexContainer: FlexBubble | FlexCarousel
Defined in
lib/messaging-api/model/flexContainer.ts:16
FlexContainerBase
Ƭ FlexContainerBase: Object
Type declaration
| Name | Type |
|---|---|
type | string |
Defined in
lib/messaging-api/model/flexContainer.ts:20
FlexFiller
Ƭ FlexFiller: FlexComponentBase & { flex?: number ; type: "filler" }
Defined in
lib/messaging-api/model/flexFiller.ts:17
FlexIcon
Ƭ FlexIcon: FlexComponentBase & { aspectRatio?: string ; margin?: string ; offsetBottom?: string ; offsetEnd?: string ; offsetStart?: string ; offsetTop?: string ; position?: PositionEnum ; scaling?: boolean ; size?: string ; type: "icon" ; url: string }
Defined in
lib/messaging-api/model/flexIcon.ts:17
lib/messaging-api/model/flexIcon.ts:71
FlexIconSize
Ƭ FlexIconSize: "xxs" | "xs" | "sm" | "md" | "lg" | "xl" | "xxl" | "3xl" | "4xl" | "5xl"
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.
Defined in
lib/messaging-api/model/flexIconSize.ts:17
FlexImage
Ƭ FlexImage: FlexComponentBase & { action?: Action ; align?: AlignEnum ; animated?: boolean ; aspectMode?: AspectModeEnum ; aspectRatio?: string ; backgroundColor?: string ; flex?: number ; gravity?: GravityEnum ; margin?: string ; offsetBottom?: string ; offsetEnd?: string ; offsetStart?: string ; offsetTop?: string ; position?: PositionEnum ; size?: string ; type: "image" ; url: string }
Defined in
lib/messaging-api/model/flexImage.ts:18
lib/messaging-api/model/flexImage.ts:117
FlexImageSize
Ƭ FlexImageSize: "xxs" | "xs" | "sm" | "md" | "lg" | "xl" | "xxl" | "3xl" | "4xl" | "5xl" | "full"
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 keywords.
Defined in
lib/messaging-api/model/flexImageSize.ts:17
FlexMargin
Ƭ FlexMargin: "none" | "xs" | "sm" | "md" | "lg" | "xl" | "xxl"
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 provides only keywords.
Defined in
lib/messaging-api/model/flexMargin.ts:17
FlexMessage
Ƭ FlexMessage: MessageBase & { altText: string ; contents: FlexContainer ; type: "flex" }
Defined in
lib/messaging-api/model/flexMessage.ts:20
FlexOffset
Ƭ FlexOffset: "none" | "xs" | "sm" | "md" | "lg" | "xl" | "xxl"
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 offsetStart and offsetEnd and to the box height for offsetTop and offsetBottom. FlexOffset just provides only keywords.
Defined in
lib/messaging-api/model/flexOffset.ts:17
FlexSeparator
Ƭ FlexSeparator: FlexComponentBase & { color?: string ; margin?: string ; type: "separator" }
Defined in
lib/messaging-api/model/flexSeparator.ts:17
FlexSpan
Ƭ FlexSpan: FlexComponentBase & { color?: string ; decoration?: DecorationEnum ; size?: string ; style?: StyleEnum ; text?: string ; type: "span" ; weight?: WeightEnum }
Defined in
lib/messaging-api/model/flexSpan.ts:17
lib/messaging-api/model/flexSpan.ts:39
FlexSpanSize
Ƭ FlexSpanSize: "xxs" | "xs" | "sm" | "md" | "lg" | "xl" | "xxl" | "3xl" | "4xl" | "5xl"
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.
Defined in
lib/messaging-api/model/flexSpanSize.ts:17
FlexText
Ƭ FlexText: FlexComponentBase & { action?: Action ; adjustMode?: AdjustModeEnum ; align?: AlignEnum ; color?: string ; contents?: FlexSpan[] ; decoration?: DecorationEnum ; flex?: number ; gravity?: GravityEnum ; lineSpacing?: string ; margin?: string ; maxLines?: number ; offsetBottom?: string ; offsetEnd?: string ; offsetStart?: string ; offsetTop?: string ; position?: PositionEnum ; scaling?: boolean ; size?: string ; style?: StyleEnum ; text?: string ; type: "text" ; weight?: WeightEnum ; wrap?: boolean }
Defined in
lib/messaging-api/model/flexText.ts:19
lib/messaging-api/model/flexText.ts:89
FlexTextFontSize
Ƭ FlexTextFontSize: "xxs" | "xs" | "sm" | "md" | "lg" | "xl" | "xxl" | "3xl" | "4xl" | "5xl"
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.
Defined in
lib/messaging-api/model/flexTextFontSize.ts:17
FlexVideo
Ƭ FlexVideo: FlexComponentBase & { action?: Action ; altContent: FlexComponent ; aspectRatio?: string ; previewUrl: string ; type: "video" ; url: string }
Defined in
lib/messaging-api/model/flexVideo.ts:18
GenderDemographic
Ƭ GenderDemographic: "male" | "female"
LINE Messaging API This document describes LINE Messaging API.
The version of the OpenAPI document: 0.0.1
NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.
Defined in
lib/messaging-api/model/genderDemographic.ts:13
GenderDemographicFilter
Ƭ GenderDemographicFilter: DemographicFilterBase & { oneOf?: GenderDemographic[] ; type: "gender" }
Defined in
lib/messaging-api/model/genderDemographicFilter.ts:18
GetAggregationUnitNameListResponse
Ƭ GetAggregationUnitNameListResponse: Object
LINE Messaging API This document describes LINE Messaging API.
The version of the OpenAPI document: 0.0.1
NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.
Type declaration
| Name | Type | Description |
|---|---|---|
customAggregationUnits | string[] | An array of strings indicating the names of aggregation units used this month. See customAggregationUnits Documentation |
next? | string | A continuation token to get the next array of unit names. Returned only when there are remaining aggregation units that weren't returned in customAggregationUnits in the original request. See next Documentation |
Defined in
lib/messaging-api/model/getAggregationUnitNameListResponse.ts:13
GetAggregationUnitUsageResponse
Ƭ GetAggregationUnitUsageResponse: Object
LINE Messaging API This document describes LINE Messaging API.
The version of the OpenAPI document: 0.0.1
NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.
Type declaration
| Name | Type | Description |
|---|---|---|
numOfCustomAggregationUnits | number | Number of aggregation units used this month. See numOfCustomAggregationUnits Documentation |
Defined in
lib/messaging-api/model/getAggregationUnitUsageResponse.ts:13
GetFollowersResponse
Ƭ GetFollowersResponse: Object
LINE Messaging API This document describes LINE Messaging API.
The version of the OpenAPI document: 0.0.1
NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.
Type declaration
| Name | Type | Description |
|---|---|---|
next? | string | A continuation token to get the next array of user IDs. Returned only when there are remaining user IDs that weren't returned in userIds in the original request. The number of user IDs in the userIds element doesn't have to reach the maximum number specified by limit for the next property to be included in the response. See next Documentation |
userIds | string[] | An array of strings indicating user IDs of users that have added the LINE Official Account as a friend. Only users of LINE for iOS and LINE for Android are included in userIds. See userIds Documentation |
Defined in
lib/messaging-api/model/getFollowersResponse.ts:13
GetMembershipSubscriptionResponse
Ƭ GetMembershipSubscriptionResponse: Object
A user's membership subscription status
Type declaration
| Name | Type | Description |
|---|---|---|
subscriptions | Subscription[] | List of subscription information See subscriptions Documentation |
Defined in
lib/messaging-api/model/getMembershipSubscriptionResponse.ts:18
GetMessageContentTranscodingResponse
Ƭ GetMessageContentTranscodingResponse: Object
Transcoding response
Type declaration
| Name | Type | Description |
|---|---|---|
status | StatusEnum | The preparation status. One of: processing: Preparing to get content. succeeded: Ready to get the content. You can get the content sent by users. failed: Failed to prepare to get the content. See status Documentation |
Defined in
lib/messaging-api/model/getMessageContentTranscodingResponse.ts:16
lib/messaging-api/model/getMessageContentTranscodingResponse.ts:25
GetWebhookEndpointResponse
Ƭ GetWebhookEndpointResponse: Object
LINE Messaging API This document describes LINE Messaging API.
The version of the OpenAPI document: 0.0.1
NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.
Type declaration
| Name | Type | Description |
|---|---|---|
active | boolean | Webhook usage status. Send a webhook event from the LINE Platform to the webhook URL only if enabled. true: Webhook usage is enabled. false: Webhook usage is disabled. See active Documentation |
endpoint | string | Webhook URL See endpoint Documentation |
Defined in
lib/messaging-api/model/getWebhookEndpointResponse.ts:13
GroupMemberCountResponse
Ƭ GroupMemberCountResponse: Object
LINE Messaging API This document describes LINE Messaging API.
The version of the OpenAPI document: 0.0.1
NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.
Type declaration
| Name | Type | Description |
|---|---|---|
count | number | The count of members in the group chat. The number returned excludes the LINE Official Account. See count Documentation |
Defined in
lib/messaging-api/model/groupMemberCountResponse.ts:13
GroupSummaryResponse
Ƭ GroupSummaryResponse: Object
LINE Messaging API This document describes LINE Messaging API.
The version of the OpenAPI document: 0.0.1
NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.
Type declaration
| Name | Type | Description |
|---|---|---|
groupId | string | Group ID See groupId Documentation |
groupName | string | Group name See groupName Documentation |
pictureUrl? | string | Group icon URL. Not included in the response if the user doesn't set a group profile icon. See pictureUrl Documentation |
Defined in
lib/messaging-api/model/groupSummaryResponse.ts:13
GroupUserProfileResponse
Ƭ GroupUserProfileResponse: Object
LINE Messaging API This document describes LINE Messaging API.
The version of the OpenAPI document: 0.0.1
NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.
Type declaration
| Name | Type | Description |
|---|---|---|
displayName | string | User's display name See displayName Documentation |
pictureUrl? | string | Profile image URL. https image URL. Not included in the response if the user doesn't have a profile image. See pictureUrl Documentation |
userId | string | User ID See userId Documentation |
Defined in
lib/messaging-api/model/groupUserProfileResponse.ts:13
ImageCarouselColumn
Ƭ ImageCarouselColumn: Object
Type declaration
| Name | Type |
|---|---|
action | Action |
imageUrl | string |
Defined in
lib/messaging-api/model/imageCarouselColumn.ts:15
ImageCarouselTemplate
Ƭ ImageCarouselTemplate: TemplateBase & { columns: ImageCarouselColumn[] ; type: "image_carousel" }
Defined in
lib/messaging-api/model/imageCarouselTemplate.ts:18
ImageMessage
Ƭ ImageMessage: MessageBase & { originalContentUrl: string ; previewImageUrl: string ; type: "image" }
Defined in
lib/messaging-api/model/imageMessage.ts:19
ImagemapAction
Ƭ ImagemapAction: ClipboardImagemapAction | MessageImagemapAction | URIImagemapAction
Defined in
lib/messaging-api/model/imagemapAction.ts:19
ImagemapActionBase
Ƭ ImagemapActionBase: Object
Type declaration
| Name | Type | Description |
|---|---|---|
area | ImagemapArea | See area Documentation |
type | string | See type Documentation |
Defined in
lib/messaging-api/model/imagemapAction.ts:24
ImagemapArea
Ƭ ImagemapArea: Object
LINE Messaging API This document describes LINE Messaging API.
The version of the OpenAPI document: 0.0.1
NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.
Type declaration
| Name | Type |
|---|---|
height | number |
width | number |
x | number |
y | number |
Defined in
lib/messaging-api/model/imagemapArea.ts:13
ImagemapBaseSize
Ƭ ImagemapBaseSize: Object
LINE Messaging API This document describes LINE Messaging API.
The version of the OpenAPI document: 0.0.1
NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.
Type declaration
| Name | Type |
|---|---|
height | number |
width | number |
Defined in
lib/messaging-api/model/imagemapBaseSize.ts:13
ImagemapExternalLink
Ƭ ImagemapExternalLink: Object
LINE Messaging API This document describes LINE Messaging API.
The version of the OpenAPI document: 0.0.1
NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.
Type declaration
| Name | Type |
|---|---|
label? | string |
linkUri? | string |
Defined in
lib/messaging-api/model/imagemapExternalLink.ts:13
ImagemapMessage
Ƭ ImagemapMessage: MessageBase & { actions: ImagemapAction[] ; altText: string ; baseSize: ImagemapBaseSize ; baseUrl: string ; type: "imagemap" ; video?: ImagemapVideo }
Defined in
lib/messaging-api/model/imagemapMessage.ts:22
ImagemapVideo
Ƭ ImagemapVideo: Object
Type declaration
| Name | Type |
|---|---|
area? | ImagemapArea |
externalLink? | ImagemapExternalLink |
originalContentUrl? | string |
previewImageUrl? | string |
Defined in
lib/messaging-api/model/imagemapVideo.ts:16
IssueLinkTokenResponse
Ƭ IssueLinkTokenResponse: Object
LINE Messaging API This document describes LINE Messaging API.
The version of the OpenAPI document: 0.0.1
NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.
Type declaration
| Name | Type | Description |
|---|---|---|
linkToken | string | Link token. Link tokens are valid for 10 minutes and can only be used once. See linkToken Documentation |
Defined in
lib/messaging-api/model/issueLinkTokenResponse.ts:13
Limit
Ƭ Limit: Object
Limit of the Narrowcast
Type declaration
| Name | Type | Description |
|---|---|---|
max? | number | The maximum number of narrowcast messages to send. Use this parameter to limit the number of narrowcast messages sent. The recipients will be chosen at random. See max Documentation |
upToRemainingQuota? | boolean | If true, the message will be sent within the maximum number of deliverable messages. The default value is false. Targets will be selected at random. See upToRemainingQuota Documentation |
Defined in
lib/messaging-api/model/limit.ts:16
LocationAction
Ƭ LocationAction: ActionBase & { type: "location" }
Defined in
lib/messaging-api/model/locationAction.ts:17
LocationMessage
Ƭ LocationMessage: MessageBase & { address: string ; latitude: number ; longitude: number ; title: string ; type: "location" }
Defined in
lib/messaging-api/model/locationMessage.ts:19
MarkMessagesAsReadRequest
Ƭ MarkMessagesAsReadRequest: Object
Type declaration
| Name | Type | Description |
|---|---|---|
chat | ChatReference | See chat Documentation |
Defined in
lib/messaging-api/model/markMessagesAsReadRequest.ts:15
MembersIdsResponse
Ƭ MembersIdsResponse: Object
LINE Messaging API This document describes LINE Messaging API.
The version of the OpenAPI document: 0.0.1
NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.
Type declaration
| Name | Type | Description |
|---|---|---|
memberIds | string[] | List of user IDs of members in the group chat. Only users of LINE for iOS and LINE for Android are included in memberIds. |
next? | string | A continuation token to get the next array of user IDs of the members in the group chat. Returned only when there are remaining user IDs that were not returned in memberIds in the original request. |
Defined in
lib/messaging-api/model/membersIdsResponse.ts:13
Membership
Ƭ Membership: Object
LINE Messaging API This document describes LINE Messaging API.
The version of the OpenAPI document: 0.0.1
NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.
Type declaration
| Name | Type | Description |
|---|---|---|
benefits | string[] | List of membership plan perks. |
currency | CurrencyEnum | The currency of membership.price. |
description | string | Membership plan description. |
isInAppPurchase | boolean | Payment method for users who subscribe to a membership plan. |
isPublished | boolean | Membership plan status. |
memberCount | number | Number of members subscribed to the membership plan. |
memberLimit | number | null | The upper limit of members who can subscribe. If no upper limit is set, it will be null. |
membershipId | number | Membership plan ID. |
price | number | Monthly fee for membership plan. (e.g. 1500.00) |
title | string | Membership plan name. |
Defined in
lib/messaging-api/model/membership.ts:13
lib/messaging-api/model/membership.ts:56
MembershipListResponse
Ƭ MembershipListResponse: Object
List of memberships
Type declaration
| Name | Type | Description |
|---|---|---|
memberships | Membership[] | List of membership information |
Defined in
lib/messaging-api/model/membershipListResponse.ts:18
Message
Ƭ Message: AudioMessage | FlexMessage | ImageMessage | ImagemapMessage | LocationMessage | StickerMessage | TemplateMessage | TextMessage | VideoMessage
Defined in
lib/messaging-api/model/message.ts:26
MessageAction
Ƭ MessageAction: ActionBase & { text?: string ; type: "message" }
Defined in
lib/messaging-api/model/messageAction.ts:17
MessageBase
Ƭ MessageBase: Object
Type declaration
| Name | Type | Description |
|---|---|---|
quickReply? | QuickReply | See quickReply Documentation |
sender? | Sender | See sender Documentation |
type | string | Type of message See type Documentation |
Defined in
lib/messaging-api/model/message.ts:37
MessageImagemapAction
Ƭ MessageImagemapAction: ImagemapActionBase & { label?: string ; text: string ; type: "message" }
Defined in
lib/messaging-api/model/messageImagemapAction.ts:18
MessageQuotaResponse
Ƭ MessageQuotaResponse: Object
Type declaration
| Name | Type | Description |
|---|---|---|
type | QuotaType | See type Documentation |
value? | number | The target limit for sending messages in the current month. This property is returned when the type property has a value of limited. See value Documentation |
Defined in
lib/messaging-api/model/messageQuotaResponse.ts:15
lib/messaging-api/model/messageQuotaResponse.ts:29
MulticastRequest
Ƭ MulticastRequest: Object
Type declaration
| Name | Type | Description |
|---|---|---|
customAggregationUnits? | string[] | Name of aggregation unit. Case-sensitive. See customAggregationUnits Documentation |
messages | Message[] | Messages to send See messages Documentation |
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 have disabled push notifications in LINE and/or their device). The default value is false. See notificationDisabled Documentation |
to | string[] | Array of user IDs. Use userId values which are returned in webhook event objects. Do not use LINE IDs found on LINE. See to Documentation |
Defined in
lib/messaging-api/model/multicastRequest.ts:15
NarrowcastProgressResponse
Ƭ NarrowcastProgressResponse: Object
LINE Messaging API This document describes LINE Messaging API.
The version of the OpenAPI document: 0.0.1
NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.
Type declaration
| Name | Type | Description |
|---|---|---|
acceptedTime | Date | Narrowcast message request accepted time in milliseconds. Format: ISO 8601 (e.g. 2020-12-03T10:15:30.121Z) Timezone: UTC See acceptedTime Documentation |
completedTime? | Date | Processing of narrowcast message request completion time in milliseconds. Returned when the phase property is succeeded or failed. Format: ISO 8601 (e.g. 2020-12-03T10:15:30.121Z) Timezone: UTC See completedTime Documentation |
errorCode? | number | Error summary. This is only included with a phase property value of failed. One of: 1: An internal error occurred. 2: An error occurred because there weren't enough recipients. 3: A conflict error of requests occurs because a request that has already been accepted is retried. See errorCode Documentation |
failedDescription? | string | The reason the message failed to be sent. This is only included with a phase property value of failed. See failedDescription Documentation |
failureCount? | number | The number of users who failed to send the message. See failureCount Documentation |
phase | PhaseEnum | 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. See phase Documentation |
successCount? | number | The number of users who successfully received the message. See successCount Documentation |
targetCount? | number | The number of intended recipients of the message. See targetCount Documentation |
Defined in
lib/messaging-api/model/narrowcastProgressResponse.ts:13
lib/messaging-api/model/narrowcastProgressResponse.ts:64
NarrowcastRequest
Ƭ NarrowcastRequest: Object
Type declaration
| Name | Type | Description |
|---|---|---|
filter? | Filter | See filter Documentation |
limit? | Limit | See limit Documentation |
messages | Message[] | List of Message objects. See messages Documentation |
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 have disabled push notifications in LINE and/or their device). The default value is false. See notificationDisabled Documentation |
recipient? | Recipient | See recipient Documentation |
Defined in
lib/messaging-api/model/narrowcastRequest.ts:18
NumberOfMessagesResponse
Ƭ NumberOfMessagesResponse: Object
LINE Messaging API This document describes LINE Messaging API.
The version of the OpenAPI document: 0.0.1
NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.
Type declaration
| Name | Type | Description |
|---|---|---|
status | StatusEnum | 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). |
success? | number | The number of messages delivered using the phone number on the date specified in date. The response has this property only when the value of status is ready. |
Defined in
lib/messaging-api/model/numberOfMessagesResponse.ts:13
lib/messaging-api/model/numberOfMessagesResponse.ts:24
OperatorDemographicFilter
Ƭ OperatorDemographicFilter: DemographicFilterBase & { and?: DemographicFilter[] ; not?: DemographicFilter ; or?: DemographicFilter[] ; type: "operator" }
Defined in
lib/messaging-api/model/operatorDemographicFilter.ts:17
OperatorRecipient
Ƭ OperatorRecipient: RecipientBase & { and?: Recipient[] ; not?: Recipient ; or?: Recipient[] ; type: "operator" }
Defined in
lib/messaging-api/model/operatorRecipient.ts:17
PnpMessagesRequest
Ƭ PnpMessagesRequest: Object
Type declaration
| Name | Type | Description |
|---|---|---|
messages | Message[] | Message to be sent. See messages Documentation |
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 have disabled push notifications in LINE and/or their device). The default value is false. See notificationDisabled Documentation |
to | string | Message destination. Specify a phone number that has been normalized to E.164 format and hashed with SHA256. See to Documentation |
Defined in
lib/messaging-api/model/pnpMessagesRequest.ts:15
PostbackAction
Ƭ PostbackAction: ActionBase & { data?: string ; displayText?: string ; fillInText?: string ; inputOption?: InputOptionEnum ; text?: string ; type: "postback" }
Defined in
lib/messaging-api/model/postbackAction.ts:17
lib/messaging-api/model/postbackAction.ts:36
PushMessageRequest
Ƭ PushMessageRequest: Object
Type declaration
| Name | Type | Description |
|---|---|---|
customAggregationUnits? | string[] | List of aggregation unit name. Case-sensitive. This functions can only be used by corporate users who have submitted the required applications. See customAggregationUnits Documentation |
messages | Message[] | List of Message objects. See messages Documentation |
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 have disabled push notifications in LINE and/or their device). The default value is false. See notificationDisabled Documentation |
to | string | ID of the receiver. See to Documentation |
Defined in
lib/messaging-api/model/pushMessageRequest.ts:15
PushMessageResponse
Ƭ PushMessageResponse: Object
Type declaration
| Name | Type | Description |
|---|---|---|
sentMessages | SentMessage[] | Array of sent messages. See sentMessages Documentation |
Defined in
lib/messaging-api/model/pushMessageResponse.ts:15
QuickReply
Ƭ QuickReply: Object
Quick reply
Type declaration
| Name | Type | Description |
|---|---|---|
items? | QuickReplyItem[] | Quick reply button objects. See items Documentation |
Defined in
lib/messaging-api/model/quickReply.ts:18
QuickReplyItem
Ƭ QuickReplyItem: Object
Type declaration
| Name | Type | Description |
|---|---|---|
action? | Action | See action Documentation |
imageUrl? | string | URL of the icon that is displayed at the beginning of the button See imageUrl Documentation |
type? | string | action See type Documentation |
Defined in
lib/messaging-api/model/quickReplyItem.ts:15
QuotaConsumptionResponse
Ƭ QuotaConsumptionResponse: Object
LINE Messaging API This document describes LINE Messaging API.
The version of the OpenAPI document: 0.0.1
NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.
Type declaration
| Name | Type | Description |
|---|---|---|
totalUsage | number | The number of sent messages in the current month See totalUsage Documentation |
Defined in
lib/messaging-api/model/quotaConsumptionResponse.ts:13
QuotaType
Ƭ QuotaType: "none" | "limited"
One of the following values to indicate whether a target limit is set or not.
Defined in
lib/messaging-api/model/quotaType.ts:17
Recipient
Ƭ Recipient: AudienceRecipient | OperatorRecipient | RedeliveryRecipient
Defined in
lib/messaging-api/model/recipient.ts:17
RecipientBase
Ƭ RecipientBase: Object
Recipient
Type declaration
| Name | Type | Description |
|---|---|---|
type? | string | Type of recipient |
Defined in
lib/messaging-api/model/recipient.ts:25
RedeliveryRecipient
Ƭ RedeliveryRecipient: RecipientBase & { requestId?: string ; type: "redelivery" }
Defined in
lib/messaging-api/model/redeliveryRecipient.ts:17
ReplyMessageRequest
Ƭ ReplyMessageRequest: Object
Type declaration
| Name | Type | Description |
|---|---|---|
messages | Message[] | List of messages. See messages Documentation |
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 have disabled push notifications in LINE and/or their device). The default value is false. See notificationDisabled Documentation |
replyToken | string | replyToken received via webhook. See replyToken Documentation |
Defined in
lib/messaging-api/model/replyMessageRequest.ts:15
ReplyMessageResponse
Ƭ ReplyMessageResponse: Object
Type declaration
| Name | Type | Description |
|---|---|---|
sentMessages | SentMessage[] | Array of sent messages. See sentMessages Documentation |
Defined in
lib/messaging-api/model/replyMessageResponse.ts:15
RichMenuAliasListResponse
Ƭ RichMenuAliasListResponse: Object
Type declaration
| Name | Type | Description |
|---|---|---|
aliases | RichMenuAliasResponse[] | Rich menu aliases. See aliases Documentation |
Defined in
lib/messaging-api/model/richMenuAliasListResponse.ts:15
RichMenuAliasResponse
Ƭ RichMenuAliasResponse: Object
LINE Messaging API This document describes LINE Messaging API.
The version of the OpenAPI document: 0.0.1
NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.
Type declaration
| Name | Type | Description |
|---|---|---|
richMenuAliasId | string | Rich menu alias ID. |
richMenuId | string | The rich menu ID associated with the rich menu alias. |
Defined in
lib/messaging-api/model/richMenuAliasResponse.ts:13
RichMenuArea
Ƭ RichMenuArea: Object
Rich menu area
Type declaration
| Name | Type |
|---|---|
action? | Action |
bounds? | RichMenuBounds |
Defined in
lib/messaging-api/model/richMenuArea.ts:19
RichMenuBatchLinkOperation
Ƭ RichMenuBatchLinkOperation: RichMenuBatchOperationBase & { from: string ; to: string ; type: "link" }
Defined in
lib/messaging-api/model/richMenuBatchLinkOperation.ts:20
RichMenuBatchOperation
Ƭ RichMenuBatchOperation: RichMenuBatchLinkOperation | RichMenuBatchUnlinkOperation | RichMenuBatchUnlinkAllOperation
Defined in
lib/messaging-api/model/richMenuBatchOperation.ts:17
RichMenuBatchOperationBase
Ƭ RichMenuBatchOperationBase: Object
Rich menu operation object represents the batch operation to the rich menu linked to the user.
Type declaration
| Name | Type | Description |
|---|---|---|
type | string | The type of operation to the rich menu linked to the user. One of link, unlink, or unlinkAll. See type Documentation |
Defined in
lib/messaging-api/model/richMenuBatchOperation.ts:25
RichMenuBatchProgressPhase
Ƭ RichMenuBatchProgressPhase: "ongoing" | "succeeded" | "failed"
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.
Defined in
lib/messaging-api/model/richMenuBatchProgressPhase.ts:17
RichMenuBatchProgressResponse
Ƭ RichMenuBatchProgressResponse: Object
Type declaration
| Name | Type | Description |
|---|---|---|
acceptedTime | Date | The accepted time in milliseconds of the request of batch control the rich menu. Format: ISO 8601 (e.g. 2023-06-08T10:15:30.121Z) Timezone: UTC See acceptedTime Documentation |
completedTime? | Date | The completed time in milliseconds of rich menu batch control. Returned when the phase property is succeeded or failed. Format: ISO 8601 (e.g. 2023-06-08T10:15:30.121Z) Timezone: UTC See completedTime Documentation |
phase | RichMenuBatchProgressPhase | See phase Documentation |
Defined in
lib/messaging-api/model/richMenuBatchProgressResponse.ts:15
lib/messaging-api/model/richMenuBatchProgressResponse.ts:35
RichMenuBatchRequest
Ƭ RichMenuBatchRequest: Object
Type declaration
| Name | Type | Description |
|---|---|---|
operations | RichMenuBatchOperation[] | Array of Rich menu operation object... |
resumeRequestKey? | string | Key for retry. Key value is a string matching the regular expression pattern |
Defined in
lib/messaging-api/model/richMenuBatchRequest.ts:15
RichMenuBatchUnlinkAllOperation
Ƭ RichMenuBatchUnlinkAllOperation: RichMenuBatchOperationBase & { type: "unlinkAll" }
Defined in
lib/messaging-api/model/richMenuBatchUnlinkAllOperation.ts:20
RichMenuBatchUnlinkOperation
Ƭ RichMenuBatchUnlinkOperation: RichMenuBatchOperationBase & { from: string ; type: "unlink" }
Defined in
lib/messaging-api/model/richMenuBatchUnlinkOperation.ts:20
RichMenuBounds
Ƭ RichMenuBounds: Object
Rich menu bounds
Type declaration
| Name | Type | Description |
|---|---|---|
height? | number | Height of the area. See height Documentation |
width? | number | Width of the area. See width Documentation |
x? | number | Horizontal position relative to the top-left corner of the area. See x Documentation |
y? | number | Vertical position relative to the top-left corner of the area. See y Documentation |
Defined in
lib/messaging-api/model/richMenuBounds.ts:16
RichMenuBulkLinkRequest
Ƭ RichMenuBulkLinkRequest: Object
LINE Messaging API This document describes LINE Messaging API.
The version of the OpenAPI document: 0.0.1
NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.
Type declaration
| Name | Type | Description |
|---|---|---|
richMenuId | string | ID of a rich menu See richMenuId Documentation |
userIds | string[] | Array of user IDs. Found in the source object of webhook event objects. Do not use the LINE ID used in LINE. See userIds Documentation |
Defined in
lib/messaging-api/model/richMenuBulkLinkRequest.ts:13
RichMenuBulkUnlinkRequest
Ƭ RichMenuBulkUnlinkRequest: Object
LINE Messaging API This document describes LINE Messaging API.
The version of the OpenAPI document: 0.0.1
NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.
Type declaration
| Name | Type | Description |
|---|---|---|
userIds | string[] | Array of user IDs. Found in the source object of webhook event objects. Do not use the LINE ID used in LINE. See userIds Documentation |
Defined in
lib/messaging-api/model/richMenuBulkUnlinkRequest.ts:13
RichMenuIdResponse
Ƭ RichMenuIdResponse: Object
LINE Messaging API This document describes LINE Messaging API.
The version of the OpenAPI document: 0.0.1
NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.
Type declaration
| Name | Type | Description |
|---|---|---|
richMenuId | string | Rich menu ID |
Defined in
lib/messaging-api/model/richMenuIdResponse.ts:13
RichMenuListResponse
Ƭ RichMenuListResponse: Object
Type declaration
| Name | Type | Description |
|---|---|---|
richmenus | RichMenuResponse[] | Rich menus See richmenus Documentation |
Defined in
lib/messaging-api/model/richMenuListResponse.ts:15
RichMenuRequest
Ƭ RichMenuRequest: Object
Type declaration
| Name | Type | Description |
|---|---|---|
areas? | RichMenuArea[] | Array of area objects which define the coordinates and size of tappable areas |
chatBarText? | string | Text displayed in the chat bar |
name? | string | Name of the rich menu. This value can be used to help manage your rich menus and is not displayed to users. |
selected? | boolean | true to display the rich menu by default. Otherwise, false. |
size? | RichMenuSize |
Defined in
lib/messaging-api/model/richMenuRequest.ts:16
RichMenuResponse
Ƭ RichMenuResponse: Object
Type declaration
| Name | Type | Description |
|---|---|---|
areas | RichMenuArea[] | Array of area objects which define the coordinates and size of tappable areas |
chatBarText | string | Text displayed in the chat bar |
name | string | Name of the rich menu. This value can be used to help manage your rich menus and is not displayed to users. |
richMenuId | string | ID of a rich menu |
selected | boolean | true to display the rich menu by default. Otherwise, false. |
size | RichMenuSize |
Defined in
lib/messaging-api/model/richMenuResponse.ts:16
RichMenuSize
Ƭ RichMenuSize: Object
Rich menu size
Type declaration
| Name | Type | Description |
|---|---|---|
height? | number | height |
width? | number | width |
Defined in
lib/messaging-api/model/richMenuSize.ts:16
RichMenuSwitchAction
Ƭ RichMenuSwitchAction: ActionBase & { data?: string ; richMenuAliasId?: string ; type: "richmenuswitch" }
Defined in
lib/messaging-api/model/richMenuSwitchAction.ts:17
RoomMemberCountResponse
Ƭ RoomMemberCountResponse: Object
LINE Messaging API This document describes LINE Messaging API.
The version of the OpenAPI document: 0.0.1
NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.
Type declaration
| Name | Type | Description |
|---|---|---|
count | number | The count of members in the multi-person chat. The number returned excludes the LINE Official Account. See count Documentation |
Defined in
lib/messaging-api/model/roomMemberCountResponse.ts:13
RoomUserProfileResponse
Ƭ RoomUserProfileResponse: Object
LINE Messaging API This document describes LINE Messaging API.
The version of the OpenAPI document: 0.0.1
NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.
Type declaration
| Name | Type | Description |
|---|---|---|
displayName | string | User's display name See displayName Documentation |
pictureUrl? | string | Profile image URL. https image URL. Not included in the response if the user doesn't have a profile image. See pictureUrl Documentation |
userId | string | User ID See userId Documentation |
Defined in
lib/messaging-api/model/roomUserProfileResponse.ts:13
Sender
Ƭ Sender: Object
Change icon and display name
Type declaration
| Name | Type | Description |
|---|---|---|
iconUrl? | string | URL of the image to display as an icon when sending a message |
name? | string | Display name. Certain words such as LINE may not be used. |
Defined in
lib/messaging-api/model/sender.ts:16
SentMessage
Ƭ SentMessage: Object
LINE Messaging API This document describes LINE Messaging API.
The version of the OpenAPI document: 0.0.1
NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.
Type declaration
| Name | Type | Description |
|---|---|---|
id | string | ID of the sent message. |
quoteToken? | string | Quote token of the message. Only included when a message object that can be specified as a quote target was sent as a push or reply message. |
Defined in
lib/messaging-api/model/sentMessage.ts:13
SetWebhookEndpointRequest
Ƭ SetWebhookEndpointRequest: Object
LINE Messaging API This document describes LINE Messaging API.
The version of the OpenAPI document: 0.0.1
NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.
Type declaration
| Name | Type | Description |
|---|---|---|
endpoint | string | A valid webhook URL. See endpoint Documentation |
Defined in
lib/messaging-api/model/setWebhookEndpointRequest.ts:13
ShowLoadingAnimationRequest
Ƭ ShowLoadingAnimationRequest: Object
LINE Messaging API This document describes LINE Messaging API.
The version of the OpenAPI document: 0.0.1
NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.
Type declaration
| Name | Type | Description |
|---|---|---|
chatId | string | User ID of the target user for whom the loading animation is to be displayed. See chatId Documentation |
loadingSeconds? | number | The number of seconds to display the loading indicator. It must be a multiple of 5. The maximum value is 60 seconds. See loadingSeconds Documentation |
Defined in
lib/messaging-api/model/showLoadingAnimationRequest.ts:13
StickerMessage
Ƭ StickerMessage: MessageBase & { packageId: string ; quoteToken?: string ; stickerId: string ; type: "sticker" }
Defined in
lib/messaging-api/model/stickerMessage.ts:19
SubscribedMembershipPlan
Ƭ SubscribedMembershipPlan: Object
Object containing information about the membership plan.
Type declaration
| Name | Type | Description |
|---|---|---|
benefits | string[] | List of membership plan perks. |
currency | CurrencyEnum | The currency of membership.price. |
description | string | Membership plan description. |
membershipId | number | Membership plan ID. |
price | number | Monthly fee for membership plan. (e.g. 1500.00) |
title | string | Membership plan name. |
Defined in
lib/messaging-api/model/subscribedMembershipPlan.ts:16
lib/messaging-api/model/subscribedMembershipPlan.ts:43
SubscribedMembershipUser
Ƭ SubscribedMembershipUser: Object
Object containing user membership subscription information.
Type declaration
| Name | Type | Description |
|---|---|---|
joinedTime | number | UNIX timestamp at which the user subscribed to the membership. |
membershipNo | number | The user's member number in the membership plan. |
nextBillingDate | string | Next payment date for membership plan. - Format: yyyy-MM-dd (e.g. 2024-02-08) - Timezone: UTC+9 |
totalSubscriptionMonths | number | The period of time in months that the user has been subscribed to a membership plan. If a user previously canceled and then re-subscribed to the same membership plan, only the period after the re-subscription will be counted. |
Defined in
lib/messaging-api/model/subscribedMembershipUser.ts:16
Subscription
Ƭ Subscription: Object
An array of memberships.
Type declaration
| Name | Type |
|---|---|
membership | SubscribedMembershipPlan |
user | SubscribedMembershipUser |
Defined in
lib/messaging-api/model/subscription.ts:19
SubscriptionPeriodDemographic
Ƭ SubscriptionPeriodDemographic: "day_7" | "day_30" | "day_90" | "day_180" | "day_365"
LINE Messaging API This document describes LINE Messaging API.
The version of the OpenAPI document: 0.0.1
NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.
Defined in
lib/messaging-api/model/subscriptionPeriodDemographic.ts:13
SubscriptionPeriodDemographicFilter
Ƭ SubscriptionPeriodDemographicFilter: DemographicFilterBase & { gte?: SubscriptionPeriodDemographic ; lt?: SubscriptionPeriodDemographic ; type: "subscriptionPeriod" }
Defined in
lib/messaging-api/model/subscriptionPeriodDemographicFilter.ts:18
lib/messaging-api/model/subscriptionPeriodDemographicFilter.ts:28
Template
Ƭ Template: ButtonsTemplate | CarouselTemplate | ConfirmTemplate | ImageCarouselTemplate
Defined in
lib/messaging-api/model/template.ts:18
TemplateBase
Ƭ TemplateBase: Object
Type declaration
| Name | Type |
|---|---|
type | string |
Defined in
lib/messaging-api/model/template.ts:24
TemplateImageAspectRatio
Ƭ TemplateImageAspectRatio: "rectangle" | "square"
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
Defined in
lib/messaging-api/model/templateImageAspectRatio.ts:17
TemplateImageSize
Ƭ TemplateImageSize: "cover" | "contain"
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 of the image that do not fit in the area are not displayed. contain: The entire image is displayed in the image area. A background is displayed in the unused areas to the left and right of vertical images and in the areas above and below horizontal images.
Defined in
lib/messaging-api/model/templateImageSize.ts:17
TemplateMessage
Ƭ TemplateMessage: MessageBase & { altText: string ; template: Template ; type: "template" }
Defined in
lib/messaging-api/model/templateMessage.ts:20
TestWebhookEndpointRequest
Ƭ TestWebhookEndpointRequest: Object
LINE Messaging API This document describes LINE Messaging API.
The version of the OpenAPI document: 0.0.1
NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.
Type declaration
| Name | Type | Description |
|---|---|---|
endpoint? | string | A webhook URL to be validated. See endpoint Documentation |
Defined in
lib/messaging-api/model/testWebhookEndpointRequest.ts:13
TestWebhookEndpointResponse
Ƭ TestWebhookEndpointResponse: Object
LINE Messaging API This document describes LINE Messaging API.
The version of the OpenAPI document: 0.0.1
NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.
Type declaration
| Name | Type | Description |
|---|---|---|
detail | string | Details of the response. See detail Documentation |
reason | string | Reason for the response. See reason Documentation |
statusCode | number | The HTTP status code. If the webhook response isn't received, the status code is set to zero or a negative number. See statusCode Documentation |
success? | boolean | Result of the communication from the LINE platform to the webhook URL. See success Documentation |
timestamp | Date | Time of the event in milliseconds. Even in the case of a redelivered webhook, it represents the time the event occurred, not the time it was redelivered. See timestamp Documentation |
Defined in
lib/messaging-api/model/testWebhookEndpointResponse.ts:13
TextMessage
Ƭ TextMessage: MessageBase & { emojis?: Emoji[] ; quoteToken?: string ; text: string ; type: "text" }
Defined in
lib/messaging-api/model/textMessage.ts:20
URIAction
Ƭ URIAction: ActionBase & { altUri?: AltUri ; type: "uri" ; uri?: string }
Defined in
lib/messaging-api/model/uRIAction.ts:18
URIImagemapAction
Ƭ URIImagemapAction: ImagemapActionBase & { label?: string ; linkUri: string ; type: "uri" }
Defined in
lib/messaging-api/model/uRIImagemapAction.ts:18
UpdateRichMenuAliasRequest
Ƭ UpdateRichMenuAliasRequest: Object
LINE Messaging API This document describes LINE Messaging API.
The version of the OpenAPI document: 0.0.1
NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.
Type declaration
| Name | Type | Description |
|---|---|---|
richMenuId | string | The rich menu ID to be associated with the rich menu alias. See richMenuId Documentation |
Defined in
lib/messaging-api/model/updateRichMenuAliasRequest.ts:13
UserProfileResponse
Ƭ UserProfileResponse: Object
LINE Messaging API This document describes LINE Messaging API.
The version of the OpenAPI document: 0.0.1
NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.
Type declaration
| Name | Type | Description |
|---|---|---|
displayName | string | User's display name See displayName Documentation |
language? | string | User's language, as a BCP 47 language tag. Not included in the response if the user hasn't yet consented to the LINE Privacy Policy. See language Documentation |
pictureUrl? | string | Profile image URL. https image URL. Not included in the response if the user doesn't have a profile image. See pictureUrl Documentation |
statusMessage? | string | User's status message. Not included in the response if the user doesn't have a status message. See statusMessage Documentation |
userId | string | User ID See userId Documentation |
Defined in
lib/messaging-api/model/userProfileResponse.ts:13
ValidateMessageRequest
Ƭ ValidateMessageRequest: Object
Type declaration
| Name | Type | Description |
|---|---|---|
messages | Message[] | Array of message objects to validate |
Defined in
lib/messaging-api/model/validateMessageRequest.ts:15
VideoMessage
Ƭ VideoMessage: MessageBase & { originalContentUrl: string ; previewImageUrl: string ; trackingId?: string ; type: "video" }