Unduh linebot - pengunduhan kode sumber linebot

linebot

? SDK untuk LINE Messaging API untuk Node.js

Dilengkapi dengan server bawaan untuk pengaturan cepat
Menyediakan fungsi tambahan yang nyaman untuk objek acara

Tentang API Pesan LINE

Silakan merujuk ke dokumen API resmi untuk detailnya.

Dokumen Pengembang - https://developers.line.biz/en/docs/
Referensi API - https://developers.line.biz/en/reference/messaging-api/

Instalasi

$ npm install linebot --save

Penggunaan

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

Menggunakan dengan server Express.js Anda sendiri

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

Lihat folder examples untuk contoh lainnya.

API

objek LineBot

linebot(konfigurasi)

Buat instance LineBot dengan konfigurasi yang ditentukan.

 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, panggilan balik)

Mulai server http bawaan pada port yang ditentukan, dan terima panggilan balik permintaan POST pada webHookPath yang ditentukan.

Metode ini disediakan untuk kenyamanan. Anda dapat menulis server Anda sendiri dan menggunakan metode verify dan parse untuk memproses peristiwa webhook. Lihat examples/echo-express-long.js misalnya.

LineBot.parser()

Buat middleware Express.js untuk mengurai permintaan.

Pengurai mengasumsikan bahwa isi permintaan belum pernah diurai oleh pengurai isi mana pun sebelumnya, sehingga harus ditempatkan SEBELUM pengurai isi umum apa pun, misalnya app.use(bodyParser.json());

LineBot.verify(rawBody, tanda tangan)

Verifikasi header X-Line-Signature .

LineBot.parse(tubuh)

Memproses permintaan webhook yang masuk, dan memunculkan acara.

LineBot.on(eventType, eventHandler)

Dimunculkan saat acara Webhook diterima.

 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, pesan)

Balas pesan.

Lihat: Acara.balas(pesan)

LineBot.push(ke, pesan)

Kirim pesan dorong.

to adalah userId, atau array userId. UserId dapat disimpan dari event.source.userId saat ditambahkan sebagai teman (ikuti acara), atau selama obrolan (acara pesan).

message dapat berupa string, array string, objek Kirim pesan, atau array objek Kirim pesan.

LineBot.multicast(ke, pesan)

Kirim pesan push ke banyak pengguna (Maks: 150 pengguna). Ini lebih efisien daripada push karena hanya akan membuat panggilan api sekali.

to adalah array dari userId.

message dapat berupa string, array string, objek Kirim pesan, atau array objek Kirim pesan.

LineBot.broadcast(pesan)

Kirim pesan push ke semua pengguna. Ini lebih efisien daripada push karena hanya akan membuat panggilan api sekali.

message dapat berupa string, array string, objek Kirim pesan, atau array objek Kirim pesan.

LineBot.getMessageContent(messageId)

Dapatkan data gambar, video, dan audio yang dikirim oleh pengguna sebagai objek Buffer.

Lihat: Acara.pesan.konten()

LineBot.getUserProfile(userId)

Dapatkan informasi profil pengguna pengguna.

Lihat: Acara.sumber.profil()

LineBot.getGroupMemberProfile(groupId, userId)

Dapatkan profil pengguna anggota dalam grup.

LineBot.getGroupMember(groupId)

Dapatkan userId dari semua anggota dalam grup.

Lihat: Acara.sumber.anggota()

LineBot.leaveGroup(groupId)

Keluar dari grup.

LineBot.getRoomMemberProfile(roomId, userId)

Dapatkan profil pengguna anggota di ruang obrolan.

LineBot.getRoomMember(roomId)

Dapatkan userId semua anggota di ruang obrolan.

Lihat: Acara.sumber.anggota()

LineBot.leaveRoom(roomId)

Tinggalkan ruangan.

LineBot.getTotalFollowers (tanggal)

Dapatkan jumlah pengguna yang telah menambahkan linebot ini pada atau sebelum tanggal yang ditentukan.

Tanggal defaultnya adalah kemarin (UTC+9).

Lihat: Dapatkan jumlah pengikut

LineBot.getQuota()

Dapatkan jumlah kuota pesan pada bulan ini.

Lihat: Dapatkan batas target untuk pesan tambahan

LineBot.getTotalReplyMessages(tanggal)

LineBot.getTotalPushMessages(tanggal)

LineBot.getTotalBroadcastMessages(tanggal)

LineBot.getTotalMulticastMessages(tanggal)

Dapatkan jumlah pesan yang dibalas, dikirim, disiarkan, atau multicast oleh linebot ini.

Tanggal defaultnya adalah kemarin (UTC+9).

Lihat: Dapatkan jumlah pesan balasan yang dikirim

Objek acara

Berikan singkatan yang mudah digunakan untuk memanggil fungsi LineBot yang memerlukan parameter dari objek peristiwa sumber.

Acara.balas(pesan)

Menanggapi acara tersebut.

message dapat berupa string, array string, objek Kirim pesan, atau array objek Kirim pesan.

Mengembalikan objek Promise dari modul node-fetch .

Ini adalah singkatan dari: 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'
      } ]
    } ]
  }
} ) ;

Acara.sumber.profil()

Dapatkan informasi profil pengguna pengirim.

Ini adalah singkatan dari:

LineBot.getUserProfile(event.source.userId) jika obrolan 1:1
LineBot.getGroupMemberProfile(event.source.groupId, event.source.userId) jika bot ada dalam grup
LineBot.getRoomMemberProfile(event.source.roomId, event.source.userId) jika bot ada di ruang obrolan

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

Acara.sumber.anggota()

Dapatkan userId semua anggota di grup atau ruang obrolan.

Ini adalah singkatan dari:

LineBot.getGroupMember(event.source.groupId) jika bot berada dalam grup
LineBot.getRoomMember(event.source.roomId) jika bot ada di ruang obrolan

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

Acara.pesan.konten()

Dapatkan data gambar, video, dan audio yang dikirim oleh pengguna sebagai objek Buffer.

Ini adalah singkatan dari: LineBot.getMessageContent(event.message.messageId)

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

Lisensi

MIT

Memperluas