linebotダウンロード - linebotソースコードのダウンロード

ラインボット

? LINE Messaging API for Node.js の SDK

内蔵サーバーが付属しているのでセットアップが簡単です
イベントオブジェクトに便利なアドオン機能を提供

LINEメッセージングAPIについて

詳細については、公式 API ドキュメントを参照してください。

開発者向けドキュメント - https://developers.line.biz/en/docs/
API リファレンス - https://developers.line.biz/en/reference/messaging-api/

インストール

$ npm install linebot --save

使用法

 var linebot = require ( 'linebot' ) ;

var bot = linebot ( {
  channelId : CHANNEL_ID ,
  channelSecret : CHANNEL_SECRET ,
  channelAccessToken : CHANNEL_ACCESS_TOKEN
} ) ;

bot . on ( 'message' , function ( event ) {
  event . reply ( event . message . text ) . then ( function ( data ) {
    // success
  } ) . catch ( function ( error ) {
    // error
  } ) ;
} ) ;

bot . listen ( '/linewebhook' , 3000 ) ;

独自の Express.js サーバーでの使用

 const app = express ( ) ;
const linebotParser = bot . parser ( ) ;
app . post ( '/linewebhook' , linebotParser ) ;
app . listen ( 3000 ) ;

その他の例については、 examplesフォルダーを参照してください。

API

LineBot オブジェクト

ラインボット(構成)

指定した構成で LineBot インスタンスを作成します。

 var bot = linebot ( {
  channelId : CHANNEL_ID ,
  channelSecret : CHANNEL_SECRET ,
  channelAccessToken : CHANNEL_ACCESS_TOKEN ,
  verify : true // Verify 'X-Line-Signature' header (default=true)
} ) ;

LineBot.listen(webHookPath、ポート、コールバック)

指定されたportで組み込み http サーバーを起動し、指定されたwebHookPathで POST リクエストのコールバックを受け入れます。

このメソッドは便宜のために提供されています。独自のサーバーを作成し、 verifyとparseメソッドを使用して Webhook イベントを処理できます。たとえば、 examples/echo-express-long.js参照してください。

LineBot.parser()

リクエストを解析するための Express.js ミドルウェアを作成します。

パーサーは、リクエスト本文がこれまでにどのボディパーサーによっても解析されたことがないと想定しているため、汎用ボディパーサーの前に配置する必要があります (例: app.use(bodyParser.json());

LineBot.verify(rawBody, 署名)

X-Line-Signatureヘッダーを確認します。

LineBot.parse(本体)

受信した Webhook リクエストを処理し、イベントを発生させます。

LineBot.on(イベントタイプ、イベントハンドラー)

Webhook イベントを受信したときに発生します。

 bot . on ( 'message' ,      function ( event ) { } ) ;
bot . on ( 'follow' ,       function ( event ) { } ) ;
bot . on ( 'unfollow' ,     function ( event ) { } ) ;
bot . on ( 'join' ,         function ( event ) { } ) ;
bot . on ( 'leave' ,        function ( event ) { } ) ;
bot . on ( 'memberJoined' , function ( event ) { } ) ;
bot . on ( 'memberLeft' ,   function ( event ) { } ) ;
bot . on ( 'postback' ,     function ( event ) { } ) ;
bot . on ( 'beacon' ,       function ( event ) { } ) ;

LineBot.reply(replyToken, メッセージ)

メッセージを返信します。

参照: Event.reply(メッセージ)

LineBot.push(宛先, メッセージ)

プッシュメッセージを送信します。

to userId、または userId の配列です。 userId は、友達として追加されたとき (イベントをフォロー)、またはチャット中 (メッセージイベント) に、 event.source.userIdから保存できます。

message 、文字列、文字列の配列、送信メッセージオブジェクト、または送信メッセージオブジェクトの配列を指定できます。

LineBot.multicast(宛先、メッセージ)

複数のユーザーにプッシュメッセージを送信します (最大: 150 ユーザー)。これは、API 呼び出しを 1 回だけ行うため、 pushよりも効率的です。

to userId の配列です。

message 、文字列、文字列の配列、送信メッセージオブジェクト、または送信メッセージオブジェクトの配列を指定できます。

LineBot.broadcast(メッセージ)

すべてのユーザーにプッシュメッセージを送信します。これは API 呼び出しを 1 回だけ行うため、 pushよりも効率的です。

message 、文字列、文字列の配列、送信メッセージオブジェクト、または送信メッセージオブジェクトの配列を指定できます。

LineBot.getMessageContent(メッセージID)

ユーザーから送信された画像、ビデオ、オーディオデータを Buffer オブジェクトとして取得します。

参照: Event.message.content()

LineBot.getUserProfile(userId)

ユーザーのユーザープロフィール情報を取得します。

参照: Event.source.profile()

LineBot.getGroupMemberProfile(groupId, userId)

グループ内のメンバーのユーザープロファイルを取得します。

LineBot.getGroupMember(グループID)

グループ内のすべてのメンバーの userId を取得します。

参照: Event.source.member()

LineBot.leaveGroup(グループID)

グループを脱退します。

LineBot.getRoomMemberProfile(roomId, userId)

チャットルームのメンバーのユーザープロフィールを取得します。

LineBot.getRoomMember(roomId)

チャットルーム内のすべてのメンバーの userId を取得します。

参照: Event.source.member()

LineBot.leaveRoom(部屋ID)

部屋を出てください。

LineBot.getTotalFollowers(日付)

指定された日付以前にこのラインボットを追加したユーザーの数を取得します。

デフォルトの日付は昨日 (UTC+9) です。

参照: フォロワー数の取得

LineBot.getQuota()

当月のメッセージ割り当て数を取得します。

参照: 追加メッセージのターゲット制限の取得

LineBot.getTotalReplyMessages(日付)

LineBot.getTotalPushMessages(日付)

LineBot.getTotalBroadcastMessages(日付)

LineBot.getTotalMulticastMessages(日付)

このラインボットが返信、プッシュ、ブロードキャスト、またはマルチキャストするメッセージの数を取得します。

デフォルトの日付は昨日 (UTC+9) です。

参照: 送信された応答メッセージの数を取得する

イベントオブジェクト

ソースイベントオブジェクトからのパラメーターを必要とする LineBot 関数を呼び出すための便利な省略表現を提供します。

イベント.返信(メッセージ)

イベントに応答します。

message 、文字列、文字列の配列、送信メッセージオブジェクト、または送信メッセージオブジェクトの配列を指定できます。

node-fetchモジュールから Promise オブジェクトを返します。

これはLineBot.reply(event.replyToken, message)の短縮形です。

 // reply text message
event . reply ( 'Hello, world' ) . then ( function ( data ) {
  // success
} ) . catch ( function ( error ) {
  // error
} ) ;

// reply multiple text messages
event . reply ( [ 'Hello, world 1' , 'Hello, world 2' ] ) ;

// reply message object
event . reply ( { type : 'text' , text : 'Hello, world' } ) ;

// reply multiple message object
event . reply ( [
  { type : 'text' , text : 'Hello, world 1' } ,
  { type : 'text' , text : 'Hello, world 2' }
] ) ;

event . reply ( {
  type : 'image' ,
  originalContentUrl : 'https://example.com/original.jpg' ,
  previewImageUrl : 'https://example.com/preview.jpg'
} ) ;

event . reply ( {
  type : 'video' ,
  originalContentUrl : 'https://example.com/original.mp4' ,
  previewImageUrl : 'https://example.com/preview.jpg'
} ) ;

event . reply ( {
  type : 'audio' ,
  originalContentUrl : 'https://example.com/original.m4a' ,
  duration : 240000
} ) ;

event . reply ( {
  type : 'location' ,
  title : 'my location' ,
  address : '〒150-0002 東京都渋谷区渋谷２丁目２１−１' ,
  latitude : 35.65910807942215 ,
  longitude : 139.70372892916203
} ) ;

event . reply ( {
  type : 'sticker' ,
  packageId : '1' ,
  stickerId : '1'
} ) ;

event . reply ( {
  type : 'imagemap' ,
  baseUrl : 'https://example.com/bot/images/rm001' ,
  altText : 'this is an imagemap' ,
  baseSize : { height : 1040 , width : 1040 } ,
  actions : [ {
    type : 'uri' ,
    linkUri : 'https://example.com/' ,
    area : { x : 0 , y : 0 , width : 520 , height : 1040 }
  } , {
    type : 'message' ,
    text : 'hello' ,
    area : { x : 520 , y : 0 , width : 520 , height : 1040 }
  } ]
} ) ;

event . reply ( {
  type : 'template' ,
  altText : 'this is a buttons template' ,
  template : {
    type : 'buttons' ,
    thumbnailImageUrl : 'https://example.com/bot/images/image.jpg' ,
    title : 'Menu' ,
    text : 'Please select' ,
    actions : [ {
      type : 'postback' ,
      label : 'Buy' ,
      data : 'action=buy&itemid=123'
    } , {
      type : 'postback' ,
      label : 'Add to cart' ,
      data : 'action=add&itemid=123'
    } , {
      type : 'uri' ,
      label : 'View detail' ,
      uri : 'http://example.com/page/123'
    } ]
  }
} ) ;

event . reply ( {
  type : 'template' ,
  altText : 'this is a confirm template' ,
  template : {
    type : 'confirm' ,
    text : 'Are you sure?' ,
    actions : [ {
      type : 'message' ,
      label : 'Yes' ,
      text : 'yes'
    } , {
      type : 'message' ,
      label : 'No' ,
      text : 'no'
    } ]
  }
} ) ;

event . reply ( {
  type : 'template' ,
  altText : 'this is a carousel template' ,
  template : {
    type : 'carousel' ,
    columns : [ {
      thumbnailImageUrl : 'https://example.com/bot/images/item1.jpg' ,
      title : 'this is menu' ,
      text : 'description' ,
      actions : [ {
        type : 'postback' ,
        label : 'Buy' ,
        data : 'action=buy&itemid=111'
      } , {
        type : 'postback' ,
        label : 'Add to cart' ,
        data : 'action=add&itemid=111'
      } , {
        type : 'uri' ,
        label : 'View detail' ,
        uri : 'http://example.com/page/111'
      } ]
    } , {
      thumbnailImageUrl : 'https://example.com/bot/images/item2.jpg' ,
      title : 'this is menu' ,
      text : 'description' ,
      actions : [ {
        type : 'postback' ,
        label : 'Buy' ,
        data : 'action=buy&itemid=222'
      } , {
        type : 'postback' ,
        label : 'Add to cart' ,
        data : 'action=add&itemid=222'
      } , {
        type : 'uri' ,
        label : 'View detail' ,
        uri : 'http://example.com/page/222'
      } ]
    } ]
  }
} ) ;

イベント.ソース.プロファイル()

送信者のユーザープロファイル情報を取得します。

これは次の省略形です。

1:1 チャットの場合はLineBot.getUserProfile(event.source.userId)
ボットがグループに属している場合はLineBot.getGroupMemberProfile(event.source.groupId, event.source.userId)
ボットがチャットルームにいる場合はLineBot.getRoomMemberProfile(event.source.roomId, event.source.userId)

 event . source . profile ( ) . then ( function ( profile ) {
  event . reply ( 'Hello ' + profile . displayName ) ;
} ) ;

イベント.ソース.メンバー()

グループまたはチャットルーム内のすべてのメンバーの userId を取得します。

これは次の省略形です。

ボットがグループに属している場合はLineBot.getGroupMember(event.source.groupId)
ボットがチャットルームにいる場合はLineBot.getRoomMember(event.source.roomId)

 event . source . member ( ) . then ( function ( member ) {
  console . log ( member . memberIds ) ;
} ) ;

イベント.メッセージ.コンテンツ()

ユーザーから送信された画像、ビデオ、オーディオデータを Buffer オブジェクトとして取得します。

これはLineBot.getMessageContent(event.message.messageId)の短縮形です。

 event . message . content ( ) . then ( function ( content ) {
  console . log ( content . toString ( 'base64' ) ) ;
} ) ;

ライセンス

マサチューセッツ工科大学

拡大する