API Reference line_bot_sdk v#0.2.0
Copy MarkdownModules
API calls for all endpoints tagged ChannelAccessToken.
Channel access token key IDs
Error response of the Channel access token
Issued channel access token
Issued short-lived channel access token
Issued stateless channel access token
Verification result
Helper functions for deserializing responses into models.
API calls for all endpoints tagged Dummy.
API calls for all endpoints tagged Insight.
Get friend demographics
Statistics about how users interact with narrowcast messages or broadcast messages sent from your LINE Official Account.
Summary of message statistics.
Get number of followers
Get number of message deliveries
Daily impression and click statistics for a rich menu created via the Messaging API.
Target area of the metrics, represented by the top-left coordinate, width, and height.
Daily click metrics for a single tappable area of the rich menu.
Aggregated number of events and unique users for a single day.
Daily impression metrics for the whole rich menu.
Summary of impression and click statistics for a rich menu created via the Messaging API.
Target area of the metrics, represented by the top-left coordinate, width, and height.
Click metrics for a single tappable area of the rich menu.
Impression metrics for the whole rich menu.
Aggregated number of events and unique users over the whole period.
Response object for get statistics per unit
Statistics related to messages.
API calls for all endpoints tagged Liff.
Specify the setting for bot link feature with one of the following values: normal: Display the option to add the LINE Official Account as a friend in the channel consent screen. aggressive: Display a screen with the option to add the LINE Official Account as a friend after the channel consent screen. none: Don't display the option to add the LINE Official Account as a friend. The default value is none.
Array of scopes required for some LIFF SDK methods to function. The default value is ["profile", "chat_message.write"].
API calls for all endpoints tagged LineModule.
API calls for all endpoints tagged LineModuleAttach.
API calls for all endpoints tagged ManageAudience.
Adaccount
Add user IDs or Identifiers for Advertisers (IFAs) to an audience for uploading user IDs (by JSON)
Audience group
How the audience was created. One of: - OA_MANAGER: Audience created with LINE Official Account Manager. - MESSAGING_API: Audience created with Messaging API. - POINT_AD: Audience created with LINE Points Ads (Japanese only). - AD_MANAGER: Audience created with LINE Ads.
Audience group job
Audience group type
Create audience for uploading user IDs (by JSON)
Create audience for uploading user IDs (by JSON)
Create audience for click-based retargeting
Create audience for click-based retargeting
Create audience for impression-based retargeting
Create audience for impression-based retargeting
Owner of this audience group.
Get audience data
Gets data for more than one audience.
Get audience data
Gets data for more than one audience.
Rename an audience
API calls for all endpoints tagged ManageAudienceBlob.
API calls for all endpoints tagged MessagingApi.
Column object for carousel template.
Chat reference
Request object for creating a coupon. Contains all configurable coupon properties.
Response object returned after creating a coupon. Contains the coupon ID.
Summary information about a coupon, used in coupon lists.
Detailed information about a coupon, including all properties and current status.
Demographic filter
An object representing a emoji substitution.
Filter for narrowcast
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.
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.
Padding can be specified in pixels, percentage (to the parent box width) or with a keyword. FlexBoxPadding just provides only keywords.
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.
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.
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.
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.
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.
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.
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.
List of users who have joined the membership
A user's membership subscription status
Transcoding response
Limit of the Narrowcast
List of memberships
An object representing a mention substitution.
Paginated response object containing a list of coupons.
Quick reply
One of the following values to indicate whether a target limit is set or not.
Recipient
Rich menu area
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.
Rich menu operation object represents the batch operation to the rich menu linked to the user.
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.
Unlink the rich menu from all users linked to the rich menu.
Unlink the rich menu for all users linked to the rich menu specified in the from property.
Rich menu bounds
Rich menu size
Change icon and display name
Object containing information about the membership plan.
Object containing user membership subscription information.
An array of memberships.
An object that defines the replacement value for a placeholder in the text.
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
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.
API calls for all endpoints tagged MessagingApiBlob.
Request entity of the Acquire Control API
Unlink (detach) the module channel by the operation of the module channel administrator
List of bots to which the module is attached
basic information about the bot.
Attach by operation of the module channel provider
API calls for all endpoints tagged Shop.
Send mission stickers (v3)
Event object for when a user has linked their LINE account with a provider's service account. You can reply to account link events.
This event indicates that the module channel has been switched to Active Channel by calling the Acquire Control API. Sent to the webhook URL server of the module channel.
Mentioned target is entire group
Event object for when a user enters the range of a LINE Beacon. You can reply to beacon events.
This event indicates that the LINE Official Account has returned from the suspended state. Sent to the webhook URL server of the module channel.
This event indicates that the LINE Official Account has been suspended (Suspend). Sent to the webhook URL server of the module channel.
The request body contains a JSON object with the user ID of a bot that should receive webhook events and an array of webhook event objects.
Provider of the media file.
This event indicates that the module channel has been switched to Standby Channel by calling Acquire Control API or Release Control API. Sent to the webhook URL server of the module channel.
webhook's delivery context information
Webhook event
Channel state.
Event object for when your LINE Official Account is added as a friend (or unblocked). You can reply to follow events.
Event object for when your LINE Official Account joins a group chat or multi-person chat. You can reply to join events.
Event object for when a user removes your LINE Official Account from a group chat or when your LINE Official Account leaves a group chat or multi-person chat.
Content of the account link event.
Event object for when a user joins a group chat or multi-person chat that the LINE Official Account is in.
Event object for when a user leaves a group chat or multi-person chat that the LINE Official Account is in.
Content of the membership event.
This event indicates that a user has subscribed (joined), unsubscribed (left), or renewed the bot's membership.
Webhook event object which contains the edited message. This event is triggered when a user edits a text message. Currently, message editing is not available in one-on-one chats with LINE Official Accounts, so this event is only triggered in group chats. Multiple messageEdited webhook events may arrive out of order. The event with the largest timestamp represents the latest edit state.
Webhook event object which contains the sent message.
This event indicates that the module channel has been attached to the LINE Official Account. Sent to the webhook URL server of the module channel.
A delivery object containing a hashed phone number string or a string specified by X-Line-Delivery-Tag header
When a request is made to the LINE notification messages API and delivery of the LINE notification message to the user is completed, a dedicated webhook event (delivery completion event) is sent from the LINE Platform to the webhook URL of the bot server.
Event object for when a user performs a postback action which initiates a postback. You can reply to postback events.
the source of the event.
Event object for when your LINE Official Account is blocked.
Event object for when the user unsends a message.
Mentioned target is user
Event for when a user finishes viewing a video at least once with the specified trackingId sent by the LINE Official Account.
A Plug for handling LINE Bot webhook requests.