sulla

술라

Sulla는 Whatsapp에 고급 API 제어를 제공하여 Whatsapp을 통과하는 응답이나 데이터를 쉽게 자동화하도록 구성할 수 있는 자바스크립트 라이브러리입니다.

인형극을 사용하여 제작되었습니다.

술라 주

버전 2.3.5 부터 sulla는 매우 풍부하고 안정적인 기능과 아키텍처에 도달한 것 같습니다. 제가 원하지만 이 프로젝트에 많은 시간을 할애할 수는 없으므로 다른 개발자가 이 프로젝트에 더 많은 시간과 지원을 할애할 수 있는 sulla의 분기 버전을 확인해 보시기 바랍니다.

적극적으로 지원되는 sulla 기반 프로젝트를 권장합니다:

독액

wpp연결

오픈-와/와-자동화

설치

 > npm i sulla --save

시작하기

 // Supports ES6
// import { create, Whatsapp } from 'sulla';
const sulla = require ( 'sulla' ) ;

sulla . create ( ) . then ( ( client ) => start ( client ) ) ;

function start ( client ) {
  client . onMessage ( ( message ) => {
    if ( message . body === 'Hi' ) {
      client . sendText ( message . from , ' Hello from sulla!' ) ;
    }
  } ) ;
} 

create() 함수를 실행한 후 sulla는 whatsapp web의 인스턴스를 생성합니다. 로그인하지 않은 경우 단말기에 QR 코드가 인쇄됩니다. 휴대폰으로 스캔하면 바로 사용할 수 있습니다!

Sulla는 세션을 기억하므로 매번 인증할 필요가 없습니다.

create() 함수에 세션 이름을 전달하여 여러 세션을 동시에 생성할 수 있습니다.

 // Init sales whatsapp bot
sulla . create ( 'sales' ) . then ( ( salesClient ) => { ... } ) ;

// Init support whatsapp bot
sulla . create ( 'support' ) . then ( ( supportClient ) => { ... } ) ; 

선택적 생성 매개변수

Sulla create() 메서드의 세 번째 매개변수에는 다음과 같은 선택적 매개변수가 있을 수 있습니다.

 create ( 'sessionName' , qrCallback , {
  headless : true , // Headless chrome
  devtools : false , // Open devtools by default
  useChrome : true , // If false will use Chromium instance
  debug : false , // Opens a debug session
  logQR : true // Logs QR automatically in terminal
  browserArgs : [ '' ] // Parameters to be added into the chrome browser instance
  refreshQR : 15000 , // Will refresh QR every 15 seconds, 0 will load QR once. Default is 30 seconds
} ) ; 

유형 정의는 여기에서 찾을 수 있습니다: CreateConfig.ts

QR 코드 내보내기

기본적으로 QR 코드가 터미널에 나타납니다. QR을 다른 곳으로 전달해야 하는 경우 방법은 다음과 같습니다.

 const fs = require ( 'fs' ) ;

// Second create() parameter is the QR callback
sulla . create ( 'session-marketing' , ( base64Qr , asciiQR ) => {
  // To log the QR in the terminal
  console . log ( asciiQR ) ;

  // To write it somewhere else in a file
  exportQR ( base64Qr , 'marketing-qr.png' ) ;
} ) ;

// Writes QR in specified path
function exportQR ( qrCode , path ) {
  qrCode = qrCode . replace ( 'data:image/png;base64,' , '' ) ;
  const imageBuffer = Buffer . from ( qrCode , 'base64' ) ;

  // Creates 'marketing-qr.png' file
  fs . writeFileSync ( path , imageBuffer ) ;
} 

파일 다운로드 중

Puppeteer는 파일 다운로드를 관리합니다. 해독은 가능한 한 빨리 수행됩니다(기본 방법보다 실행됨). 대용량 파일을 지원합니다!

 import fs = require ( 'fs' ) ;
import mime = require ( 'mime-types' ) ;

client . onMessage ( async ( message ) => {
  if ( message . isMedia ) {
    const buffer = await client . downloadFile ( message ) ;
    // At this point you can do whatever you want with the buffer
    // Most likely you want to write it into a file
    const fileName = `some-file-name. ${ mime . extension ( message . mimetype ) } ` ;
    fs . writeFile ( fileName , buffer , function ( err ) {
      ...
    } ) ;
  }
} ) ; 

기본 기능(사용법)

사용 가능한 모든 기능이 나열되어 있지는 않습니다. 자세한 내용을 보려면 여기 및 여기에서 사용 가능한 모든 기능을 찾을 수 있습니다.

채팅

여기서 chatId @c.us 또는 [e-mail] 일 수 있습니다.

 // Send basic text
await client . sendText ( chatId , ' Hello from sulla!' ) ;

// Send image
await client . sendImage (
  chatId ,
  'path/to/img.jpg' ,
  'image-name.jpg' ,
  'Caption text'
) ;

// Send @tagged message
await client . sendMentioned ( chatId , 'Hello @5218113130740 and @5218243160777!' , [
  '5218113130740' ,
  '5218243160777' ,
] ) ;

// Reply to a message
await client . reply ( chatId , 'This is a reply!' , message . id . toString ( ) ) ;

// Send file (sulla will take care of mime types, just need the path)
await client . sendFile ( chatId , 'path/to/file.pdf' , 'cv.pdf' , 'Curriculum' ) ;

// Send gif
await client . sendVideoAsGif (
  chatId ,
  'path/to/video.mp4' ,
  'video.gif' ,
  'Gif image file'
) ;

// Send contact
// contactId: [email protected]
await client . sendContact ( chatId , contactId ) ;

// Forwards messages
await client . forwardMessages ( chatId , [ message . id . toString ( ) ] , true ) ;

// Send sticker
await client . sendImageAsSticker ( chatId , 'path/to/image.jpg' ) ;

// Send location
await client . sendLocation (
  chatId ,
  25.6801987 ,
  - 100.4060626 ,
  'Some address, Washington DC' ,
  'Subtitle'
) ;

// Send seen ✔️✔️
await client . sendSeen ( chatId ) ;

// Start typing...
await client . startTyping ( chatId ) ;

// Stop typing
await client . stopTyping ( chatId ) ;

// Set chat state (0: Typing, 1: Recording, 2: Paused)
await client . setChatState ( chatId , 0 | 1 | 2 ) ;

데이터 검색 중

 // Retrieve contacts
const contacts = await client . getAllContacts ( ) ;

// Retrieve all messages in chat
const allMessages = await client . loadAndGetAllMessagesInChat ( chatId ) ;

// Retrieve contact status
const status = await client . getStatus ( contactId ) ;

// Retrieve user profile
const user = await client . getNumberProfile ( contactId ) ;

// Retrieve all unread message
const messages = await client . getAllUnreadMessages ( ) ;

// Retrieve all chats
const chats = await client . getAllChats ( ) ;

// Retrieve all groups
const chats = await client . getAllGroups ( ) ;

// Retrieve profile fic (as url)
const url = await client . getProfilePicFromServer ( chatId ) ;

// Retrieve chat/conversation
const chat = await client . getChat ( chatId ) ;

그룹 기능

 // groupId or chatId: leaveGroup [email protected]

// Leave group
await client . leaveGroup ( groupId ) ;

// Get group members
await client . getGroupMembers ( groupId ) ;

// Get group members ids
await client . getGroupMembersIds ( groupId ) ;

// Generate group invite url link
await client . getGroupInviteLink ( groupId ) ;

// Create group (title, participants to add)
await client . createGroup ( 'Group name' , [ '[email protected]' , '[email protected]' ] ) ;

// Remove participant
await client . removeParticipant ( groupId , '[email protected]' ) ;

// Add participant
await client . addParticipant ( groupId , '[email protected]' ) ;

// Promote participant (Give admin privileges)
await client . promoteParticipant ( groupId , '[email protected]' ) ;

// Demote particiapnt (Revoke admin privileges)
await client . demoteParticipant ( groupId , '[email protected]' ) ;

// Get group admins
await client . getGroupAdmins ( groupId ) ;

프로필 기능

 // Set client status
await client . setProfileStatus ( 'On vacations! ✈️' ) ;

// Set client profile name
await client . setProfileName ( 'Sulla bot' ) ;

장치 기능

 // Get device info
await client . getHostDevice ( ) ;

// Get connection state
await client . getConnectionState ( ) ;

// Get battery level
await client . getBatteryLevel ( ) ;

// Is connected
await client . isConnected ( ) ;

// Get whatsapp web version
await client . getWAVersion ( ) ;

이벤트

 // Listen to messages
client . onMessage ( message => {
  ...
} )

// Listen to state changes
client . onStateChange ( state => {
  ...
} ) ;

// Listen to ack's
client . onAck ( ack => {
  ...
} ) ;

// Listen to live location
// chatId: '[email protected]'
client . onLiveLocation ( chatId , ( liveLocation ) => {
  ...
} ) ;

// chatId looks like this: '[email protected]'
// Event interface is in here: https://github.com/danielcardeenas/sulla/blob/master/src/api/model/participant-event.ts
client . onParticipantsChanged ( chatId , ( event ) => {
  ...
} ) ;

// Listen when client has been added to a group
client . onAddedToGroup ( chatEvent => {
  ...
} ) ;

다른

 // Delete chat
await client . deleteChat ( chatId ) ;

// Clear chat messages
await client . clearChat ( chatId ) ;

// Delete message (last parameter: delete only locally)
await client . deleteMessage ( chatId , message . id . toString ( ) , false ) ;

// Retrieve a number profile / check if contact is a valid whatsapp number
const profile = await client . getNumberProfile ( '[email protected]' ) ; 

기타

술라를 더 잘 활용하기 위한 몇 가지 요령이 있습니다.

세션을 활성 상태로 유지:

 // In case of being logged out of whatsapp web
// Force it to keep the current session
// State change
client . onStateChange ( ( state ) => {
  console . log ( state ) ;
  const conflits = [
    sulla . SocketState . CONFLICT ,
    sulla . SocketState . UNPAIRED ,
    sulla . SocketState . UNLAUNCHED ,
  ] ;
  if ( conflits . includes ( state ) ) {
    client . useHere ( ) ;
  }
} ) ; 

새 연락처에 메시지 보내기(추가되지 않음)

Whatsapp 링크도 참조하세요. Whatsapp이 차단될 수 있으므로 주의하세요. 연락처를 항상 최신 상태로 유지하세요!

 await client . sendMessageToId ( '[email protected]' , 'Hello from sulla! ' ) ; 

여러 세션

한 번에 여러 세션을 실행해야 하는 경우 세션 이름을 create() 메서드에 전달하면 됩니다.

 async ( ) => {
  const marketingClient = await sulla . create ( 'marketing' ) ;
  const salesClient = await sulla . create ( 'sales' ) ;
  const supportClient = await sulla . create ( 'support' ) ;
} ; 

세션 종료(저장)

다음에 로그인할 때 세션이 저장되도록 세션을 올바르게 닫으십시오(따라서 QR 스캔을 다시 요청하지 않습니다). 따라서 CTRL+C 대신

 // Catch ctrl+C
process . on ( 'SIGINT' , function ( ) {
  client . close ( ) ;
} ) ;

// Try-catch close
try {
   ...
} catch ( error ) {
   client . close ( ) ;
}

디버깅

개발

내부에 3개의 주요 프로젝트가 포함되어 있지만 sulla를 만드는 것은 정말 간단합니다.

1. 와피 프로젝트

 > npm run build:wapi

2. 미들웨어

 > npm run build:build:middleware
> npm run build:jsQR

3. 술라

 > npm run build:sulla

전체 프로젝트를 빌드하려면 다음을 실행하세요.

 > npm run build

유지관리자

유지관리자가 필요합니다. 모든 업데이트를 혼자서 유지할 수는 없습니다. 관심이 있으시면 Pull Request를 열어주세요.

기여

풀 요청을 환영합니다. 주요 변경 사항의 경우 먼저 이슈를 열어 변경하고 싶은 사항에 대해 논의하세요.