line-bot-sdk

SDK of the LINE Messaging API for Python.

About LINE Messaging API

Please refer to the official API documents for details.

Install

$ pip install line-bot-sdk

Synopsis

Usage is:

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:
        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))

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 timeout value at each methods.

reply_message(self, reply_token, messages, timeout=None)

Respond to events from users, groups, and rooms. You can get a reply_token by a Webhook Event Object.

https://devdocs.line.me/en/#reply-message

line_bot_api.reply_message(reply_token, TextSendMessage(text='Hello World!'))

push_message(self, to, messages, timeout=None)

Send messages to users, groups, and rooms at any time.

https://devdocs.line.me/en/#push-message

line_bot_api.push_message(to, TextSendMessage(text='Hello World!'))

get_profile(self, user_id, timeout=None)

Get user profile information.

https://devdocs.line.me/en/#bot-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_message_content(self, message_id, timeout=None)

Retrieve image, video, and audio data sent by users.

https://devdocs.line.me/en/#get-content

message_content = line_bot_api.get_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://devdocs.line.me/en/#leave

line_bot_api.leave_group(group_id)

leave_room(self, room_id, timeout=None)

Leave a room.

https://devdocs.line.me/en/#leave

line_bot_api.leave_room(room_id)

※ Error handle

If LINE API server responses a error, LineBotApi raise LineBotApiError.

https://devdocs.line.me/en/#error-response

try:
    line_bot_api.push_message('to', TextSendMessage(text='Hello World!'))
except linebot.LineBotApiError as e:
    print(e.status_code)
    print(e.error.message)
    print(e.error.details)

Send message object

https://devdocs.line.me/en/#send-message-object

These following class in 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),
    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 - ButtonsTemplate

buttons_template_message = TemplateSendMessage(
    alt_text='Buttons template',
    template=ButtonsTemplate(
        thumbnail_image_url='https://example.com/image.jpg',
        title='Menu',
        text='Please select',
        actions=[
            PostbackTemplateAction(
                label='postback',
                text='postback text',
                data='action=buy&itemid=1'
            ),
            MessageTemplateAction(
                label='message',
                text='message text'
            ),
            URITemplateAction(
                label='uri',
                uri='http://example.com/'
            )
        ]
    )
)

TemplateSendMessage - ConfirmTemplate

confirm_template_message = TemplateSendMessage(
    alt_text='Confirm template',
    template=ConfirmTemplate(
        text='Are you sure?',
        actions=[
            PostbackTemplateAction(
                label='postback',
                text='postback text',
                data='action=buy&itemid=1'
            ),
            MessageTemplateAction(
                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=[
                    PostbackTemplateAction(
                        label='postback1',
                        text='postback text1',
                        data='action=buy&itemid=1'
                    ),
                    MessageTemplateAction(
                        label='message1',
                        text='message text1'
                    ),
                    URITemplateAction(
                        label='uri1',
                        uri='http://example.com/1'
                    )
                ]
            ),
            CarouselColumn(
                thumbnail_image_url='https://example.com/item2.jpg'
                title='this is menu2',
                text='description2',
                actions=[
                    PostbackTemplateAction(
                        label='postback2',
                        text='postback text2',
                        data='action=buy&itemid=2'
                    ),
                    MessageTemplateAction(
                        label='message2',
                        text='message text2'
                    ),
                    URITemplateAction(
                        label='uri2',
                        uri='http://example.com/2'
                    )
                ]
            )
        ]
    )
)

Webhook

WebhookParser

※ You can use WebhookParser or WebhookHandler

init(self, channel_secret)

parser = linebot.WebhookParser('YOUR_CHANNEL_SECRET')

parse(self, body, signature)

Parse webhook body and build Event Objects List. If signature does NOT match, raise InvalidSignatureError.

events = parser.parse(body, signature)

for event in events:
    # Do something

WebhookHandler

※ You can use WebhookParser or WebhookHandler

init(self, channel_secret)

handler = linebot.WebhookHandler('YOUR_CHANNEL_SECRET')

handle(self, body, signature)

Handle webhook. If signature does NOT match, raise InvalidSignatureError.

handler.handle(body, signature)

Add handler method

You can add handler method by using add decorator.

add(self, event, message=None)

@handler.add(MessageEvent, message=TextMessage)
def handle_message(event):
    line_bot_api.reply_message(
        event.reply_token,
        TextSendMessage(text=event.message.text))

When event is instance of MessageEvent and event.message is instance of TextMessage, this handler method is called.

Set default handler method

You can set default handler method by using default decorator.

default(self)

@handler.default()
def default(event):
    print(event)

There is no handler for event, this default handler method is called.

Webhook event object

https://devdocs.line.me/en/#webhooks

These following class in linebot.models package.

Event

MessageEvent
- type
- timestamp
- source: Source
- reply_token
- message: Message
FollowEvent
- type
- timestamp
- source: Source
- reply_token
UnfollowEvent
- type
- timestamp
- source: Source
JoinEvent
- type
- timestamp
- source: Source
- reply_token
LeaveEvent
- type
- timestamp
- source: Source
PostbackEvent
- type
- timestamp
- source: Source
- reply_token
- postback: Postback
  
  data
BeaconEvent
- type
- timestamp
- source: Source
- reply_token
- beacon: Beacon
  
  type
  
  hwid

Source

SourceUser
- type
- user_id
SourceGroup
- type
- group_id
SourceRoom
- type
- room_id

Message

TextMessage
- type
- id
- text
ImageMessage
- type
- id
VideoMessage
- type
- id
AudioMessage
- type
- id
LocationMessage
- type
- id
- title
- address
- latitude
- longitude
StickerMessage
- type
- id
- package_id
- sticker_id

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 document

$ cd docs
$ make html
$ open build/html/index.html

Requirements

python >= 2.7 or >= 3.3

For SDK developers

First install for development.

$ pip install -r requirements-dev.txt

Run tests

We test by using tox. We test the following versions.

If you want to run all tests and run flake8 against all versions:

tox

If you want to run all tests against 2.7 version:

$ tox -e py27

If you want to run a test against 2.7 version and against specific file:

$ tox -e py27 -- tests/test_webhook.py

And more… TBD

Metadata

Release files for line-bot-sdk 1.0.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for line-bot-sdk 1.0.0
File	Size	Uploaded
line-bot-sdk-1.0.0.tar.gz	39.1 kB	Oct 14, 2016	Details

Built distribution (wheel)

Table of built distributions (wheels) for line-bot-sdk 1.0.0
File	Interpreter	ABI	Platform	Reset
line_bot_sdk-1.0.0-py2.py3-none-any.whl 31.1 kB Oct 14, 2016	Python 3, Python 2	none	any	Details

Total release size: 70.2 kB

Release files / line-bot-sdk-1.0.0.tar.gz

Download URL	line-bot-sdk-1.0.0.tar.gz
Size	39.1 kB
Tags	Source
SHA-256 checksum How to use checksums	`22e41fcd94d9784b64b81360fa42223c36968b99b69c902805b1be1560ea17b1`
BLAKE2b-256 checksum How to use checksums	`21fa1f59f20f0e9ab17633f12c1d5d52d73a0c1cff49a1138bdfcdbd49e1a7bc`
Upload date	Oct 14, 2016
Uploaded using Trusted Publishing? What is trusted publishing?	No

Release files / line_bot_sdk-1.0.0-py2.py3-none-any.whl

Download URL	line_bot_sdk-1.0.0-py2.py3-none-any.whl
Size	31.1 kB
Tags	Python 2 Python 3
SHA-256 checksum How to use checksums	`b0252ee3719e97f81648ee3b5d73bc4d2bf4aea33d55495bdd8c31dd4cb51c8d`
BLAKE2b-256 checksum How to use checksums	`7e53028e9693a4d00109520156c0c7abda785e92508d0f23b5559895fed140c0`
Upload date	Oct 14, 2016
Uploaded using Trusted Publishing? What is trusted publishing?	No