Class: Line::Bot::Client
- Inherits:
-
Object
- Object
- Line::Bot::Client
- Defined in:
- lib/line/bot/client.rb
Overview
API Client of LINE Bot SDK Ruby
@client ||= Line::Bot::Client.new do |config|
config.channel_id = ENV["LINE_CHANNEL_ID"]
config.channel_secret = ENV["LINE_CHANNEL_SECRET"]
config.channel_token = ENV["LINE_CHANNEL_TOKEN"]
end
Instance Attribute Summary collapse
-
#blob_endpoint ⇒ Object
@return [String].
-
#channel_id ⇒ Object
@return [String].
-
#channel_secret ⇒ Object
@return [String].
-
#channel_token ⇒ Object
@return [String].
-
#endpoint ⇒ Object
@return [String].
- #http_options ⇒ Hash
- #httpclient ⇒ Object
Instance Method Summary collapse
-
#broadcast(messages, headers: {}) ⇒ Net::HTTPResponse
Send messages to all friends.
-
#bulk_link_rich_menus(user_ids, rich_menu_id) ⇒ Net::HTTPResponse
To link a rich menu to multiple users at a time.
-
#bulk_unlink_rich_menus(user_ids) ⇒ Net::HTTPResponse
To unlink a rich menu from multiple users at a time.
-
#create_click_audience(params) ⇒ Net::HTTPResponse
Create an audience group of users that clicked a URL in a message sent in the past.
-
#create_impression_audience(params) ⇒ Net::HTTPResponse
Create an audience group of users that opened a message sent in the past.
- #create_liff_app(app) ⇒ Object
-
#create_link_token(user_id) ⇒ Net::HTTPResponse
Issue a link token to a user.
-
#create_rich_menu(rich_menu) ⇒ Net::HTTPResponse
Create a rich menu.
-
#create_rich_menu_image(rich_menu_id, file) ⇒ Net::HTTPResponse
Upload and attaches an image to a rich menu.
-
#create_user_id_audience(params) ⇒ Net::HTTPResponse
Create an audience group by uploading user_ids.
- #credentials ⇒ Hash
-
#delete(endpoint_base, endpoint_path, headers = {}) ⇒ Net::HTTPResponse
Delete content of specified URL.
-
#delete_audience(audience_group_id) ⇒ Net::HTTPResponse
Delete an existing audience group.
- #delete_liff_app(liff_id) ⇒ Object
-
#delete_rich_menu(rich_menu_id) ⇒ Net::HTTPResponse
Delete a rich menu.
-
#get(endpoint_base, endpoint_path, headers = {}) ⇒ Net::HTTPResponse
Fetch data, get content of specified URL.
-
#get_aggregation_info ⇒ Net::HTTPResponse
Get the number of aggregation units used this month.
-
#get_aggregation_list(limit: nil, start: nil) ⇒ Net::HTTPResponse
Get the name list of units used this month for statistics aggregation.
-
#get_audience(audience_group_id) ⇒ Net::HTTPResponse
Get audience group data.
-
#get_audience_authority_level ⇒ Net::HTTPResponse
Get the authority level of the audience.
-
#get_audiences(params) ⇒ Net::HTTPResponse
Get data for more than one audience group.
-
#get_bot_info ⇒ Net::HTTPResponse
Gets a bot’s basic information.
-
#get_channel_access_token_key_ids_jwt(jwt) ⇒ Net::HTTPResponse
Get all valid channel access token key IDs v2.1.
-
#get_default_rich_menu ⇒ Net::HTTPResponse
Get default rich menu.
-
#get_follower_ids(deprecated_continuation_token = nil, start: nil, limit: nil) ⇒ Net::HTTPResponse
Get user IDs of who added your LINE Official Account as a friend.
-
#get_friend_demographics ⇒ Net::HTTPResponse
Get the demographic attributes for a bot’s friends.
-
#get_group_member_ids(group_id, continuation_token = nil) ⇒ Net::HTTPResponse
Get user IDs of a group.
-
#get_group_member_profile(group_id, user_id) ⇒ Net::HTTPResponse
Get an user’s profile of a group.
-
#get_group_members_count(group_id) ⇒ Net::HTTPResponse
Gets the user IDs of the members of a group that the bot is in.
-
#get_group_summary(group_id) ⇒ Net::HTTPResponse
Gets the group ID, group name, and group icon URL of a group where the LINE Official Account is a member.
- #get_liff_apps ⇒ Object
-
#get_message_content(identifier) ⇒ Net::HTTPResponse
Get message content.
-
#get_message_delivery_broadcast(date) ⇒ Net::HTTPResponse
Gets the number of messages sent with the /bot/message/multicast endpoint.
-
#get_message_delivery_multicast(date) ⇒ Net::HTTPResponse
Gets the number of messages sent with the /bot/message/multicast endpoint.
-
#get_message_delivery_push(date) ⇒ Net::HTTPResponse
Gets the number of messages sent with the /bot/message/push endpoint.
-
#get_message_delivery_reply(date) ⇒ Net::HTTPResponse
Gets the number of messages sent with the /bot/message/reply endpoint.
-
#get_number_of_followers(date) ⇒ Net::HTTPResponse
Returns the number of followers.
-
#get_number_of_message_deliveries(date) ⇒ Net::HTTPResponse
Returns the number of messages sent on a specified day.
-
#get_profile(user_id) ⇒ Net::HTTPResponse
Get an user’s profile.
-
#get_profile_by_access_token(access_token) ⇒ Net::HTTPResponse
Get user profile by access token.
-
#get_quota ⇒ Net::HTTPResponse
Get the target limit for additional messages.
-
#get_quota_consumption ⇒ Net::HTTPResponse
Get number of messages sent this month.
-
#get_rich_menu(rich_menu_id) ⇒ Net::HTTPResponse
Get a rich menu via a rich menu ID.
-
#get_rich_menu_image(rich_menu_id) ⇒ Net::HTTPResponse
Download an image associated with a rich menu.
-
#get_rich_menus ⇒ Net::HTTPResponse
Get a list of all uploaded rich menus.
-
#get_rich_menus_alias(rich_menu_alias_id) ⇒ Net::HTTPResponse
Get a rich menu alias via a rich menu alias ID.
-
#get_rich_menus_alias_list ⇒ Net::HTTPResponse
Get a list of all uploaded rich menus alias.
-
#get_room_member_ids(room_id, continuation_token = nil) ⇒ Net::HTTPResponse
Get user IDs of a room.
-
#get_room_member_profile(room_id, user_id) ⇒ Net::HTTPResponse
Get an user’s profile of a room.
-
#get_room_members_count(room_id) ⇒ Net::HTTPResponse
Gets the count of members in a room.
-
#get_statistics_per_unit(unit:, from:, to:) ⇒ Net::HTTPResponse
Get the per-unit statistics of how users interact with push messages and multicast messages.
-
#get_user_interaction_statistics(request_id) ⇒ Net::HTTPResponse
Returns statistics about how users interact with narrowcast messages or broadcast messages sent from your LINE Official Account.
-
#get_user_rich_menu(user_id) ⇒ Net::HTTPResponse
Get the ID of the rich menu linked to a user.
-
#get_webhook_endpoint ⇒ Net::HTTPResponse
Gets information on a webhook endpoint.
-
#initialize(options = {}) {|_self| ... } ⇒ Line::Bot::Client
constructor
Initialize a new client.
-
#issue_channel_access_token_jwt(jwt) ⇒ Net::HTTPResponse
Issue channel access token v2.1.
-
#issue_channel_token(grant_type = 'client_credentials') ⇒ Net::HTTPResponse
Issue channel access token.
- #leave_group(group_id) ⇒ Object
- #leave_room(room_id) ⇒ Object
- #liff_endpoint ⇒ Object
-
#link_user_rich_menu(user_id, rich_menu_id) ⇒ Net::HTTPResponse
Link a rich menu to a user.
-
#multicast(to, messages, headers: {}, payload: {}) ⇒ Net::HTTPResponse
Send messages to multiple users using userIds.
-
#narrowcast(messages, recipient: nil, filter: nil, limit: nil, headers: {}) ⇒ Net::HTTPResponse
Narrowcast messages to users.
- #oauth_endpoint ⇒ Object
-
#parse_events_from(request_body) ⇒ Array<Line::Bot::Event::Class>
Parse events from request.body.
-
#post(endpoint_base, endpoint_path, payload = nil, headers = {}) ⇒ Net::HTTPResponse
Post data, get content of specified URL.
-
#push_message(user_id, messages, headers: {}, payload: {}) ⇒ Net::HTTPResponse
Push messages to a user using user_id.
-
#put(endpoint_base, endpoint_path, payload = nil, headers = {}) ⇒ Net::HTTPResponse
Put data, get content of specified URL.
-
#rename_audience(audience_group_id, description) ⇒ Net::HTTPResponse
Rename an existing audience group.
-
#reply_message(token, messages) ⇒ Net::HTTPResponse
Reply messages to a user using replyToken.
-
#revoke_channel_access_token_jwt(access_token) ⇒ Net::HTTPResponse
Revoke channel access token v2.1.
-
#revoke_channel_token(access_token) ⇒ Net::HTTPResponse
Revoke channel access token.
-
#set_default_rich_menu(rich_menu_id) ⇒ Net::HTTPResponse
Set default rich menu (Link a rich menu to all user).
-
#set_rich_menus_alias(rich_menu_id, rich_menu_alias_id) ⇒ Net::HTTPResponse
Set rich menu alias.
-
#set_webhook_endpoint(webhook_endpoint) ⇒ Net::HTTPResponse
Sets the webhook endpoint URL.
-
#test_webhook_endpoint(webhook_endpoint = nil) ⇒ Net::HTTPResponse
Checks if the configured webhook endpoint can receive a test webhook event.
-
#unlink_user_rich_menu(user_id) ⇒ Net::HTTPResponse
Unlink a rich menu from a user.
-
#unset_default_rich_menu ⇒ Net::HTTPResponse
Unset default rich menu (Unlink a rich menu from all user).
-
#unset_rich_menus_alias(rich_menu_alias_id) ⇒ Net::HTTPResponse
Unset rich menu alias.
-
#update_audience_authority_level(authority_level) ⇒ Net::HTTPResponse
Change the authority level of the audience.
- #update_liff_app(liff_id, app) ⇒ Object
-
#update_rich_menus_alias(rich_menu_id, rich_menu_alias_id) ⇒ Net::HTTPResponse
Update rich menu alias.
-
#update_user_id_audience(params) ⇒ Net::HTTPResponse
Update an audience group.
-
#validate_signature(content, channel_signature) ⇒ Boolean
Validate signature of a webhook event.
-
#verify_access_token(access_token) ⇒ Net::HTTPResponse
Verify access token v2.1.
-
#verify_id_token(id_token, nonce: nil, user_id: nil) ⇒ Net::HTTPResponse
Verify ID token.
Constructor Details
#initialize(options = {}) {|_self| ... } ⇒ Line::Bot::Client
Initialize a new client.
43 44 45 46 47 48 |
# File 'lib/line/bot/client.rb', line 43 def initialize( = {}) .each do |key, value| instance_variable_set("@#{key}", value) end yield(self) if block_given? end |
Instance Attribute Details
#blob_endpoint ⇒ Object
@return [String]
31 32 33 |
# File 'lib/line/bot/client.rb', line 31 def blob_endpoint @blob_endpoint end |
#channel_id ⇒ Object
@return [String]
31 32 33 |
# File 'lib/line/bot/client.rb', line 31 def channel_id @channel_id end |
#channel_secret ⇒ Object
@return [String]
31 32 33 |
# File 'lib/line/bot/client.rb', line 31 def channel_secret @channel_secret end |
#channel_token ⇒ Object
@return [String]
31 32 33 |
# File 'lib/line/bot/client.rb', line 31 def channel_token @channel_token end |
#endpoint ⇒ Object
@return [String]
31 32 33 |
# File 'lib/line/bot/client.rb', line 31 def endpoint @endpoint end |
#http_options ⇒ Hash
37 38 39 |
# File 'lib/line/bot/client.rb', line 37 def end |
#httpclient ⇒ Object
34 35 36 |
# File 'lib/line/bot/client.rb', line 34 def httpclient @httpclient end |
Instance Method Details
#broadcast(messages, headers: {}) ⇒ Net::HTTPResponse
Send messages to all friends.
282 283 284 285 286 287 288 289 290 |
# File 'lib/line/bot/client.rb', line 282 def broadcast(, headers: {}) channel_token_required = [] if .is_a?(Hash) endpoint_path = '/bot/message/broadcast' payload = { messages: }.to_json post(endpoint, endpoint_path, payload, credentials.merge(headers)) end |
#bulk_link_rich_menus(user_ids, rich_menu_id) ⇒ Net::HTTPResponse
To link a rich menu to multiple users at a time
700 701 702 703 704 705 |
# File 'lib/line/bot/client.rb', line 700 def (user_ids, ) channel_token_required endpoint_path = "/bot/richmenu/bulk/link" post(endpoint, endpoint_path, { richMenuId: , userIds: user_ids }.to_json, credentials) end |
#bulk_unlink_rich_menus(user_ids) ⇒ Net::HTTPResponse
To unlink a rich menu from multiple users at a time
712 713 714 715 716 717 |
# File 'lib/line/bot/client.rb', line 712 def (user_ids) channel_token_required endpoint_path = "/bot/richmenu/bulk/unlink" post(endpoint, endpoint_path, { userIds: user_ids }.to_json, credentials) end |
#create_click_audience(params) ⇒ Net::HTTPResponse
Create an audience group of users that clicked a URL in a message sent in the past
Parameters are described here. developers.line.biz/en/reference/messaging-api/#create-click-audience-group
939 940 941 942 943 944 |
# File 'lib/line/bot/client.rb', line 939 def create_click_audience(params) channel_token_required endpoint_path = '/bot/audienceGroup/click' post(endpoint, endpoint_path, params.to_json, credentials) end |
#create_impression_audience(params) ⇒ Net::HTTPResponse
Create an audience group of users that opened a message sent in the past
Parameters are described here. developers.line.biz/en/reference/messaging-api/#create-imp-audience-group
954 955 956 957 958 959 |
# File 'lib/line/bot/client.rb', line 954 def create_impression_audience(params) channel_token_required endpoint_path = '/bot/audienceGroup/imp' post(endpoint, endpoint_path, params.to_json, credentials) end |
#create_liff_app(app) ⇒ Object
880 881 882 883 884 885 |
# File 'lib/line/bot/client.rb', line 880 def create_liff_app(app) channel_token_required endpoint_path = '/apps' post(liff_endpoint, endpoint_path, app.to_json, credentials) end |
#create_link_token(user_id) ⇒ Net::HTTPResponse
Issue a link token to a user
750 751 752 753 754 755 |
# File 'lib/line/bot/client.rb', line 750 def create_link_token(user_id) channel_token_required endpoint_path = "/bot/user/#{user_id}/linkToken" post(endpoint, endpoint_path, nil, credentials) end |
#create_rich_menu(rich_menu) ⇒ Net::HTTPResponse
Create a rich menu
543 544 545 546 547 548 |
# File 'lib/line/bot/client.rb', line 543 def () channel_token_required endpoint_path = '/bot/richmenu' post(endpoint, endpoint_path, .to_json, credentials) end |
#create_rich_menu_image(rich_menu_id, file) ⇒ Net::HTTPResponse
Upload and attaches an image to a rich menu
737 738 739 740 741 742 743 |
# File 'lib/line/bot/client.rb', line 737 def (, file) channel_token_required endpoint_path = "/bot/richmenu/#{rich_menu_id}/content" headers = credentials.merge('Content-Type' => content_type(file)) post(blob_endpoint, endpoint_path, file.rewind && file.read, headers) end |
#create_user_id_audience(params) ⇒ Net::HTTPResponse
Create an audience group by uploading user_ids
Parameters are described here. developers.line.biz/en/reference/messaging-api/#create-upload-audience-group
909 910 911 912 913 914 |
# File 'lib/line/bot/client.rb', line 909 def create_user_id_audience(params) channel_token_required endpoint_path = '/bot/audienceGroup/upload' post(endpoint, endpoint_path, params.to_json, credentials) end |
#credentials ⇒ Hash
78 79 80 81 82 |
# File 'lib/line/bot/client.rb', line 78 def credentials { "Authorization" => "Bearer #{channel_token}", } end |
#delete(endpoint_base, endpoint_path, headers = {}) ⇒ Net::HTTPResponse
Delete content of specified URL.
1133 1134 1135 1136 |
# File 'lib/line/bot/client.rb', line 1133 def delete(endpoint_base, endpoint_path, headers = {}) headers = API::DEFAULT_HEADERS.merge(headers) httpclient.delete(endpoint_base + endpoint_path, headers) end |
#delete_audience(audience_group_id) ⇒ Net::HTTPResponse
Delete an existing audience group
Parameters are described here. developers.line.biz/en/reference/messaging-api/#delete-audience-group
983 984 985 986 987 988 |
# File 'lib/line/bot/client.rb', line 983 def delete_audience(audience_group_id) channel_token_required endpoint_path = "/bot/audienceGroup/#{audience_group_id}" delete(endpoint, endpoint_path, credentials) end |
#delete_liff_app(liff_id) ⇒ Object
894 895 896 897 898 899 |
# File 'lib/line/bot/client.rb', line 894 def delete_liff_app(liff_id) channel_token_required endpoint_path = "/apps/#{liff_id}" delete(liff_endpoint, endpoint_path, credentials) end |
#delete_rich_menu(rich_menu_id) ⇒ Net::HTTPResponse
Delete a rich menu
555 556 557 558 559 560 |
# File 'lib/line/bot/client.rb', line 555 def () channel_token_required endpoint_path = "/bot/richmenu/#{rich_menu_id}" delete(endpoint, endpoint_path, credentials) end |
#get(endpoint_base, endpoint_path, headers = {}) ⇒ Net::HTTPResponse
Fetch data, get content of specified URL.
1095 1096 1097 1098 |
# File 'lib/line/bot/client.rb', line 1095 def get(endpoint_base, endpoint_path, headers = {}) headers = API::DEFAULT_HEADERS.merge(headers) httpclient.get(endpoint_base + endpoint_path, headers) end |
#get_aggregation_info ⇒ Net::HTTPResponse
Get the number of aggregation units used this month.
1067 1068 1069 1070 1071 1072 |
# File 'lib/line/bot/client.rb', line 1067 def get_aggregation_info channel_token_required endpoint_path = "/bot/message/aggregation/info" get(endpoint, endpoint_path, credentials) end |
#get_aggregation_list(limit: nil, start: nil) ⇒ Net::HTTPResponse
Get the name list of units used this month for statistics aggregation.
1080 1081 1082 1083 1084 1085 1086 |
# File 'lib/line/bot/client.rb', line 1080 def get_aggregation_list(limit: nil, start: nil) channel_token_required params = {limit: limit, start: start}.compact endpoint_path = "/bot/message/aggregation/list?" + URI.encode_www_form(params) get(endpoint, endpoint_path, credentials) end |
#get_audience(audience_group_id) ⇒ Net::HTTPResponse
Get audience group data
Parameters are described here. developers.line.biz/en/reference/messaging-api/#get-audience-group
998 999 1000 1001 1002 1003 |
# File 'lib/line/bot/client.rb', line 998 def get_audience(audience_group_id) channel_token_required endpoint_path = "/bot/audienceGroup/#{audience_group_id}" get(endpoint, endpoint_path, credentials) end |
#get_audience_authority_level ⇒ Net::HTTPResponse
Get the authority level of the audience
Parameters are described here. developers.line.biz/en/reference/messaging-api/#get-authority-level
1026 1027 1028 1029 1030 1031 |
# File 'lib/line/bot/client.rb', line 1026 def channel_token_required endpoint_path = "/bot/audienceGroup/authorityLevel" get(endpoint, endpoint_path, credentials) end |
#get_audiences(params) ⇒ Net::HTTPResponse
Get data for more than one audience group
Parameters are described here. developers.line.biz/en/reference/messaging-api/#get-audience-groups
1013 1014 1015 1016 1017 1018 |
# File 'lib/line/bot/client.rb', line 1013 def get_audiences(params) channel_token_required endpoint_path = "/bot/audienceGroup/list?" + URI.encode_www_form(params) get(endpoint, endpoint_path, credentials) end |
#get_bot_info ⇒ Net::HTTPResponse
Gets a bot’s basic information.
826 827 828 829 830 831 |
# File 'lib/line/bot/client.rb', line 826 def get_bot_info channel_token_required endpoint_path = '/bot/info' get(endpoint, endpoint_path, credentials) end |
#get_channel_access_token_key_ids_jwt(jwt) ⇒ Net::HTTPResponse
Get all valid channel access token key IDs v2.1
187 188 189 190 191 192 193 194 195 196 |
# File 'lib/line/bot/client.rb', line 187 def get_channel_access_token_key_ids_jwt(jwt) payload = URI.encode_www_form( client_assertion_type: 'urn:ietf:params:oauth:client-assertion-type:jwt-bearer', client_assertion: jwt ) endpoint_path = "/oauth2/v2.1/tokens/kid?#{payload}" headers = { 'Content-Type' => 'application/x-www-form-urlencoded' } get(oauth_endpoint, endpoint_path, headers) end |
#get_default_rich_menu ⇒ Net::HTTPResponse
Get default rich menu
577 578 579 580 581 582 |
# File 'lib/line/bot/client.rb', line 577 def channel_token_required endpoint_path = '/bot/user/all/richmenu' get(endpoint, endpoint_path, credentials) end |
#get_follower_ids(deprecated_continuation_token = nil, start: nil, limit: nil) ⇒ Net::HTTPResponse
Get user IDs of who added your LINE Official Account as a friend
387 388 389 390 391 392 393 394 395 396 397 398 399 400 |
# File 'lib/line/bot/client.rb', line 387 def get_follower_ids(deprecated_continuation_token = nil, start: nil, limit: nil) channel_token_required if deprecated_continuation_token warn "continuation_token as the first argument is deprecated. Please use :start instead." start = deprecated_continuation_token end params = { start: start, limit: limit }.compact endpoint_path = "/bot/followers/ids" endpoint_path += "?" + URI.encode_www_form(params) unless params.empty? get(endpoint, endpoint_path, credentials) end |
#get_friend_demographics ⇒ Net::HTTPResponse
Get the demographic attributes for a bot’s friends.
816 817 818 819 820 821 |
# File 'lib/line/bot/client.rb', line 816 def get_friend_demographics channel_token_required endpoint_path = '/bot/insight/demographic' get(endpoint, endpoint_path, credentials) end |
#get_group_member_ids(group_id, continuation_token = nil) ⇒ Net::HTTPResponse
Get user IDs of a group
409 410 411 412 413 414 415 |
# File 'lib/line/bot/client.rb', line 409 def get_group_member_ids(group_id, continuation_token = nil) channel_token_required endpoint_path = "/bot/group/#{group_id}/members/ids" endpoint_path += "?start=#{continuation_token}" if continuation_token get(endpoint, endpoint_path, credentials) end |
#get_group_member_profile(group_id, user_id) ⇒ Net::HTTPResponse
Get an user’s profile of a group.
361 362 363 364 365 366 |
# File 'lib/line/bot/client.rb', line 361 def get_group_member_profile(group_id, user_id) channel_token_required endpoint_path = "/bot/group/#{group_id}/member/#{user_id}" get(endpoint, endpoint_path, credentials) end |
#get_group_members_count(group_id) ⇒ Net::HTTPResponse
Gets the user IDs of the members of a group that the bot is in.
449 450 451 452 453 454 |
# File 'lib/line/bot/client.rb', line 449 def get_group_members_count(group_id) channel_token_required endpoint_path = "/bot/group/#{group_id}/members/count" get(endpoint, endpoint_path, credentials) end |
#get_group_summary(group_id) ⇒ Net::HTTPResponse
Gets the group ID, group name, and group icon URL of a group where the LINE Official Account is a member.
437 438 439 440 441 442 |
# File 'lib/line/bot/client.rb', line 437 def get_group_summary(group_id) channel_token_required endpoint_path = "/bot/group/#{group_id}/summary" get(endpoint, endpoint_path, credentials) end |
#get_liff_apps ⇒ Object
873 874 875 876 877 878 |
# File 'lib/line/bot/client.rb', line 873 def get_liff_apps channel_token_required endpoint_path = '/apps' get(liff_endpoint, endpoint_path, credentials) end |
#get_message_content(identifier) ⇒ Net::HTTPResponse
Get message content.
337 338 339 340 341 342 |
# File 'lib/line/bot/client.rb', line 337 def (identifier) channel_token_required endpoint_path = "/bot/message/#{identifier}/content" get(blob_endpoint, endpoint_path, credentials) end |
#get_message_delivery_broadcast(date) ⇒ Net::HTTPResponse
Gets the number of messages sent with the /bot/message/multicast endpoint.
531 532 533 534 535 536 |
# File 'lib/line/bot/client.rb', line 531 def (date) channel_token_required endpoint_path = "/bot/message/delivery/broadcast?date=#{date}" get(endpoint, endpoint_path, credentials) end |
#get_message_delivery_multicast(date) ⇒ Net::HTTPResponse
Gets the number of messages sent with the /bot/message/multicast endpoint.
519 520 521 522 523 524 |
# File 'lib/line/bot/client.rb', line 519 def (date) channel_token_required endpoint_path = "/bot/message/delivery/multicast?date=#{date}" get(endpoint, endpoint_path, credentials) end |
#get_message_delivery_push(date) ⇒ Net::HTTPResponse
Gets the number of messages sent with the /bot/message/push endpoint.
507 508 509 510 511 512 |
# File 'lib/line/bot/client.rb', line 507 def (date) channel_token_required endpoint_path = "/bot/message/delivery/push?date=#{date}" get(endpoint, endpoint_path, credentials) end |
#get_message_delivery_reply(date) ⇒ Net::HTTPResponse
Gets the number of messages sent with the /bot/message/reply endpoint.
495 496 497 498 499 500 |
# File 'lib/line/bot/client.rb', line 495 def (date) channel_token_required endpoint_path = "/bot/message/delivery/reply?date=#{date}" get(endpoint, endpoint_path, credentials) end |
#get_number_of_followers(date) ⇒ Net::HTTPResponse
Returns the number of followers
806 807 808 809 810 811 |
# File 'lib/line/bot/client.rb', line 806 def get_number_of_followers(date) channel_token_required endpoint_path = "/bot/insight/followers?date=#{date}" get(endpoint, endpoint_path, credentials) end |
#get_number_of_message_deliveries(date) ⇒ Net::HTTPResponse
Returns the number of messages sent on a specified day
782 783 784 785 786 787 |
# File 'lib/line/bot/client.rb', line 782 def (date) channel_token_required endpoint_path = "/bot/insight/message/delivery?date=#{date}" get(endpoint, endpoint_path, credentials) end |
#get_profile(user_id) ⇒ Net::HTTPResponse
Get an user’s profile.
348 349 350 351 352 353 |
# File 'lib/line/bot/client.rb', line 348 def get_profile(user_id) channel_token_required endpoint_path = "/bot/profile/#{user_id}" get(endpoint, endpoint_path, credentials) end |
#get_profile_by_access_token(access_token) ⇒ Net::HTTPResponse
Get user profile by access token
203 204 205 206 207 208 209 |
# File 'lib/line/bot/client.rb', line 203 def get_profile_by_access_token(access_token) headers = { "Authorization" => "Bearer #{access_token}", } endpoint_path = "/v2/profile" get(oauth_endpoint, endpoint_path, headers) end |
#get_quota ⇒ Net::HTTPResponse
Get the target limit for additional messages
760 761 762 763 764 765 |
# File 'lib/line/bot/client.rb', line 760 def get_quota channel_token_required endpoint_path = "/bot/message/quota" get(endpoint, endpoint_path, credentials) end |
#get_quota_consumption ⇒ Net::HTTPResponse
Get number of messages sent this month
770 771 772 773 774 775 |
# File 'lib/line/bot/client.rb', line 770 def get_quota_consumption channel_token_required endpoint_path = "/bot/message/quota/consumption" get(endpoint, endpoint_path, credentials) end |
#get_rich_menu(rich_menu_id) ⇒ Net::HTTPResponse
Get a rich menu via a rich menu ID
483 484 485 486 487 488 |
# File 'lib/line/bot/client.rb', line 483 def () channel_token_required endpoint_path = "/bot/richmenu/#{rich_menu_id}" get(endpoint, endpoint_path, credentials) end |
#get_rich_menu_image(rich_menu_id) ⇒ Net::HTTPResponse
Download an image associated with a rich menu
724 725 726 727 728 729 |
# File 'lib/line/bot/client.rb', line 724 def () channel_token_required endpoint_path = "/bot/richmenu/#{rich_menu_id}/content" get(blob_endpoint, endpoint_path, credentials) end |
#get_rich_menus ⇒ Net::HTTPResponse
Get a list of all uploaded rich menus
471 472 473 474 475 476 |
# File 'lib/line/bot/client.rb', line 471 def channel_token_required endpoint_path = '/bot/richmenu/list' get(endpoint, endpoint_path, credentials) end |
#get_rich_menus_alias(rich_menu_alias_id) ⇒ Net::HTTPResponse
Get a rich menu alias via a rich menu alias ID
649 650 651 652 653 654 |
# File 'lib/line/bot/client.rb', line 649 def () channel_token_required endpoint_path = "/bot/richmenu/alias/#{rich_menu_alias_id}" get(endpoint, endpoint_path, credentials) end |
#get_rich_menus_alias_list ⇒ Net::HTTPResponse
Get a list of all uploaded rich menus alias
659 660 661 662 663 664 |
# File 'lib/line/bot/client.rb', line 659 def channel_token_required endpoint_path = "/bot/richmenu/alias/list" get(endpoint, endpoint_path, credentials) end |
#get_room_member_ids(room_id, continuation_token = nil) ⇒ Net::HTTPResponse
Get user IDs of a room
424 425 426 427 428 429 430 |
# File 'lib/line/bot/client.rb', line 424 def get_room_member_ids(room_id, continuation_token = nil) channel_token_required endpoint_path = "/bot/room/#{room_id}/members/ids" endpoint_path += "?start=#{continuation_token}" if continuation_token get(endpoint, endpoint_path, credentials) end |
#get_room_member_profile(room_id, user_id) ⇒ Net::HTTPResponse
Get an user’s profile of a room.
374 375 376 377 378 379 |
# File 'lib/line/bot/client.rb', line 374 def get_room_member_profile(room_id, user_id) channel_token_required endpoint_path = "/bot/room/#{room_id}/member/#{user_id}" get(endpoint, endpoint_path, credentials) end |
#get_room_members_count(room_id) ⇒ Net::HTTPResponse
Gets the count of members in a room.
461 462 463 464 465 466 |
# File 'lib/line/bot/client.rb', line 461 def get_room_members_count(room_id) channel_token_required endpoint_path = "/bot/room/#{room_id}/members/count" get(endpoint, endpoint_path, credentials) end |
#get_statistics_per_unit(unit:, from:, to:) ⇒ Net::HTTPResponse
Get the per-unit statistics of how users interact with push messages and multicast messages.
1056 1057 1058 1059 1060 1061 1062 |
# File 'lib/line/bot/client.rb', line 1056 def get_statistics_per_unit(unit:, from:, to:) channel_token_required params = {customAggregationUnit: unit, from: from, to: to} endpoint_path = "/bot/insight/message/event/aggregation?" + URI.encode_www_form(params) get(endpoint, endpoint_path, credentials) end |
#get_user_interaction_statistics(request_id) ⇒ Net::HTTPResponse
Returns statistics about how users interact with narrowcast messages or broadcast messages sent from your LINE Official Account.
794 795 796 797 798 799 |
# File 'lib/line/bot/client.rb', line 794 def get_user_interaction_statistics(request_id) channel_token_required endpoint_path = "/bot/insight/message/event?requestId=#{request_id}" get(endpoint, endpoint_path, credentials) end |
#get_user_rich_menu(user_id) ⇒ Net::HTTPResponse
Get the ID of the rich menu linked to a user
567 568 569 570 571 572 |
# File 'lib/line/bot/client.rb', line 567 def (user_id) channel_token_required endpoint_path = "/bot/user/#{user_id}/richmenu" get(endpoint, endpoint_path, credentials) end |
#get_webhook_endpoint ⇒ Net::HTTPResponse
Gets information on a webhook endpoint.
836 837 838 839 840 841 |
# File 'lib/line/bot/client.rb', line 836 def get_webhook_endpoint channel_token_required endpoint_path = '/bot/channel/webhook/endpoint' get(endpoint, endpoint_path, credentials) end |
#issue_channel_access_token_jwt(jwt) ⇒ Net::HTTPResponse
Issue channel access token v2.1
118 119 120 121 122 123 124 125 126 127 |
# File 'lib/line/bot/client.rb', line 118 def issue_channel_access_token_jwt(jwt) endpoint_path = '/oauth2/v2.1/token' payload = URI.encode_www_form( grant_type: 'client_credentials', client_assertion_type: 'urn:ietf:params:oauth:client-assertion-type:jwt-bearer', client_assertion: jwt ) headers = { 'Content-Type' => 'application/x-www-form-urlencoded' } post(oauth_endpoint, endpoint_path, payload, headers) end |
#issue_channel_token(grant_type = 'client_credentials') ⇒ Net::HTTPResponse
Issue channel access token
89 90 91 92 93 94 95 96 97 98 99 100 101 |
# File 'lib/line/bot/client.rb', line 89 def issue_channel_token(grant_type = 'client_credentials') channel_id_required channel_secret_required endpoint_path = '/oauth/accessToken' payload = URI.encode_www_form( grant_type: grant_type, client_id: channel_id, client_secret: channel_secret ) headers = { 'Content-Type' => 'application/x-www-form-urlencoded' } post(endpoint, endpoint_path, payload, headers) end |
#leave_group(group_id) ⇒ Object
319 320 321 322 323 324 |
# File 'lib/line/bot/client.rb', line 319 def leave_group(group_id) channel_token_required endpoint_path = "/bot/group/#{group_id}/leave" post(endpoint, endpoint_path, nil, credentials) end |
#leave_room(room_id) ⇒ Object
326 327 328 329 330 331 |
# File 'lib/line/bot/client.rb', line 326 def leave_room(room_id) channel_token_required endpoint_path = "/bot/room/#{room_id}/leave" post(endpoint, endpoint_path, nil, credentials) end |
#liff_endpoint ⇒ Object
73 74 75 |
# File 'lib/line/bot/client.rb', line 73 def liff_endpoint @liff_endpoint ||= API::DEFAULT_LIFF_ENDPOINT end |
#link_user_rich_menu(user_id, rich_menu_id) ⇒ Net::HTTPResponse
Link a rich menu to a user
If you want to link a rich menu to multiple users, please consider to use bulk_link_rich_menus.
675 676 677 678 679 680 |
# File 'lib/line/bot/client.rb', line 675 def (user_id, ) channel_token_required endpoint_path = "/bot/user/#{user_id}/richmenu/#{rich_menu_id}" post(endpoint, endpoint_path, nil, credentials) end |
#multicast(to, messages, headers: {}, payload: {}) ⇒ Net::HTTPResponse
Send messages to multiple users using userIds.
265 266 267 268 269 270 271 272 273 274 |
# File 'lib/line/bot/client.rb', line 265 def multicast(to, , headers: {}, payload: {}) channel_token_required to = [to] if to.is_a?(String) = [] if .is_a?(Hash) endpoint_path = '/bot/message/multicast' payload = payload.merge({ to: to, messages: }).to_json post(endpoint, endpoint_path, payload, credentials.merge(headers)) end |
#narrowcast(messages, recipient: nil, filter: nil, limit: nil, headers: {}) ⇒ Net::HTTPResponse
Narrowcast messages to users
API Documentation is here. developers.line.biz/en/reference/messaging-api/#send-narrowcast-message
304 305 306 307 308 309 310 311 312 313 314 315 316 317 |
# File 'lib/line/bot/client.rb', line 304 def narrowcast(, recipient: nil, filter: nil, limit: nil, headers: {}) channel_token_required = [] if .is_a?(Hash) endpoint_path = '/bot/message/narrowcast' payload = { messages: , recipient: recipient, filter: filter, limit: limit }.to_json post(endpoint, endpoint_path, payload, credentials.merge(headers)) end |
#oauth_endpoint ⇒ Object
58 59 60 |
# File 'lib/line/bot/client.rb', line 58 def oauth_endpoint @oauth_endpoint ||= API::DEFAULT_OAUTH_ENDPOINT end |
#parse_events_from(request_body) ⇒ Array<Line::Bot::Event::Class>
Parse events from request.body
1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 |
# File 'lib/line/bot/client.rb', line 1143 def parse_events_from(request_body) json = JSON.parse(request_body) json['events'].map do |item| begin klass = Event.const_get(Util.camelize(item['type'])) klass.new(item) rescue NameError Event::Base.new(item) end end end |
#post(endpoint_base, endpoint_path, payload = nil, headers = {}) ⇒ Net::HTTPResponse
Post data, get content of specified URL.
1108 1109 1110 1111 |
# File 'lib/line/bot/client.rb', line 1108 def post(endpoint_base, endpoint_path, payload = nil, headers = {}) headers = API::DEFAULT_HEADERS.merge(headers) httpclient.post(endpoint_base + endpoint_path, payload, headers) end |
#push_message(user_id, messages, headers: {}, payload: {}) ⇒ Net::HTTPResponse
Push messages to a user using user_id.
218 219 220 221 222 223 224 225 226 |
# File 'lib/line/bot/client.rb', line 218 def (user_id, , headers: {}, payload: {}) channel_token_required = [] if .is_a?(Hash) endpoint_path = '/bot/message/push' payload = payload.merge({ to: user_id, messages: }).to_json post(endpoint, endpoint_path, payload, credentials.merge(headers)) end |
#put(endpoint_base, endpoint_path, payload = nil, headers = {}) ⇒ Net::HTTPResponse
Put data, get content of specified URL.
1121 1122 1123 1124 |
# File 'lib/line/bot/client.rb', line 1121 def put(endpoint_base, endpoint_path, payload = nil, headers = {}) headers = API::DEFAULT_HEADERS.merge(headers) httpclient.put(endpoint_base + endpoint_path, payload, headers) end |
#rename_audience(audience_group_id, description) ⇒ Net::HTTPResponse
Rename an existing audience group
967 968 969 970 971 972 973 |
# File 'lib/line/bot/client.rb', line 967 def rename_audience(audience_group_id, description) channel_token_required endpoint_path = "/bot/audienceGroup/#{audience_group_id}/updateDescription" body = {description: description} put(endpoint, endpoint_path, body.to_json, credentials) end |
#reply_message(token, messages) ⇒ Net::HTTPResponse
Reply messages to a user using replyToken.
248 249 250 251 252 253 254 255 256 |
# File 'lib/line/bot/client.rb', line 248 def (token, ) channel_token_required = [] if .is_a?(Hash) endpoint_path = '/bot/message/reply' payload = { replyToken: token, messages: }.to_json post(endpoint, endpoint_path, payload, credentials) end |
#revoke_channel_access_token_jwt(access_token) ⇒ Net::HTTPResponse
Revoke channel access token v2.1
134 135 136 137 138 139 140 141 142 143 144 145 146 |
# File 'lib/line/bot/client.rb', line 134 def revoke_channel_access_token_jwt(access_token) channel_id_required channel_secret_required endpoint_path = '/oauth2/v2.1/revoke' payload = URI.encode_www_form( client_id: channel_id, client_secret: channel_secret, access_token: access_token ) headers = { 'Content-Type' => 'application/x-www-form-urlencoded' } post(oauth_endpoint, endpoint_path, payload, headers) end |
#revoke_channel_token(access_token) ⇒ Net::HTTPResponse
Revoke channel access token
106 107 108 109 110 111 |
# File 'lib/line/bot/client.rb', line 106 def revoke_channel_token(access_token) endpoint_path = '/oauth/revoke' payload = URI.encode_www_form(access_token: access_token) headers = { 'Content-Type' => 'application/x-www-form-urlencoded' } post(endpoint, endpoint_path, payload, headers) end |
#set_default_rich_menu(rich_menu_id) ⇒ Net::HTTPResponse
Set default rich menu (Link a rich menu to all user)
589 590 591 592 593 594 |
# File 'lib/line/bot/client.rb', line 589 def () channel_token_required endpoint_path = "/bot/user/all/richmenu/#{rich_menu_id}" post(endpoint, endpoint_path, nil, credentials) end |
#set_rich_menus_alias(rich_menu_id, rich_menu_alias_id) ⇒ Net::HTTPResponse
Set rich menu alias
612 613 614 615 616 617 |
# File 'lib/line/bot/client.rb', line 612 def (, ) channel_token_required endpoint_path = '/bot/richmenu/alias' post(endpoint, endpoint_path, { richMenuId: , richMenuAliasId: }.to_json, credentials) end |
#set_webhook_endpoint(webhook_endpoint) ⇒ Net::HTTPResponse
Sets the webhook endpoint URL.
848 849 850 851 852 853 854 |
# File 'lib/line/bot/client.rb', line 848 def set_webhook_endpoint(webhook_endpoint) channel_token_required endpoint_path = '/bot/channel/webhook/endpoint' body = {endpoint: webhook_endpoint} put(endpoint, endpoint_path, body.to_json, credentials) end |
#test_webhook_endpoint(webhook_endpoint = nil) ⇒ Net::HTTPResponse
Checks if the configured webhook endpoint can receive a test webhook event.
861 862 863 864 865 866 867 868 869 870 871 |
# File 'lib/line/bot/client.rb', line 861 def test_webhook_endpoint(webhook_endpoint = nil) channel_token_required endpoint_path = '/bot/channel/webhook/test' body = if webhook_endpoint.nil? {} else {endpoint: webhook_endpoint} end post(endpoint, endpoint_path, body.to_json, credentials) end |
#unlink_user_rich_menu(user_id) ⇒ Net::HTTPResponse
Unlink a rich menu from a user
687 688 689 690 691 692 |
# File 'lib/line/bot/client.rb', line 687 def (user_id) channel_token_required endpoint_path = "/bot/user/#{user_id}/richmenu" delete(endpoint, endpoint_path, credentials) end |
#unset_default_rich_menu ⇒ Net::HTTPResponse
Unset default rich menu (Unlink a rich menu from all user)
599 600 601 602 603 604 |
# File 'lib/line/bot/client.rb', line 599 def channel_token_required endpoint_path = "/bot/user/all/richmenu" delete(endpoint, endpoint_path, credentials) end |
#unset_rich_menus_alias(rich_menu_alias_id) ⇒ Net::HTTPResponse
Unset rich menu alias
624 625 626 627 628 629 |
# File 'lib/line/bot/client.rb', line 624 def () channel_token_required endpoint_path = "/bot/richmenu/alias/#{rich_menu_alias_id}" delete(endpoint, endpoint_path, credentials) end |
#update_audience_authority_level(authority_level) ⇒ Net::HTTPResponse
Change the authority level of the audience
Parameters are described here. developers.line.biz/en/reference/messaging-api/#change-authority-level
1041 1042 1043 1044 1045 1046 1047 |
# File 'lib/line/bot/client.rb', line 1041 def () channel_token_required endpoint_path = "/bot/audienceGroup/authorityLevel" body = {authorityLevel: } put(endpoint, endpoint_path, body.to_json, credentials) end |
#update_liff_app(liff_id, app) ⇒ Object
887 888 889 890 891 892 |
# File 'lib/line/bot/client.rb', line 887 def update_liff_app(liff_id, app) channel_token_required endpoint_path = "/apps/#{liff_id}" put(liff_endpoint, endpoint_path, app.to_json, credentials) end |
#update_rich_menus_alias(rich_menu_id, rich_menu_alias_id) ⇒ Net::HTTPResponse
Update rich menu alias
637 638 639 640 641 642 |
# File 'lib/line/bot/client.rb', line 637 def (, ) channel_token_required endpoint_path = "/bot/richmenu/alias/#{rich_menu_alias_id}" post(endpoint, endpoint_path, { richMenuId: }.to_json, credentials) end |
#update_user_id_audience(params) ⇒ Net::HTTPResponse
Update an audience group
Parameters are described here. developers.line.biz/en/reference/messaging-api/#update-upload-audience-group
924 925 926 927 928 929 |
# File 'lib/line/bot/client.rb', line 924 def update_user_id_audience(params) channel_token_required endpoint_path = '/bot/audienceGroup/upload' put(endpoint, endpoint_path, params.to_json, credentials) end |
#validate_signature(content, channel_signature) ⇒ Boolean
Validate signature of a webhook event.
developers.line.biz/en/reference/messaging-api/#signature-validation
1164 1165 1166 1167 1168 1169 1170 1171 |
# File 'lib/line/bot/client.rb', line 1164 def validate_signature(content, channel_signature) return false if !channel_signature || !channel_secret hash = OpenSSL::HMAC.digest(OpenSSL::Digest.new('SHA256'), channel_secret, content) signature = Base64.strict_encode64(hash) variable_secure_compare(channel_signature, signature) end |
#verify_access_token(access_token) ⇒ Net::HTTPResponse
Verify access token v2.1
174 175 176 177 178 179 180 |
# File 'lib/line/bot/client.rb', line 174 def verify_access_token(access_token) payload = URI.encode_www_form( access_token: access_token ) endpoint_path = "/oauth2/v2.1/verify?#{payload}" get(oauth_endpoint, endpoint_path) end |
#verify_id_token(id_token, nonce: nil, user_id: nil) ⇒ Net::HTTPResponse
Verify ID token
155 156 157 158 159 160 161 162 163 164 165 166 167 |
# File 'lib/line/bot/client.rb', line 155 def verify_id_token(id_token, nonce: nil, user_id: nil) channel_id_required endpoint_path = '/oauth2/v2.1/verify' payload = URI.encode_www_form({ client_id: channel_id, id_token: id_token, nonce: nonce, user_id: user_id }.compact) headers = { 'Content-Type' => 'application/x-www-form-urlencoded' } post(oauth_endpoint, endpoint_path, payload, headers) end |