LINE Messaging API SDK for Python
Project description
SDK of the LINE Messaging API for Python.
Introduction
The LINE Messaging API SDK for Python makes it easy to develop bots using LINE Messaging API, and you can create a sample bot within minutes.
Documentation
See the official API documentation for more information
English: https://developers.line.biz/en/docs/messaging-api/overview/
Japanese: https://developers.line.biz/ja/docs/messaging-api/overview/
Requirements
- Python >= 2.7 or >= 3.4
Installation
$ pip install line-bot-sdk
Synopsis
Usage:
from flask import Flask, request, abort from linebot import ( LineBotApi, WebhookHandler ) from linebot.exceptions import ( InvalidSignatureError ) from linebot.models import ( MessageEvent, TextMessage, TextSendMessage, ) app = Flask(__name__) line_bot_api = LineBotApi('YOUR_CHANNEL_ACCESS_TOKEN') handler = WebhookHandler('YOUR_CHANNEL_SECRET') @app.route("/callback", methods=['POST']) def callback(): # get X-Line-Signature header value signature = request.headers['X-Line-Signature'] # get request body as text body = request.get_data(as_text=True) app.logger.info("Request body: " + body) # handle webhook body try: handler.handle(body, signature) except InvalidSignatureError: print("Invalid signature. Please check your channel access token/channel secret.") abort(400) return 'OK' @handler.add(MessageEvent, message=TextMessage) def handle_message(event): line_bot_api.reply_message( event.reply_token, TextSendMessage(text=event.message.text)) if __name__ == "__main__": app.run()
API
LineBotApi
__init__(self, channel_access_token, endpoint=’https://api.line.me’, timeout=5, http_client=RequestsHttpClient)
Create a new LineBotApi instance.
line_bot_api = linebot.LineBotApi('YOUR_CHANNEL_ACCESS_TOKEN')
You can override the timeout value for each method.
push_message(self, to, messages, notification_disabled=False, timeout=None)
Send messages to users, groups, and rooms at any time.
https://developers.line.biz/en/reference/messaging-api/#send-push-message
line_bot_api.push_message(to, TextSendMessage(text='Hello World!'))
multicast(self, to, messages, notification_disabled=False, timeout=None)
Send push messages to multiple users at any time. Messages cannot be sent to groups or rooms.
https://developers.line.biz/en/reference/messaging-api/#send-multicast-message
line_bot_api.multicast(['to1', 'to2'], TextSendMessage(text='Hello World!'))
broadcast(self, messages, notification_disabled=False, timeout=None)
Send push messages to multiple users at any time.
https://developers.line.biz/en/reference/messaging-api/#send-broadcast-message
line_bot_api.broadcast(TextSendMessage(text='Hello World!'))
narrowcast(self, messages, recipient=None, filter=None, limit=None, timeout=None)
Sends a push message to multiple users specified by attributes (such as age, gender, OS, and region) or retargeting (audiences).
https://developers.line.biz/en/reference/messaging-api/#send-narrowcast-message
line_bot_api.narrowcast( messages=TextSendMessage(text='Hello World!'), recipient=AudienceRecipient(group_id=5614991017776), filter=Filter(demographic=AgeFilter(gte="age_35", lt="age_40")), limit=Limit(max=10) )
get_progress_status_narrowcast(self, request_id, timeout=None)
Get progress status of narrowcast messages sent.
https://developers.line.biz/en/reference/messaging-api/#get-narrowcast-progress-status
narrowcast_progress = line_bot_api.get_progress_status_narrowcast(request_id) assert narrowcast_progress.phase == 'succeeded' print(narrowcast.success_count) print(narrowcast.failure_count) print(narrowcast.target_count)
get_profile(self, user_id, timeout=None)
Get user profile information.
https://developers.line.biz/en/reference/messaging-api/#get-profile
profile = line_bot_api.get_profile(user_id) print(profile.display_name) print(profile.user_id) print(profile.picture_url) print(profile.status_message)
get_group_summary(self, group_id, timeout=None)
Gets the group ID, group name, and group icon URL of a group where the LINE Official Account is a member.
https://developers.line.biz/en/reference/messaging-api/#get-group-summary
summary = line_bot_api.get_group_summary(group_id) print(summary.group_id) print(summary.group_name) print(summary.picture_url)
get_group_member_profile(self, group_id, user_id, timeout=None)
Gets the user profile of a member of a group that the bot is in. This can be the user ID of a user who has not added the bot as a friend or has blocked the bot.
https://developers.line.biz/en/reference/messaging-api/#get-group-member-profile
profile = line_bot_api.get_group_member_profile(group_id, user_id) print(profile.display_name) print(profile.user_id) print(profile.picture_url)
get_room_member_profile(self, room_id, user_id, timeout=None)
Gets the user profile of a member of a room that the bot is in. This can be the user ID of a user who has not added the bot as a friend or has blocked the bot.
https://developers.line.biz/en/reference/messaging-api/#get-room-member-profile
profile = line_bot_api.get_room_member_profile(room_id, user_id) print(profile.display_name) print(profile.user_id) print(profile.picture_url)
get_group_member_ids(self, group_id, start=None, timeout=None)
Gets the user IDs of the members of a group that the bot is in. This includes the user IDs of users who have not added the bot as a friend or has blocked the bot.
https://developers.line.biz/en/reference/messaging-api/#get-group-member-user-ids
member_ids_res = line_bot_api.get_group_member_ids(group_id) print(member_ids_res.member_ids) print(member_ids_res.next)
get_room_member_ids(self, room_id, start=None, timeout=None)
Gets the user IDs of the members of a room that the bot is in. This includes the user IDs of users who have not added the bot as a friend or has blocked the bot.
https://developers.line.biz/en/reference/messaging-api/#get-room-member-user-ids
member_ids_res = line_bot_api.get_room_member_ids(room_id) print(member_ids_res.member_ids) print(member_ids_res.next)
get_group_members_count(self, group_id, timeout=None)
Gets the count of members in a group.
https://developers.line.biz/en/reference/messaging-api/#get-members-group-count
group_count = line_bot_api.get_group_members_count(group_id) print(group_count)
get_room_members_count(self, room_id, timeout=None)
Gets the count of members in a room.
https://developers.line.biz/en/reference/messaging-api/#get-members-room-count
room_count = line_bot_api.get_room_members_count(room_id) print(room_count)
get_message_content(self, message_id, timeout=None)
Retrieve image, video, and audio data sent by users.
https://developers.line.biz/en/reference/messaging-api/#get-content
message_content = line_bot_api.get_message_content(message_id) with open(file_path, 'wb') as fd: for chunk in message_content.iter_content(): fd.write(chunk)
leave_group(self, group_id, timeout=None)
Leave a group.
https://developers.line.biz/en/reference/messaging-api/#leave-group
line_bot_api.leave_group(group_id)
leave_room(self, room_id, timeout=None)
Leave a room.
https://developers.line.biz/en/reference/messaging-api/#leave-room
line_bot_api.leave_room(room_id)
issue_link_token(self, user_id, timeout=None)
Issues a link token used for the account link feature.
https://developers.line.biz/en/reference/messaging-api/#issue-link-token
link_token_response = line_bot_api.issue_link_token(<user_id>) print(link_token_response)
issue_channel_token(self, client_id, client_secret, grant_type=’client_credentials’, timeout=None)
Issues a short-lived channel access token.
https://developers.line.biz/en/reference/messaging-api/#issue-channel-access-token
channel_token_response = line_bot_api.issue_channel_token(<client_id>, <client_secret>) print(access_token_response)
revoke_channel_token(self, access_token, timeout=None)
Revokes a channel access token.
https://developers.line.biz/en/reference/messaging-api/#revoke-channel-access-token
line_bot_api.revoke_channel_token(<access_token>)
get_insight_message_delivery(self, date, timeout=None)
Get the number of messages sent on a specified day.
https://developers.line.biz/en/reference/messaging-api/#get-number-of-delivery-messages
insight = line_bot_api.get_insight_message_delivery('20191231') print(insight.api_broadcast)
get_insight_followers(self, date, timeout=None)
Get the number of users who have added the bot on or before a specified date.
https://developers.line.biz/en/reference/messaging-api/#get-number-of-followers
insight = line_bot_api.get_insight_followers('20191231') print(insight.followers)
get_insight_demographic(self, timeout=None)
Retrieve the demographic attributes for a bot’s friends.
https://developers.line.biz/en/reference/messaging-api/#get-demographic
insight = line_bot_api.get_insight_demographic() print(insight.genders)
get_insight_message_event(self, request_id, timeout=None)
Return statistics about how users interact with broadcast messages.
https://developers.line.biz/en/reference/messaging-api/#get-message-event
broadcast_response = line_bot_api.broadcast(TextSendMessage(text='Hello World!')) insight = line_bot_api.get_insight_message_event(broadcast_response.request_id) print(insight.overview)
get_bot_info(self, timeout=None)
Get bot’s basic information.
https://developers.line.biz/en/reference/messaging-api/#get-bot-info
bot_info = line_bot_api.get_bot_info() print(bot_info.display_name) print(bot_info.user_id) print(bot_info.basic_id) print(bot_info.premium_id) print(bot_info.picture_url) print(bot_info.chat_mode) print(bot_info.mark_as_read_mode)
set_webhook_endpoint(self, webhook_endpoint, timeout=None)
Set the webhook endpoint URL.
https://developers.line.biz/en/reference/messaging-api/#set-webhook-endpoint-url
line_bot_api.set_webhook_endpoint(<webhook_endpoint_URL>)
get_webhook_endpoint(self, timeout=None)
Get information on a webhook endpoint.
https://developers.line.biz/en/reference/messaging-api/#get-webhook-endpoint-information
webhook = line_bot_api.get_webhook_endpoint() print(webhook.endpoint) print(webhook.active)
test_webhook_endpoint(self, webhook_endpoint=None, timeout=None)
Check if the configured webhook endpoint can receive a test webhook event.
https://developers.line.biz/en/reference/messaging-api/#test-webhook-endpoint
test_result = line_bot_api.test_webhook_endpoint() print(test_result.success) print(test_result.timestamp) print(test_result.status_code) print(test_result.reason) print(test_result.detail)
※ Error handling
If the LINE API server returns an error, LineBotApi raises LineBotApiError.
https://developers.line.biz/en/reference/messaging-api/#error-responses
try: line_bot_api.push_message('to', TextSendMessage(text='Hello World!')) except linebot.exceptions.LineBotApiError as e: print(e.status_code) print(e.request_id) print(e.error.message) print(e.error.details)
Message objects
https://developers.line.biz/en/reference/messaging-api/#message-objects
The following classes are found in the linebot.models package.
TextSendMessage
text_message = TextSendMessage(text='Hello, world')
ImageSendMessage
image_message = ImageSendMessage( original_content_url='https://example.com/original.jpg', preview_image_url='https://example.com/preview.jpg' )
VideoSendMessage
video_message = VideoSendMessage( original_content_url='https://example.com/original.mp4', preview_image_url='https://example.com/preview.jpg' )
AudioSendMessage
audio_message = AudioSendMessage( original_content_url='https://example.com/original.m4a', duration=240000 )
LocationSendMessage
location_message = LocationSendMessage( title='my location', address='Tokyo', latitude=35.65910807942215, longitude=139.70372892916203 )
StickerSendMessage
sticker_message = StickerSendMessage( package_id='1', sticker_id='1' )
ImagemapSendMessage
imagemap_message = ImagemapSendMessage( base_url='https://example.com/base', alt_text='this is an imagemap', base_size=BaseSize(height=1040, width=1040), video=Video( original_content_url='https://example.com/video.mp4', preview_image_url='https://example.com/video_preview.jpg', area=ImagemapArea( x=0, y=0, width=1040, height=585 ), external_link=ExternalLink( link_uri='https://example.com/see_more.html', label='See More', ), ), actions=[ URIImagemapAction( link_uri='https://example.com/', area=ImagemapArea( x=0, y=0, width=520, height=1040 ) ), MessageImagemapAction( text='hello', area=ImagemapArea( x=520, y=0, width=520, height=1040 ) ) ] )
TemplateSendMessage - ConfirmTemplate
confirm_template_message = TemplateSendMessage( alt_text='Confirm template', template=ConfirmTemplate( text='Are you sure?', actions=[ PostbackAction( label='postback', display_text='postback text', data='action=buy&itemid=1' ), MessageAction( label='message', text='message text' ) ] ) )
TemplateSendMessage - CarouselTemplate
carousel_template_message = TemplateSendMessage( alt_text='Carousel template', template=CarouselTemplate( columns=[ CarouselColumn( thumbnail_image_url='https://example.com/item1.jpg', title='this is menu1', text='description1', actions=[ PostbackAction( label='postback1', display_text='postback text1', data='action=buy&itemid=1' ), MessageAction( label='message1', text='message text1' ), URIAction( label='uri1', uri='http://example.com/1' ) ] ), CarouselColumn( thumbnail_image_url='https://example.com/item2.jpg', title='this is menu2', text='description2', actions=[ PostbackAction( label='postback2', display_text='postback text2', data='action=buy&itemid=2' ), MessageAction( label='message2', text='message text2' ), URIAction( label='uri2', uri='http://example.com/2' ) ] ) ] ) )
TemplateSendMessage - ImageCarouselTemplate
image_carousel_template_message = TemplateSendMessage( alt_text='ImageCarousel template', template=ImageCarouselTemplate( columns=[ ImageCarouselColumn( image_url='https://example.com/item1.jpg', action=PostbackAction( label='postback1', display_text='postback text1', data='action=buy&itemid=1' ) ), ImageCarouselColumn( image_url='https://example.com/item2.jpg', action=PostbackAction( label='postback2', display_text='postback text2', data='action=buy&itemid=2' ) ) ] ) )
FlexSendMessage
flex_message = FlexSendMessage( alt_text='hello', contents=BubbleContainer( direction='ltr', hero=ImageComponent( url='https://example.com/cafe.jpg', size='full', aspect_ratio='20:13', aspect_mode='cover', action=URIAction(uri='http://example.com', label='label') ) ) )
※ You can pass a dict to FlexSendMessage#contents as follows:
flex_message = FlexSendMessage( alt_text='hello', contents={ 'type': 'bubble', 'direction': 'ltr', 'hero': { 'type': 'image', 'url': 'https://example.com/cafe.jpg', 'size': 'full', 'aspectRatio': '20:13', 'aspectMode': 'cover', 'action': { 'type': 'uri', 'uri': 'http://example.com', 'label': 'label' } } } )
Thus, You can send a JSON designed with Flex Message Simulator.
With QuickReply
text_message = TextSendMessage(text='Hello, world', quick_reply=QuickReply(items=[ QuickReplyButton(action=MessageAction(label="label", text="text")) ]))
Webhook
WebhookParser
※ You can use WebhookParser
__init__(self, channel_secret)
parser = linebot.WebhookParser('YOUR_CHANNEL_SECRET')
parse(self, body, signature, as_payload=False)
Parses the webhook body, and returns a list of Event objects or a WebhookPayload object (depending on as_payload). If the signature does NOT match, InvalidSignatureError is raised.
events = parser.parse(body, signature) for event in events: do_something(event)
payload = parser.parse(body, signature, as_payload=True) for event in payload.events: do_something(payload.event, payload.destination)
WebhookHandler
※ You can use WebhookHandler
__init__(self, channel_secret)
handler = linebot.WebhookHandler('YOUR_CHANNEL_SECRET')
handle(self, body, signature)
Handles webhooks with handlers added by the decorators add and default. If the signature does NOT match, InvalidSignatureError is raised.
handler.handle(body, signature)
add(self, event, message=None)
Add a handler method by using this decorator.
@handler.add(MessageEvent, message=TextMessage) def handle_message(event): line_bot_api.reply_message( event.reply_token, TextSendMessage(text=event.message.text))
When the event is an instance of MessageEvent and event.message is an instance of TextMessage, this handler method is called.
@handler.add(MessageEvent) def handle_message(event, destination): # do something
If the arity of the handler method is more than one, a destination property in a webhook request is passed to it as the second argument.
@handler.add(FollowEvent) def handle_follow(): # do something
If the arity of the handler method is zero, the handler method is called with no arguments.
default(self)
Set the default handler method by using this decorator.
@handler.default() def default(event): print(event)
If there is no handler for an event, this default handler method is called.
WebhookPayload
https://developers.line.biz/en/reference/messaging-api/#request-body
- WebhookPayload
- destination
- events: list[Event]
Webhook event object
https://developers.line.biz/en/reference/messaging-api/#webhook-event-objects
The following classes are found in the linebot.models package.
Event
- FollowEvent
- type
- mode
- timestamp
- source: Source
- reply_token
- UnfollowEvent
- type
- mode
- timestamp
- source: Source
- JoinEvent
- type
- mode
- timestamp
- source: Source
- reply_token
- LeaveEvent
- type
- mode
- timestamp
- source: Source
- PostbackEvent
- type
- mode
- timestamp
- source: Source
- reply_token
- postback: Postback
- data
- params: dict
- BeaconEvent
- type
- mode
- timestamp
- source: Source
- reply_token
- beacon: Beacon
- type
- hwid
- device_message
- MemberJoinedEvent
- type
- mode
- timestamp
- source: Source
- reply_token
- joined: Joined
- MemberLeftEvent
- type
- mode
- timestamp
- source: Source
- reply_token
- left: Left
- AccountLinkEvent
- type
- mode
- timestamp
- source: Source
- reply_token
- link: Link
- ThingsEvent
- type
- mode
- timestamp
- source: Source
- reply_token
- things: DeviceLink | DeviceUnlink | ScenarioResult
Source
- SourceUser
- type
- user_id
- SourceGroup
- type
- group_id
- user_id
- SourceRoom
- type
- room_id
- user_id
Message
- TextMessage
- type
- id
- text
- ImageMessage
- type
- id
- content_provider
- VideoMessage
- type
- id
- duration
- content_provider
- AudioMessage
- type
- id
- duration
- content_provider
- LocationMessage
- type
- id
- title
- address
- latitude
- longitude
- StickerMessage
- type
- id
- package_id
- sticker_id
- sticker_resource_type
- FileMessage
- type
- id
- file_size
- file_name
Hints
Examples
simple-server-echo
Sample echo-bot using wsgiref.simple_server
flask-echo
Sample echo-bot using Flask
flask-kitchensink
Sample bot using Flask
API documentation
$ cd docs $ make html $ open build/html/index.html
OR
Help and media
FAQ: https://developers.line.biz/en/faq/
Community Q&A: https://www.line-community.me/questions
News: https://developers.line.biz/en/news/
Twitter: @LINE_DEV
Contributing
Please check CONTRIBUTING before making a contribution.
For SDK developers
First install for development.
$ pip install -r requirements-dev.txt
Run tests
Test by using tox. We test against the following versions.
- 3.6
- 3.7
- 3.8
- 3.9
To run all tests and to run flake8 against all versions, use:
tox
To run all tests against version 3.6, use:
$ tox -e py3.6
To run a test against version 3.6 and against a specific file, use:
$ tox -e py3.6 -- tests/test_webhook.py
License
Copyright (C) 2016 LINE Corp. Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
| Filename, size | File type | Python version | Upload date | Hashes |
|---|---|---|---|---|
| Filename, size line_bot_sdk-1.19.0-py2.py3-none-any.whl (68.4 kB) | File type Wheel | Python version py2.py3 | Upload date | Hashes View |
| Filename, size line-bot-sdk-1.19.0.tar.gz (91.0 kB) | File type Source | Python version None | Upload date | Hashes View |
Hashes for line_bot_sdk-1.19.0-py2.py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 41bd5cac4b353d9722173893bd99d88e32fd115a22655ad3b3e2040018a4f81c |
|
| MD5 | 251b182c4049b580f49926ed4c2af7b2 |
|
| BLAKE2-256 | c784eadf865e5cbb53165c7ef564b53b90b4de8b24673638b88dee9847f8cbfc |