The LINE Messaging API SDK for Ruby makes it easy to develop bots using LINE Messaging API, and you can create a sample bot within minutes.
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/
Also, generated documentation by YARD is available.
This library requires Ruby 3.2 or later.
Add this line to your application's Gemfile:
gem'line-bot-api'And then execute:
bundleOr install it yourself as:
gem install line-bot-apiWe provide examples to help you get started with the SDK. They work in your local environment if you have owned your bot account.
Go the examples directory for more examples.
This library provides RBS files for type checking.
You can code with type support in the corresponding IDE or editor.
# app.rbrequire'sinatra'require'line-bot-api'set:environment,:productiondefclient@client ||= Line::Bot::V2::MessagingApi::ApiClient.new(channel_access_token: ENV.fetch("LINE_CHANNEL_ACCESS_TOKEN"))enddefblob_client@blob_client ||= Line::Bot::V2::MessagingApi::ApiBlobClient.new(channel_access_token: ENV.fetch("LINE_CHANNEL_ACCESS_TOKEN"))enddefparser@parser ||= Line::Bot::V2::WebhookParser.new(channel_secret: ENV.fetch("LINE_CHANNEL_SECRET"))endpost'/callback'dobody=request.body.readsignature=request.env['HTTP_X_LINE_SIGNATURE']beginevents=parser.parse(body: body,signature: signature)rescueLine::Bot::V2::WebhookParser::InvalidSignatureErrorhalt400,{'Content-Type'=>'text/plain'},'Bad Request'endevents.eachdo |event|
caseeventwhenLine::Bot::V2::Webhook::MessageEventcaseevent.messagewhenLine::Bot::V2::Webhook::TextMessageContentcaseevent.message.textwhen'profile'ifevent.source.type == 'user'profile_response=client.get_profile(user_id: event.source.user_id)reply_text(event,"Display name: #{profile_response.display_name}\nStatus message: #{profile_response.status_message}")elsereply_text(event,"Bot can't use profile API without user ID")endelserequest=Line::Bot::V2::MessagingApi::ReplyMessageRequest.new(reply_token: event.reply_token,messages: [Line::Bot::V2::MessagingApi::TextMessage.new(text: "[ECHO] #{event.message.text}")])client.reply_message(reply_message_request: request)endwhenLine::Bot::V2::Webhook::ImageMessageContent,Line::Bot::V2::Webhook::VideoMessageContentresponse=blob_client.get_message_content(message_id: event.message.message_id)tf=Tempfile.open("content")tf.write(response)endendend# Don't forget to return a successful response"OK"endYou may use this classes to use LINE Messaging API features.
You may need to store the x-line-request-id header obtained as a response from several APIs.
In this case, please use *_with_http_info methods. You can get headers and status codes.
The x-line-accepted-request-id or content-type header can also be obtained in the same way. Note header name must be lowercase.
push_request=Line::Bot::V2::MessagingApi::PushMessageRequest.new(to: event.source.user_id,messages: [Line::Bot::V2::MessagingApi::TextMessage.new(text: "[^Request ID] #{headers['x-line-request-id']}")])_body,_status_code,headers=client.push_message_with_http_info(push_message_request: push_request)putsheaders['x-line-request-id']putsheaders['x-line-accepted-request-id']putsheaders['content-type']If an API call fails, the SDK does not generate an Error in Ruby; use the status code for proper error handling. Error details are stored in body.
require'json'require'line-bot-api'defclient@client ||= Line::Bot::V2::MessagingApi::ApiClient.new(channel_access_token: ENV.fetch("LINE_CHANNEL_ACCESS_TOKEN"),)enddefmaindummy_message=Line::Bot::V2::MessagingApi::TextMessage.new(text: "Hello, world!",)valid_request=Line::Bot::V2::MessagingApi::ValidateMessageRequest.new(messages: [dummy_message,dummy_message,dummy_message,dummy_message,dummy_message],)body,status_code,_headers=client.validate_push_with_http_info(validate_message_request: valid_request)handle_response(body,status_code)invalid_request=Line::Bot::V2::MessagingApi::ValidateMessageRequest.new(messages: [dummy_message,dummy_message,dummy_message,dummy_message,dummy_message,dummy_message],)body,status_code,_headers=client.validate_push_with_http_info(validate_message_request: invalid_request)handle_response(body,status_code)enddefhandle_response(body,status_code)casestatus_codewhen200puts"Valid"when400..499puts"Invalid: #{JSON.parse(body)}"elseputs"Other Status: #{status_code}"endendmainYou can use Hash instead of the SDK classes. So you can also use Hash parsed from JSON as a parameter.
This is useful, for example, in migrating from v1 or building Flex Message.
But this is not recommended because you lose type checking by RBS.
client=Line::Bot::V2::MessagingApi::ApiClient.new(channel_access_token: ENV.fetch("LINE_CHANNEL_ACCESS_TOKEN"),)request={to: "U4af4980629...",messages: [{type: "flex",alt_text: "This is a Flex Message",contents: {type: "bubble",body: {type: "box",layout: "horizontal",contents: [{type: "text",text: "Hello"}]}}}]}client.push_message(push_message_request: request)# orrequest=JSON.parse(<<~JSON { "to": "U4af4980629...", "messages": [ { "type": "flex", "alt_text": "This is a Flex Message", "contents": { "type": "bubble", "body": { "type": "box", "layout": "horizontal", "contents": [ { "type": "text", "text": "Hello" } ] } } } ] } JSON)client.push_message(push_message_request: request)You can convert Hash / JSON to SDK classes using #create method.
json=<<~JSON { "to": "U4af4980629...", "messages": [ { "type": "flex", "alt_text": "This is a Flex Message", "contents": { "type": "bubble", "body": { "type": "box", "layout": "horizontal", "contents": [ { "type": "text", "text": "Hello" } ] } } } ] }JSONrequest=Line::Bot::V2::MessagingApi::PushMessageRequest.create(JSON.parse(json))This project respects semantic versioning.
However, if a feature that was publicly released is discontinued for business reasons and becomes completely unusable, we will release changes as a patch release.
v1 and v2 are completely different implementations. Migration to v2 is strongly recommended. Please refer to Migration guide for migration procedure.
News: https://developers.line.biz/en/news/
Please check CONTRIBUTING before making a contribution.
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.