Class: Line::Bot::Client

Inherits:
Object
  • Object
show all
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

Instance Method Summary collapse

Constructor Details

#initialize(options = {}) {|_self| ... } ⇒ Line::Bot::Client

Initialize a new client.

Parameters:

  • options (Hash) (defaults to: {})

Yields:

  • (_self)

Yield Parameters:



43
44
45
46
47
48
 
# File 'lib/line/bot/client.rb', line 43

def initialize(options = {})
  options.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

Returns:

  • (Hash) 


37
38
39
 
# File 'lib/line/bot/client.rb', line 37

def http_options
  @http_options
end

#httpclient ⇒ Object

Returns:

  • (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.

Parameters:

  • messages (Hash or Array) —

    Message Objects

  • headers (Hash) (defaults to: {}) —

    HTTP Headers

Returns:

  • (Net::HTTPResponse) 


178
179
180
181
182
183
184
185
186
 
# File 'lib/line/bot/client.rb', line 178

def broadcast(messages, headers: {})
  channel_token_required

  messages = [messages] if messages.is_a?(Hash)

  endpoint_path = '/bot/message/broadcast'
  payload = { messages: 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

Parameters:

  • user_ids (Array) —

    ID of the user

  • rich_menu_id (String) —

    ID of the uploaded rich menu

Returns:

  • (Net::HTTPResponse) 


554
555
556
557
558
559
 
# File 'lib/line/bot/client.rb', line 554

def bulk_link_rich_menus(user_ids, rich_menu_id)
  channel_token_required

  endpoint_path = "/bot/richmenu/bulk/link"
  post(endpoint, endpoint_path, { richMenuId: rich_menu_id, 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

Parameters:

  • user_ids (Array) —

    ID of the user

Returns:

  • (Net::HTTPResponse) 


566
567
568
569
570
571
 
# File 'lib/line/bot/client.rb', line 566

def bulk_unlink_rich_menus(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

Parameters:

  • params (Hash) —

    options

Returns:

  • (Net::HTTPResponse) —

    This response includes an audience_group_id.



793
794
795
796
797
798
 
# File 'lib/line/bot/client.rb', line 793

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

Parameters:

  • params (Hash) —

    options

Returns:

  • (Net::HTTPResponse) —

    This response includes an audience_group_id.



808
809
810
811
812
813
 
# File 'lib/line/bot/client.rb', line 808

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 



734
735
736
737
738
739
 
# File 'lib/line/bot/client.rb', line 734

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

Parameters:

  • user_id (String) —

    ID of the user

Returns:

  • (Net::HTTPResponse) 


604
605
606
607
608
609
 
# File 'lib/line/bot/client.rb', line 604

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

Parameters:

  • rich_menu (Hash) —

    The rich menu represented as a rich menu object

Returns:

  • (Net::HTTPResponse) 


432
433
434
435
436
437
 
# File 'lib/line/bot/client.rb', line 432

def create_rich_menu(rich_menu)
  channel_token_required

  endpoint_path = '/bot/richmenu'
  post(endpoint, endpoint_path, rich_menu.to_json, credentials)
end

#create_rich_menu_image(rich_menu_id, file) ⇒ Net::HTTPResponse

Upload and attaches an image to a rich menu

Parameters:

  • rich_menu_id (String) —

    The ID of the rich menu to attach the image to

  • file (File) —

    Image file to attach rich menu

Returns:

  • (Net::HTTPResponse) 


591
592
593
594
595
596
597
 
# File 'lib/line/bot/client.rb', line 591

def create_rich_menu_image(rich_menu_id, 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

Parameters:

  • params (Hash) —

    options

Returns:

  • (Net::HTTPResponse) —

    This response includes an audience_group_id.



763
764
765
766
767
768
 
# File 'lib/line/bot/client.rb', line 763

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

Returns:

  • (Hash) 


74
75
76
77
78
 
# File 'lib/line/bot/client.rb', line 74

def credentials
  {
    "Authorization" => "Bearer #{channel_token}",
  }
end

#delete(endpoint_base, endpoint_path, headers = {}) ⇒ Net::HTTPResponse

Delete content of specified URL.

Parameters:

  • endpoint_base (String)
  • endpoint_path (String)
  • headers (Hash) (defaults to: {})

Returns:

  • (Net::HTTPResponse) 


948
949
950
951
 
# File 'lib/line/bot/client.rb', line 948

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

Parameters:

  • audience_group_id (Integer)

Returns:

  • (Net::HTTPResponse) 


837
838
839
840
841
842
 
# File 'lib/line/bot/client.rb', line 837

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 



748
749
750
751
752
753
 
# File 'lib/line/bot/client.rb', line 748

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

Parameters:

  • rich_menu_id (String) —

    ID of an uploaded rich menu

Returns:

  • (Net::HTTPResponse) 


444
445
446
447
448
449
 
# File 'lib/line/bot/client.rb', line 444

def delete_rich_menu(rich_menu_id)
  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.

Parameters:

  • endpoint_base (String)
  • endpoint_path (String)
  • headers (Hash) (defaults to: {})

Returns:

  • (Net::HTTPResponse) 


910
911
912
913
 
# File 'lib/line/bot/client.rb', line 910

def get(endpoint_base, endpoint_path, headers = {})
  headers = API::DEFAULT_HEADERS.merge(headers)
  httpclient.get(endpoint_base + endpoint_path, headers)
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

Parameters:

  • audience_group_id (Integer)

Returns:

  • (Net::HTTPResponse) 


852
853
854
855
856
857
 
# File 'lib/line/bot/client.rb', line 852

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

Returns:

  • (Net::HTTPResponse) 


880
881
882
883
884
885
 
# File 'lib/line/bot/client.rb', line 880

def get_audience_authority_level
  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

Parameters:

  • params (Hash) —

    key name ‘page` is required

Returns:

  • (Net::HTTPResponse) 


867
868
869
870
871
872
 
# File 'lib/line/bot/client.rb', line 867

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.

Returns:

  • (Net::HTTPResponse) 


680
681
682
683
684
685
 
# File 'lib/line/bot/client.rb', line 680

def get_bot_info
  channel_token_required

  endpoint_path = '/bot/info'
  get(endpoint, endpoint_path, credentials)
end

#get_default_rich_menu ⇒ Net::HTTPResponse

Get default rich menu

Returns:

  • (Net::HTTPResponse) 


466
467
468
469
470
471
 
# File 'lib/line/bot/client.rb', line 466

def get_default_rich_menu
  channel_token_required

  endpoint_path = '/bot/user/all/richmenu'
  get(endpoint, endpoint_path, credentials)
end

#get_follower_ids(continuation_token = nil) ⇒ Net::HTTPResponse

Get user IDs of who added your LINE Official Account as a friend

Parameters:

  • continuation_token (String) (defaults to: nil) —

    Identifier to return next page (next property to be included in the response)

Returns:

  • (Net::HTTPResponse) 


283
284
285
286
287
288
289
 
# File 'lib/line/bot/client.rb', line 283

def get_follower_ids(continuation_token = nil)
  channel_token_required

  endpoint_path = "/bot/followers/ids"
  endpoint_path += "?start=#{continuation_token}" if continuation_token
  get(endpoint, endpoint_path, credentials)
end

#get_friend_demographics ⇒ Net::HTTPResponse

Get the demographic attributes for a bot’s friends.

Returns:

  • (Net::HTTPResponse) 


670
671
672
673
674
675
 
# File 'lib/line/bot/client.rb', line 670

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

Parameters:

  • group_id (String) —

    Group’s identifier

  • continuation_token (String) (defaults to: nil) —

    Identifier to return next page (next property to be included in the response)

Returns:

  • (Net::HTTPResponse) 


298
299
300
301
302
303
304
 
# File 'lib/line/bot/client.rb', line 298

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.

Parameters:

  • group_id (String) —

    Group’s identifier

  • user_id (String) —

    User Id user_id

Returns:

  • (Net::HTTPResponse) 


257
258
259
260
261
262
 
# File 'lib/line/bot/client.rb', line 257

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.

Parameters:

  • group_id (String) —

    Group’s identifier

Returns:

  • (Net::HTTPResponse) 


338
339
340
341
342
343
 
# File 'lib/line/bot/client.rb', line 338

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.

Parameters:

  • group_id (String) —

    Group’s identifier

Returns:

  • (Net::HTTPResponse) 


326
327
328
329
330
331
 
# File 'lib/line/bot/client.rb', line 326

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 



727
728
729
730
731
732
 
# File 'lib/line/bot/client.rb', line 727

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.

Parameters:

  • identifier (String) —

    Message’s identifier

Returns:

  • (Net::HTTPResponse) 


233
234
235
236
237
238
 
# File 'lib/line/bot/client.rb', line 233

def get_message_content(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.

Parameters:

  • date (String) —

    Date the messages were sent (format: yyyyMMdd)

Returns:

  • (Net::HTTPResponse) 


420
421
422
423
424
425
 
# File 'lib/line/bot/client.rb', line 420

def get_message_delivery_broadcast(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.

Parameters:

  • date (String) —

    Date the messages were sent (format: yyyyMMdd)

Returns:

  • (Net::HTTPResponse) 


408
409
410
411
412
413
 
# File 'lib/line/bot/client.rb', line 408

def get_message_delivery_multicast(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.

Parameters:

  • date (String) —

    Date the messages were sent (format: yyyyMMdd)

Returns:

  • (Net::HTTPResponse) 


396
397
398
399
400
401
 
# File 'lib/line/bot/client.rb', line 396

def get_message_delivery_push(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.

Parameters:

  • date (String) —

    Date the messages were sent (format: yyyyMMdd)

Returns:

  • (Net::HTTPResponse) 


384
385
386
387
388
389
 
# File 'lib/line/bot/client.rb', line 384

def get_message_delivery_reply(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

Parameters:

  • date (String) —

    (Format:yyyyMMdd, Example:20191231)

Returns:

  • (Net::HTTPResponse) 


660
661
662
663
664
665
 
# File 'lib/line/bot/client.rb', line 660

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

Parameters:

  • date (String) —

    (Format:yyyyMMdd, Example:20191231)

Returns:

  • (Net::HTTPResponse) 


636
637
638
639
640
641
 
# File 'lib/line/bot/client.rb', line 636

def get_number_of_message_deliveries(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.

Parameters:

  • user_id (String) —

    User Id user_id

Returns:

  • (Net::HTTPResponse) 


244
245
246
247
248
249
 
# File 'lib/line/bot/client.rb', line 244

def get_profile(user_id)
  channel_token_required

  endpoint_path = "/bot/profile/#{user_id}"
  get(endpoint, endpoint_path, credentials)
end

#get_quota ⇒ Net::HTTPResponse

Get the target limit for additional messages

Returns:

  • (Net::HTTPResponse) 


614
615
616
617
618
619
 
# File 'lib/line/bot/client.rb', line 614

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

Returns:

  • (Net::HTTPResponse) 


624
625
626
627
628
629
 
# File 'lib/line/bot/client.rb', line 624

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

Parameters:

  • rich_menu_id (String) —

    ID of an uploaded rich menu

Returns:

  • (Net::HTTPResponse) 


372
373
374
375
376
377
 
# File 'lib/line/bot/client.rb', line 372

def get_rich_menu(rich_menu_id)
  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

Parameters:

  • rich_menu_id (String) —

    ID of an uploaded rich menu

Returns:

  • (Net::HTTPResponse) 


578
579
580
581
582
583
 
# File 'lib/line/bot/client.rb', line 578

def get_rich_menu_image(rich_menu_id)
  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

Returns:

  • (Net::HTTPResponse) 


360
361
362
363
364
365
 
# File 'lib/line/bot/client.rb', line 360

def get_rich_menus
  channel_token_required

  endpoint_path = '/bot/richmenu/list'
  get(endpoint, endpoint_path, credentials)
end

#get_room_member_ids(room_id, continuation_token = nil) ⇒ Net::HTTPResponse

Get user IDs of a room

Parameters:

  • room_id (String) —

    Room’s identifier

  • continuation_token (String) (defaults to: nil) —

    Identifier to return next page (next property to be included in the response)

Returns:

  • (Net::HTTPResponse) 


313
314
315
316
317
318
319
 
# File 'lib/line/bot/client.rb', line 313

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.

Parameters:

  • room_id (String) —

    Room’s identifier

  • user_id (String) —

    User Id user_id

Returns:

  • (Net::HTTPResponse) 


270
271
272
273
274
275
 
# File 'lib/line/bot/client.rb', line 270

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.

Parameters:

  • room_id (String) —

    Room’s identifier

Returns:

  • (Net::HTTPResponse) 


350
351
352
353
354
355
 
# File 'lib/line/bot/client.rb', line 350

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_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.

Parameters:

  • request_id (String)

Returns:

  • (Net::HTTPResponse) 


648
649
650
651
652
653
 
# File 'lib/line/bot/client.rb', line 648

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

Parameters:

  • user_id (String) —

    ID of the user

Returns:

  • (Net::HTTPResponse) 


456
457
458
459
460
461
 
# File 'lib/line/bot/client.rb', line 456

def get_user_rich_menu(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.

Returns:

  • (Net::HTTPResponse) 


690
691
692
693
694
695
 
# File 'lib/line/bot/client.rb', line 690

def get_webhook_endpoint
  channel_token_required

  endpoint_path = '/bot/channel/webhook/endpoint'
  get(endpoint, endpoint_path, credentials)
end

#issue_channel_token(grant_type = 'client_credentials') ⇒ Net::HTTPResponse

Issue channel access token

Parameters:

  • grant_type (String) (defaults to: 'client_credentials') —

    Grant type

Returns:

  • (Net::HTTPResponse) 


85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/line/bot/client.rb', line 85

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 



215
216
217
218
219
220
 
# File 'lib/line/bot/client.rb', line 215

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 



222
223
224
225
226
227
 
# File 'lib/line/bot/client.rb', line 222

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 



69
70
71
 
# File 'lib/line/bot/client.rb', line 69

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.

Parameters:

  • user_id (String) —

    ID of the user

  • rich_menu_id (String) —

    ID of an uploaded rich menu

Returns:

  • (Net::HTTPResponse) 


529
530
531
532
533
534
 
# File 'lib/line/bot/client.rb', line 529

def link_user_rich_menu(user_id, rich_menu_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: {}) ⇒ Net::HTTPResponse

Send messages to multiple users using userIds.

Parameters:

  • to (Array or String) —

    Array of userIds

  • messages (Hash or Array) —

    Message Objects

  • headers (Hash) (defaults to: {}) —

    HTTP Headers

Returns:

  • (Net::HTTPResponse) 


161
162
163
164
165
166
167
168
169
170
 
# File 'lib/line/bot/client.rb', line 161

def multicast(to, messages, headers: {})
  channel_token_required

  to = [to] if to.is_a?(String)
  messages = [messages] if messages.is_a?(Hash)

  endpoint_path = '/bot/message/multicast'
  payload = { to: to, messages: 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

Parameters:

  • messages (Hash or Array)
  • recipient (Hash) (defaults to: nil)
  • filter (Hash) (defaults to: nil)
  • limit (Hash) (defaults to: nil)
  • headers (Hash) (defaults to: {}) —

    HTTP Headers

Returns:

  • (Net::HTTPResponse) 


200
201
202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/line/bot/client.rb', line 200

def narrowcast(messages, recipient: nil, filter: nil, limit: nil, headers: {})
  channel_token_required

  messages = [messages] if messages.is_a?(Hash)

  endpoint_path = '/bot/message/narrowcast'
  payload = {
    messages: messages,
    recipient: recipient,
    filter: filter,
    limit: limit
  }.to_json
  post(endpoint, endpoint_path, payload, credentials.merge(headers))
end

#parse_events_from(request_body) ⇒ Array<Line::Bot::Event::Class>

Parse events from request.body

Parameters:

  • request_body (String)

Returns:

  • (Array<Line::Bot::Event::Class>) 


958
959
960
961
962
963
964
965
966
967
968
969
 
# File 'lib/line/bot/client.rb', line 958

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.

Parameters:

  • endpoint_base (String)
  • endpoint_path (String)
  • payload (String or NilClass) (defaults to: nil)
  • headers (Hash) (defaults to: {})

Returns:

  • (Net::HTTPResponse) 


923
924
925
926
 
# File 'lib/line/bot/client.rb', line 923

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: {}) ⇒ Net::HTTPResponse

Push messages to a user using user_id.

Parameters:

  • user_id (String) —

    User Id

  • messages (Hash or Array) —

    Message Objects

  • headers (Hash) (defaults to: {}) —

    HTTP Headers

Returns:

  • (Net::HTTPResponse) 


115
116
117
118
119
120
121
122
123
 
# File 'lib/line/bot/client.rb', line 115

def push_message(user_id, messages, headers: {})
  channel_token_required

  messages = [messages] if messages.is_a?(Hash)

  endpoint_path = '/bot/message/push'
  payload = { to: user_id, messages: 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.

Parameters:

  • endpoint_base (String)
  • endpoint_path (String)
  • payload (String or NilClass) (defaults to: nil)
  • headers (Hash) (defaults to: {})

Returns:

  • (Net::HTTPResponse) 


936
937
938
939
 
# File 'lib/line/bot/client.rb', line 936

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

Parameters:

  • audience_group_id (Integer)
  • description (String)

Returns:

  • (Net::HTTPResponse) 


821
822
823
824
825
826
827
 
# File 'lib/line/bot/client.rb', line 821

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.

Examples:

Send a balloon to a user.

message = {
  type: 'text',
  text: 'Hello, World!'
}
client.reply_message(event['replyToken'], message)

Send multiple balloons to a user.


messages = [
 {type: 'text', text: 'Message1'},
 {type: 'text', text: 'Message2'}
]
client.reply_message(event['replyToken'], messages)

Parameters:

  • token (String) —

    Reply Token

  • messages (Hash or Array) —

    Message Objects

Returns:

  • (Net::HTTPResponse) 


145
146
147
148
149
150
151
152
153
 
# File 'lib/line/bot/client.rb', line 145

def reply_message(token, messages)
  channel_token_required

  messages = [messages] if messages.is_a?(Hash)

  endpoint_path = '/bot/message/reply'
  payload = { replyToken: token, messages: messages }.to_json
  post(endpoint, endpoint_path, payload, credentials)
end

#revoke_channel_token(access_token) ⇒ Net::HTTPResponse

Revoke channel access token

Returns:

  • (Net::HTTPResponse) 


102
103
104
105
106
107
 
# File 'lib/line/bot/client.rb', line 102

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)

Parameters:

  • rich_menu_id (String) —

    ID of an uploaded rich menu

Returns:

  • (Net::HTTPResponse) 


478
479
480
481
482
483
 
# File 'lib/line/bot/client.rb', line 478

def set_default_rich_menu(rich_menu_id)
  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

Parameters:

  • rich_menu_id (String) —

    ID of an uploaded rich menu

  • rich_menu_alias_id (String) —

    string of alias words rich menu

Returns:

  • (Net::HTTPResponse) 


501
502
503
504
505
506
 
# File 'lib/line/bot/client.rb', line 501

def set_rich_menus_alias(rich_menu_id, rich_menu_alias_id)
  channel_token_required

  endpoint_path = '/bot/richmenu/alias'
  post(endpoint, endpoint_path, { richMenuId: rich_menu_id, richMenuAliasId: rich_menu_alias_id }.to_json, credentials)
end

#set_webhook_endpoint(webhook_endpoint) ⇒ Net::HTTPResponse

Sets the webhook endpoint URL.

Parameters:

  • webhook_endpoint (String)

Returns:

  • (Net::HTTPResponse) 


702
703
704
705
706
707
708
 
# File 'lib/line/bot/client.rb', line 702

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.

Parameters:

  • webhook_endpoint (String) (defaults to: nil) —

    options

Returns:

  • (Net::HTTPResponse) 


715
716
717
718
719
720
721
722
723
724
725
 
# File 'lib/line/bot/client.rb', line 715

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

Parameters:

  • user_id (String) —

    ID of the user

Returns:

  • (Net::HTTPResponse) 


541
542
543
544
545
546
 
# File 'lib/line/bot/client.rb', line 541

def unlink_user_rich_menu(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)

Returns:

  • (Net::HTTPResponse) 


488
489
490
491
492
493
 
# File 'lib/line/bot/client.rb', line 488

def unset_default_rich_menu
  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

Parameters:

  • rich_menu_alias_id (String) —

    string of alias words rich menu

Returns:

  • (Net::HTTPResponse) 


513
514
515
516
517
518
 
# File 'lib/line/bot/client.rb', line 513

def unset_rich_menus_alias(rich_menu_alias_id)
  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

Parameters:

  • authority_level (String) —

    value must be ‘PUBLIC` or `PRIVATE`

Returns:

  • (Net::HTTPResponse) 


895
896
897
898
899
900
901
 
# File 'lib/line/bot/client.rb', line 895

def update_audience_authority_level(authority_level)
  channel_token_required

  endpoint_path = "/bot/audienceGroup/authorityLevel"
  body = {authorityLevel: authority_level}
  put(endpoint, endpoint_path, body.to_json, credentials)
end

#update_liff_app(liff_id, app) ⇒ Object 



741
742
743
744
745
746
 
# File 'lib/line/bot/client.rb', line 741

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_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

Parameters:

  • params (Hash) —

    options

Returns:

  • (Net::HTTPResponse) —

    This response includes an audience_group_id.



778
779
780
781
782
783
 
# File 'lib/line/bot/client.rb', line 778

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

Parameters:

  • content (String) —

    Request’s body

  • channel_signature (String) —

    Request’header ‘X-LINE-Signature’ # HTTP_X_LINE_SIGNATURE

Returns:

  • (Boolean) 


979
980
981
982
983
984
985
986
 
# File 'lib/line/bot/client.rb', line 979

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