Загрузка linebot - Загрузка исходного кода linebot

линейный робот

? SDK для API LINE Messaging для Node.js

Поставляется со встроенным сервером для быстрой настройки.
Предоставьте удобные дополнительные функции для объекта события.

Об API сообщений LINE

Подробную информацию можно найти в официальных документах 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, порт, обратный вызов)

Запустите встроенный http-сервер на указанном port и примите обратный вызов POST-запроса на указанном webHookPath .

Этот метод предусмотрен для удобства. Вы можете написать собственный сервер и использовать методы verify и parse для обработки событий веб-перехватчика. См., например examples/echo-express-long.js .

LineBot.parser()

Создайте промежуточное программное обеспечение Express.js для анализа запроса.

Анализатор предполагает, что тело запроса никогда ранее не анализировалось каким-либо анализатором тела, поэтому его необходимо разместить ПЕРЕД любым общим анализатором тела, например app.use(bodyParser.json());

LineBot.verify(rawBody, подпись)

Проверьте заголовок X-Line-Signature .

LineBot.parse(тело)

Обработка входящего запроса веб-перехватчика и создание события.

LineBot.on(eventType, eventHandler)

Возникает при получении события 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(кому, сообщение)

Отправить push-сообщение.

to — это идентификатор пользователя или массив идентификаторов пользователя. Идентификатор пользователя можно сохранить из event.source.userId при добавлении в список друзей (событие отслеживания) или во время чата (событие сообщения).

message может быть строкой, массивом строк, объектом «Отправить сообщение» или массивом объектов «Отправить сообщение».

LineBot.multicast(кому, сообщение)

Отправьте push-сообщение нескольким пользователям (максимум: 150 пользователей). Это более эффективно, чем push , поскольку вызов API будет выполняться только один раз.

to — это массив идентификаторов пользователя.

LineBot.broadcast(сообщение)

Отправьте push-сообщение всем пользователям. Это более эффективно, чем push , поскольку вызов API будет выполняться только один раз.

LineBot.getMessageContent(идентификатор сообщения)

Получайте изображения, видео и аудиоданные, отправленные пользователями, в виде объекта Buffer.

См.: Event.message.content().

LineBot.getUserProfile(идентификатор пользователя)

Получить информацию о профиле пользователя.

См.: Event.source.profile().

LineBot.getGroupMemberProfile(groupId, userId)

Получить профиль пользователя участника группы.

LineBot.getGroupMember(groupId)

Получите идентификаторы пользователей всех участников группы.

См.: Event.source.member().

LineBot.leaveGroup(groupId)

Покиньте группу.

LineBot.getRoomMemberProfile(roomId, userId)

Получите профиль пользователя в чате.

LineBot.getRoomMember(roomId)

Получите идентификаторы пользователей всех участников чата.

См.: Event.source.member().

LineBot.leaveRoom(roomId)

Выйдите из комнаты.

LineBot.getTotalFollowers(дата)

Получите количество пользователей, которые добавили этого линейного бота не позднее указанной даты.

Дата по умолчанию — вчерашний день (UTC+9).

См.: Получить количество подписчиков

LineBot.getQuota()

Получите квоту количества сообщений в текущем месяце.

См.: Получение целевого лимита для дополнительных сообщений.

LineBot.getTotalReplyMessages(дата)

LineBot.getTotalPushMessages(дата)

LineBot.getTotalBroadcastMessages(дата)

LineBot.getTotalMulticastMessages(дата)

Получите количество сообщений, на которые этот линейный робот отвечает, отправляет, передает или осуществляет многоадресную рассылку.

Дата по умолчанию — вчерашний день (UTC+9).

См.: Получить количество отправленных ответных сообщений.

Объект события

Предоставьте удобные сокращения для вызова функций LineBot, которым требуется параметр из исходного объекта события.

Event.reply(сообщение)

Реагируйте на событие.

Верните объект Promise из модуля node-fetch .

Это сокращение для: 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'
      } ]
    } ]
  }
} ) ;

Событие.источник.профиль()

Получите информацию о профиле пользователя отправителя.

Это сокращение для:

LineBot.getUserProfile(event.source.userId) , если это чат 1:1.
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 ) ;
} ) ;

Event.source.member()

Получите идентификаторы пользователей всех участников группы или чата.

Это сокращение для:

LineBot.getGroupMember(event.source.groupId) если бот находится в группе
LineBot.getRoomMember(event.source.roomId) если бот находится в чате

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

Событие.message.content()

Получайте изображения, видео и аудиоданные, отправленные пользователями, в виде объекта Buffer.

Это сокращение для: LineBot.getMessageContent(event.message.messageId)

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

Лицензия

Массачусетский технологический институт

Расширять