Baileys
v6.7.9
このライブラリはもともとアショカ大学の CS-2362のプロジェクトであり、WhatsApp と提携したり承認したりするものではありません。ご自身の判断でご使用ください。これを他人にスパム送信しないでください。ストーカーウェア、大量メッセージ、または自動メッセージングの使用は推奨しません。
MIT ライセンスに記載されているように、Baileys とその管理者は、このアプリケーションの悪用に対して責任を負うことはできません。 Baileys の管理者は、WhatsApp の利用規約に違反する行為におけるこのアプリケーションの使用を決して容認しません。このアプリケーションの管理者は、このアプリケーションを本来の目的どおりに公正な方法で使用するというユーザーの個人的な責任を求めます。
Baileys では、WhatsApp Web とのインターフェースに Selenium やその他のブラウザーは必要なく、 WebSocket を使用して直接インターフェースします。 Selenium または Chromimum を実行しないことで、RAM を半分ギガ程度節約できます :/ Baileys は、マルチデバイスおよび Web バージョンの WhatsApp との対話をサポートしています。 WhatsApp マルチデバイスの仕組みに関する観察を書いてくれた @pokearaujo に感謝します。また、WhatsApp Web の仕組みに関する観察を書いてくれた @Sigalor に感謝します。また、 Go の実装に協力してくれた @Rhymen に感謝します。
元のリポジトリは元の作成者によって削除される必要がありました。現在、このリポジトリで開発を続けています。これは唯一の公式リポジトリであり、コミュニティによって維持されています。ここからDiscordに参加してください
example.ts をチェックアウトして実行し、ライブラリの使用例を確認してください。このスクリプトは、最も一般的な使用例をカバーしています。サンプル スクリプトを実行するには、リポジトリをダウンロードまたは複製し、ターミナルに次のように入力します。
cd path/to/Baileysyarnyarn example安定バージョンを使用してください。
yarn add @whiskeysockets/baileys
エッジ バージョンを使用します (安定性の保証はありませんが、最新の修正と機能が含まれます)
yarn add github:WhiskeySockets/Baileys
次に、次を使用してコードをインポートします。
import makeWASocket from '@whiskeysockets/baileys' TODO
WhatsApp は、携帯電話の WhatsApp で QR コードをスキャンすることで、Baileys を 2 番目の WhatsApp クライアントとして認証できるマルチデバイス API を提供します。
import makeWASocket , { DisconnectReason } from '@whiskeysockets/baileys'
import { Boom } from '@hapi/boom'
async function connectToWhatsApp ( ) {
const sock = makeWASocket ( {
// can provide additional config here
printQRInTerminal : true
} )
sock . ev . on ( 'connection.update' , ( update ) => {
const { connection , lastDisconnect } = update
if ( connection === 'close' ) {
const shouldReconnect = ( lastDisconnect . error as Boom ) ?. output ?. statusCode !== DisconnectReason . loggedOut
console . log ( 'connection closed due to ' , lastDisconnect . error , ', reconnecting ' , shouldReconnect )
// reconnect if not logged out
if ( shouldReconnect ) {
connectToWhatsApp ( )
}
} else if ( connection === 'open' ) {
console . log ( 'opened connection' )
}
} )
sock . ev . on ( 'messages.upsert' , m => {
console . log ( JSON . stringify ( m , undefined , 2 ) )
console . log ( 'replying to' , m . messages [ 0 ] . key . remoteJid )
await sock . sendMessage ( m . messages [ 0 ] . key . remoteJid ! , { text : 'Hello there!' } )
} )
}
// run in main file
connectToWhatsApp ( )接続が成功すると、端末画面に QR コードが印刷され、携帯電話の WhatsApp でそれをスキャンすると、ログインできます。
SocketConfigオブジェクトを渡すことで接続を構成できます。
ここでは、 SocketConfig構造全体をデフォルト値とともに示します。
type SocketConfig = {
/** the WS url to connect to WA */
waWebSocketUrl : string | URL
/** Fails the connection if the socket times out in this interval */
connectTimeoutMs : number
/** Default timeout for queries, undefined for no timeout */
defaultQueryTimeoutMs : number | undefined
/** ping-pong interval for WS connection */
keepAliveIntervalMs : number
/** proxy agent */
agent ?: Agent
/** pino logger */
logger : Logger
/** version to connect with */
version : WAVersion
/** override browser config */
browser : WABrowserDescription
/** agent used for fetch requests -- uploading/downloading media */
fetchAgent ?: Agent
/** should the QR be printed in the terminal */
printQRInTerminal : boolean
/** should events be emitted for actions done by this socket connection */
emitOwnEvents : boolean
/** provide a cache to store media, so does not have to be re-uploaded */
mediaCache ?: NodeCache
/** custom upload hosts to upload media to */
customUploadHosts : MediaConnInfo [ 'hosts' ]
/** time to wait between sending new retry requests */
retryRequestDelayMs : number
/** max msg retry count */
maxMsgRetryCount : number
/** time to wait for the generation of the next QR in ms */
qrTimeout ?: number ;
/** provide an auth state object to maintain the auth state */
auth : AuthenticationState
/** manage history processing with this control; by default will sync up everything */
shouldSyncHistoryMessage : ( msg : proto . Message . IHistorySyncNotification ) => boolean
/** transaction capability options for SignalKeyStore */
transactionOpts : TransactionCapabilityOptions
/** provide a cache to store a user's device list */
userDevicesCache ?: NodeCache
/** marks the client as online whenever the socket successfully connects */
markOnlineOnConnect : boolean
/**
* map to store the retry counts for failed messages;
* used to determine whether to retry a message or not */
msgRetryCounterMap ?: MessageRetryMap
/** width for link preview images */
linkPreviewImageThumbnailWidth : number
/** Should Baileys ask the phone for full history, will be received async */
syncFullHistory : boolean
/** Should baileys fire init queries automatically, default true */
fireInitQueries : boolean
/**
* generate a high quality link preview,
* entails uploading the jpegThumbnail to WA
* */
generateHighQualityLinkPreview : boolean
/** options for axios */
options : AxiosRequestConfig < any >
/**
* fetch a message from your store
* implement this so that messages failed to send (solves the "this message can take a while" issue) can be retried
* */
getMessage : ( key : proto . IMessageKey ) => Promise < proto . IMessage | undefined >
} const conn = makeWASocket ( {
... otherOpts ,
// can use Windows, Ubuntu here too
browser : Browsers . macOS ( 'Desktop' ) ,
syncFullHistory : true
} ) 接続するたびに QR コードをスキャンし続ける必要はありません。
したがって、資格情報をロードして再度ログインできます。
import makeWASocket , { BufferJSON , useMultiFileAuthState } from '@whiskeysockets/baileys'
import * as fs from 'fs'
// utility function to help save the auth state in a single folder
// this function serves as a good guide to help write auth & key states for SQL/no-SQL databases, which I would recommend in any production grade system
const { state , saveCreds } = await useMultiFileAuthState ( 'auth_info_baileys' )
// will use the given state to connect
// so if valid credentials are available -- it'll connect without QR
const conn = makeWASocket ( { auth : state } )
// this will be called as soon as the credentials are updated
conn . ev . on ( 'creds.update' , saveCreds )注:メッセージが送受信されると、シグナル セッションの更新が必要なため、認証キー ( authState.keys ) が更新されます。そのような場合は、更新されたキーを保存する必要があります ( authState.keys.set()が呼び出されます)。そうしないと、メッセージが受信者に届かなくなり、その他の予期しない結果が発生する可能性があります。 useMultiFileAuthState関数はこれを自動的に処理しますが、その他の本格的な実装の場合は、鍵の状態管理に細心の注意を払う必要があります。
Baileys はconnection.updateイベントを起動して、接続内で何かが更新されたことを通知するようになりました。このデータは次の構造になっています。
type ConnectionState = {
/** connection is now open, connecting or closed */
connection : WAConnectionState
/** the error that caused the connection to close */
lastDisconnect ?: {
error : Error
date : Date
}
/** is this a new login */
isNewLogin ?: boolean
/** the current QR code */
qr ?: string
/** has the device received all pending notifications while it was offline */
receivedPendingNotifications ?: boolean
}注:これにより、QR の更新も提供されます。
Baileys は、イベントに EventEmitter 構文を使用します。これらはすべて適切に入力されているため、VS Code などの Intellisense エディターでは問題は発生しないはずです。
イベントはここで説明されているように型付けされます。
export type BaileysEventMap = {
/** connection state has been updated -- WS closed, opened, connecting etc. */
'connection.update' : Partial < ConnectionState >
/** credentials updated -- some metadata, keys or something */
'creds.update' : Partial < AuthenticationCreds >
/** history sync, everything is reverse chronologically sorted */
'messaging-history.set' : {
chats : Chat [ ]
contacts : Contact [ ]
messages : WAMessage [ ]
isLatest : boolean
}
/** upsert chats */
'chats.upsert' : Chat [ ]
/** update the given chats */
'chats.update' : Partial < Chat > [ ]
/** delete chats with given ID */
'chats.delete' : string [ ]
'labels.association' : LabelAssociation
'labels.edit' : Label
/** presence of contact in a chat updated */
'presence.update' : { id : string , presences : { [ participant : string ] : PresenceData } }
'contacts.upsert' : Contact [ ]
'contacts.update' : Partial < Contact > [ ]
'messages.delete' : { keys : WAMessageKey [ ] } | { jid : string , all : true }
'messages.update' : WAMessageUpdate [ ]
'messages.media-update' : { key : WAMessageKey , media ?: { ciphertext : Uint8Array , iv : Uint8Array } , error ?: Boom } [ ]
/**
* add/update the given messages. If they were received while the connection was online,
* the update will have type: "notify"
* */
'messages.upsert' : { messages : WAMessage [ ] , type : MessageUpsertType }
/** message was reacted to. If reaction was removed -- then "reaction.text" will be falsey */
'messages.reaction' : { key : WAMessageKey , reaction : proto . IReaction } [ ]
'message-receipt.update' : MessageUserReceiptUpdate [ ]
'groups.upsert' : GroupMetadata [ ]
'groups.update' : Partial < GroupMetadata > [ ]
/** apply an action to participants in a group */
'group-participants.update' : { id : string , participants : string [ ] , action : ParticipantAction }
'blocklist.set' : { blocklist : string [ ] }
'blocklist.update' : { blocklist : string [ ] , type : 'add' | 'remove' }
/** Receive an update on a call, including when the call was received, rejected, accepted */
'call' : WACallEvent [ ]
}これらのイベントは次のようにして聞くことができます。
const sock = makeWASocket ( )
sock . ev . on ( 'messages.upsert' , ( { messages } ) => {
console . log ( 'got messages' , messages )
} ) Baileys には、チャット、連絡先、メッセージ用の事実上のストレージは付属していません。ただし、単純なメモリ内実装が提供されています。ストアは、チャットの更新、新しいメッセージ、メッセージの更新などをリッスンして、常に最新バージョンのデータを保持します。
次のように使用できます。
import makeWASocket , { makeInMemoryStore } from '@whiskeysockets/baileys'
// the store maintains the data of the WA connection in memory
// can be written out to a file & read from it
const store = makeInMemoryStore ( { } )
// can be read from a file
store . readFromFile ( './baileys_store.json' )
// saves the state to a file every 10s
setInterval ( ( ) => {
store . writeToFile ( './baileys_store.json' )
} , 10_000 )
const sock = makeWASocket ( { } )
// will listen from this socket
// the store can listen from a new socket once the current socket outlives its lifetime
store . bind ( sock . ev )
sock . ev . on ( 'chats.upsert' , ( ) => {
// can use "store.chats" however you want, even after the socket dies out
// "chats" => a KeyedDB instance
console . log ( 'got chats' , store . chats . all ( ) )
} )
sock . ev . on ( 'contacts.upsert' , ( ) => {
console . log ( 'got contacts' , Object . values ( store . contacts ) )
} )ストアは、データの取得を高速化するためにストアを利用する、 loadMessagesなどのいくつかの単純な関数も提供します。
注:誰かのチャット履歴全体をメモリに保存すると RAM が非常に無駄になるため、特に MD 接続の場合は独自のデータ ストアを構築することを強くお勧めします。
単一の関数であらゆる種類のメッセージを送信します。
import { MessageType , MessageOptions , Mimetype } from '@whiskeysockets/baileys'
const id = '[email protected]' // the WhatsApp ID
// send a simple text!
const sentMsg = await sock . sendMessage ( id , { text : 'oh hello there' } )
// send a reply messagge
const sentMsg = await sock . sendMessage ( id , { text : 'oh hello there' } , { quoted : message } )
// send a mentions message
const sentMsg = await sock . sendMessage ( id , { text : '@12345678901' , mentions : [ '[email protected]' ] } )
// send a location!
const sentMsg = await sock . sendMessage (
id ,
{ location : { degreesLatitude : 24.121231 , degreesLongitude : 55.1121221 } }
)
// send a contact!
const vcard = 'BEGIN:VCARDn' // metadata of the contact card
+ 'VERSION:3.0n'
+ 'FN:Jeff Singhn' // full name
+ 'ORG:Ashoka Uni;n' // the organization of the contact
+ 'TEL;type=CELL;type=VOICE;waid=911234567890:+91 12345 67890n' // WhatsApp ID + phone number
+ 'END:VCARD'
const sentMsg = await sock . sendMessage (
id ,
{
contacts : {
displayName : 'Jeff' ,
contacts : [ { vcard } ]
}
}
)
const reactionMessage = {
react : {
text : "?" , // use an empty string to remove the reaction
key : message . key
}
}
const sendMsg = await sock . sendMessage ( id , reactionMessage )yarn add link-preview-jsを使用して、 link-preview-js preview-js を依存関係としてプロジェクトに追加します。 // send a link
const sentMsg = await sock . sendMessage ( id , { text : 'Hi, this was sent using https://github.com/adiwajshing/baileys' } )メディア (ビデオ、ステッカー、画像) の送信がこれまでより簡単かつ効率的になりました。
import { MessageType , MessageOptions , Mimetype } from '@whiskeysockets/baileys'
// Sending gifs
await sock . sendMessage (
id ,
{
video : fs . readFileSync ( "Media/ma_gif.mp4" ) ,
caption : "hello!" ,
gifPlayback : true
}
)
await sock . sendMessage (
id ,
{
video : "./Media/ma_gif.mp4" ,
caption : "hello!" ,
gifPlayback : true ,
ptv : false // if set to true, will send as a `video note`
}
)
// send an audio file
await sock . sendMessage (
id ,
{ audio : { url : "./Media/audio.mp3" } , mimetype : 'audio/mp4' }
{ url : "Media/audio.mp3" } , // can send mp3, mp4, & ogg
)idメッセージの送信先の個人またはグループの WhatsApp ID です。[country code][phone number]@s.whatsapp.netの形式である必要があります。[email protected] 。[email protected]形式にする必要があります。[timestamp of creation]@broadcastです。status@broadcastです。yarn add jimpまたはyarn add sharp使用してプロジェクトにjimpまたはsharp依存関係として追加すると、画像とステッカーのサムネイルを自動的に生成できます。ビデオのサムネイルも自動的に生成できますが、システムにffmpegがインストールされている必要があります。 const info : MessageOptions = {
quoted : quotedMessage , // the message you want to quote
contextInfo : { forwardingScore : 2 , isForwarded : true } , // some random context info (can show a forwarded message with this too)
timestamp : Date ( ) , // optional, if you want to manually set the timestamp of the message
caption : "hello there!" , // (for media messages) the caption to send with the media (cannot be sent with stickers though)
jpegThumbnail : "23GD#4/==" , /* (for location & media messages) has to be a base 64 encoded JPEG if you want to send a custom thumb,
or set to null if you don't want to send a thumbnail.
Do not enter this field if you want to automatically generate a thumb
*/
mimetype : Mimetype . pdf , /* (for media messages) specify the type of media (optional for all media types except documents),
import {Mimetype} from '@whiskeysockets/baileys'
*/
fileName : 'somefile.pdf' , // (for media messages) file name for the media
/* will send audio messages as voice notes, if set to true */
ptt : true ,
/** Should it send as a disappearing messages.
* By default 'chat' -- which follows the setting of the chat */
ephemeralExpiration : WA_DEFAULT_EPHEMERAL
} const msg = getMessageFromStore ( '[email protected]' , 'HSJHJWH7323HSJSJ' ) // implement this on your end
await sock . sendMessage ( '[email protected]' , { forward : msg } ) // WA forward the message! メッセージ キーのセットには、明示的に「今すぐ読む」とマークする必要があります。マルチデバイスでは、Baileys Web のように「チャット」全体を既読としてマークすることはできません。つまり、未読メッセージを追跡する必要があります。
const key = {
remoteJid : '[email protected]' ,
id : 'AHASHH123123AHGA' , // id of the message you want to read
participant : '[email protected]' // the ID of the user that sent the message (undefined for individual chats)
}
// pass to readMessages function
// can pass multiple keys to read multiple messages as well
await sock . readMessages ( [ key ] )メッセージ ID は、既読としてマークするメッセージの一意の識別子です。 WAMessageでは、 messageID = message.key.idを使用してmessageIDにアクセスできます。
await sock . sendPresenceUpdate ( 'available' , id ) これにより、 idを持つ個人/グループは、あなたがオンラインかオフラインか、入力中かなどを知ることができます。
presence次のいずれかになります。
type WAPresence = 'unavailable' | 'available' | 'composing' | 'recording' | 'paused'プレゼンスは約 10 秒後に期限切れになります。
注: WhatsApp のマルチデバイス バージョンでは、デスクトップ クライアントがアクティブな場合、WA はデバイスにプッシュ通知を送信しません。上記の通知を受け取りたい場合は、 sock.sendPresenceUpdate('unavailable')を使用して Baileys クライアントをオフラインにマークします。
受け取ったメディアを保存したい場合
import { writeFile } from 'fs/promises'
import { downloadMediaMessage } from '@whiskeysockets/baileys'
sock . ev . on ( 'messages.upsert' , async ( { messages } ) => {
const m = messages [ 0 ]
if ( ! m . message ) return // if there is no text or media message
const messageType = Object . keys ( m . message ) [ 0 ] // get what type of message it is -- text, image, video
// if the message is an image
if ( messageType === 'imageMessage' ) {
// download the message
const buffer = await downloadMediaMessage (
m ,
'buffer' ,
{ } ,
{
logger ,
// pass this so that baileys can request a reupload of media
// that has been deleted
reuploadRequest : sock . updateMediaMessage
}
)
// save to file
await writeFile ( './my-download.jpeg' , buffer )
}
}注: WhatsApp はサーバーから古いメディアを自動的に削除します。デバイスが上記のメディアにアクセスするには、そのメディアを持つ別のデバイスによる再アップロードが必要です。これは以下を使用して実現できます。
const updatedMediaMsg = await sock . updateMediaMessage ( msg ) const jid = '[email protected]' // can also be a group
const response = await sock . sendMessage ( jid , { text : 'hello!' } ) // send a message
// sends a message to delete the given message
// this deletes the message for everyone
await sock . sendMessage ( jid , { delete : response . key } )注:自分自身の削除はchatModify経由でサポートされています (次のセクション)
const jid = '[email protected]'
await sock . sendMessage ( jid , {
text : 'updated text goes here' ,
edit : response . key ,
} ) ; WA は暗号化された通信形式を使用してチャット/アプリの更新を送信します。これはほとんど実装されており、次の更新を送信できます。
チャットをアーカイブする
const lastMsgInChat = await getLastMessageInChat ( '[email protected]' ) // implement this on your end
await sock . chatModify ( { archive : true , lastMessages : [ lastMsgInChat ] } , '[email protected]' )チャットをミュート/ミュート解除する
// mute for 8 hours
await sock . chatModify ( { mute : 8 * 60 * 60 * 1000 } , '[email protected]' , [ ] )
// unmute
await sock . chatModify ( { mute : null } , '[email protected]' , [ ] )チャットに既読/未読のマークを付ける
const lastMsgInChat = await getLastMessageInChat ( '[email protected]' ) // implement this on your end
// mark it unread
await sock . chatModify ( { markRead : false , lastMessages : [ lastMsgInChat ] } , '[email protected]' )私へのメッセージを削除
await sock . chatModify (
{ clear : { messages : [ { id : 'ATWYHDNNWU81732J' , fromMe : true , timestamp : "1654823909" } ] } } ,
'[email protected]' ,
[ ]
)チャットを削除する
const lastMsgInChat = await getLastMessageInChat ( '[email protected]' ) // implement this on your end
await sock . chatModify ( {
delete : true ,
lastMessages : [ { key : lastMsgInChat . key , messageTimestamp : lastMsgInChat . messageTimestamp } ]
} ,
'[email protected]' )チャットの固定/固定解除
await sock . chatModify ( {
pin : true // or `false` to unpin
} ,
'[email protected]' )メッセージにスターを付ける/スターを外す
await sock . chatModify ( {
star : {
messages : [ { id : 'messageID' , fromMe : true // or `false` }],
star : true // - true: Star Message; false: Unstar Message
} } , '[email protected]' ) ;注:アップデートの 1 つを失敗すると、WA によってすべてのデバイスからログアウトされ、再度ログインする必要があります。
const jid = '[email protected]' // can also be a group
// turn on disappearing messages
await sock . sendMessage (
jid ,
// this is 1 week in seconds -- how long you want messages to appear for
{ disappearingMessagesInChat : WA_DEFAULT_EPHEMERAL }
)
// will send as a disappearing message
await sock . sendMessage ( jid , { text : 'hello' } , { ephemeralExpiration : WA_DEFAULT_EPHEMERAL } )
// turn off disappearing messages
await sock . sendMessage (
jid ,
{ disappearingMessagesInChat : false }
) const id = '123456'
const [ result ] = await sock . onWhatsApp ( id )
if ( result . exists ) console . log ( ` ${ id } exists on WhatsApp, as jid: ${ result . jid } ` ) const status = await sock . fetchStatus ( "[email protected]" )
console . log ( "status: " + status ) const status = 'Hello World!'
await sock . updateProfileStatus ( status ) const name = 'My name'
await sock . updateProfileName ( name ) // for low res picture
const ppUrl = await sock . profilePictureUrl ( "[email protected]" )
console . log ( "download profile picture from: " + ppUrl )
// for high res picture
const ppUrl = await sock . profilePictureUrl ( "[email protected]" , 'image' ) const jid = '[email protected]' // can be your own too
await sock . updateProfilePicture ( jid , { url : './new-profile-picture.jpeg' } ) const jid = '[email protected]' // can be your own too
await sock . removeProfilePicture ( jid ) // the presence update is fetched and called here
sock . ev . on ( 'presence.update' , json => console . log ( json ) )
// request updates for a chat
await sock . presenceSubscribe ( "[email protected]" ) await sock . updateBlockStatus ( "[email protected]" , "block" ) // Block user
await sock . updateBlockStatus ( "[email protected]" , "unblock" ) // Unblock user const profile = await sock . getBusinessProfile ( "[email protected]" )
console . log ( "business description: " + profile . description + ", category: " + profile . category )もちろん、 xyz実際の ID に置き換えてください。
グループを作成するには
// title & participants
const group = await sock . groupCreate ( "My Fab Group" , [ "[email protected]" , "[email protected]" ] )
console . log ( "created group with id: " + group . gid )
sock . sendMessage ( group . id , { text : 'hello there' } ) // say hello to everyone on the groupグループにユーザーを追加/削除したり、ユーザーを降格/昇進したりするには
// id & people to add to the group (will throw error if it fails)
const response = await sock . groupParticipantsUpdate (
"[email protected]" ,
[ "[email protected]" , "[email protected]" ] ,
"add" // replace this parameter with "remove", "demote" or "promote"
)グループの件名を変更するには
await sock . groupUpdateSubject ( "[email protected]" , "New Subject!" )グループの説明を変更するには
await sock . groupUpdateDescription ( "[email protected]" , "New Description!" )グループ設定を変更するには
// only allow admins to send messages
await sock . groupSettingUpdate ( "[email protected]" , 'announcement' )
// allow everyone to send messages
await sock . groupSettingUpdate ( "[email protected]" , 'not_announcement' )
// allow everyone to modify the group's settings -- like display picture etc.
await sock . groupSettingUpdate ( "[email protected]" , 'unlocked' )
// only allow admins to modify the group's settings
await sock . groupSettingUpdate ( "[email protected]" , 'locked' )グループを離れるには
await sock . groupLeave ( "[email protected]" ) // (will throw error if it fails)グループの招待コードを取得するには
const code = await sock . groupInviteCode ( "[email protected]" )
console . log ( "group code: " + code )グループ内の招待コードを取り消すには
const code = await sock . groupRevokeInvite ( "[email protected]" )
console . log ( "New group code: " + code )グループのメタデータをクエリするには
const metadata = await sock . groupMetadata ( "[email protected]" )
console . log ( metadata . id + ", title: " + metadata . subject + ", description: " + metadata . desc )招待コードを使用してグループに参加するには
const response = await sock . groupAcceptInvite ( "xxx" )
console . log ( "joined to: " + response )もちろん、 xxx招待コードに置き換えてください。
招待コードでグループ情報を取得するには
const response = await sock . groupGetInviteInfo ( "xxx" )
console . log ( "group information: " + response )groupInviteMessage を使用してグループに参加するには
const response = await sock . groupAcceptInviteV4 ( "[email protected]" , groupInviteMessage )
console . log ( "joined to: " + response )もちろん、 xxx招待コードに置き換えてください。
リストリクエストの参加を取得するには
const response = await sock . groupRequestParticipantsList ( "[email protected]" )
console . log ( response )参加リクエストを承認/拒否するには
const response = await sock . groupRequestParticipantsUpdate (
"[email protected]" , // id group,
[ "[email protected]" , "[email protected]" ] ,
"approve" // replace this parameter with "reject"
)
console . log ( response ) const privacySettings = await sock . fetchPrivacySettings ( true )
console . log ( "privacy settings: " + privacySettings ) const value = 'all' // 'contacts' | 'contact_blacklist' | 'none'
await sock . updateLastSeenPrivacy ( value ) const value = 'all' // 'match_last_seen'
await sock . updateOnlinePrivacy ( value ) const value = 'all' // 'contacts' | 'contact_blacklist' | 'none'
await sock . updateProfilePicturePrivacy ( value ) const value = 'all' // 'contacts' | 'contact_blacklist' | 'none'
await sock . updateStatusPrivacy ( value ) const value = 'all' // 'none'
await sock . updateReadReceiptsPrivacy ( value ) const value = 'all' // 'contacts' | 'contact_blacklist'
await sock . updateGroupsAddPrivacy ( value ) const duration = 86400 // 604800 | 7776000 | 0
await sock . updateDefaultDisappearingMode ( duration ) ブロードキャストやストーリーにメッセージを送信できます。次のように、sendMessage に次のメッセージ オプションを追加する必要があります。
sock . sendMessage ( jid , { image : { url : url } , caption : caption } , { backgroundColor : backgroundColor , font : font , statusJidList : statusJidList , broadcast : true } )メッセージ本文は、extendedTextMessage、imageMessage、videoMessage、または voiceMessage にすることができます。
メッセージオプションにbackgroundColorやその他のオプションを追加できます
ブロードキャスト: true はブロードキャスト モードを有効にします
statusJidList: 提供する必要がある取得可能なユーザーのリスト。このステータス メッセージを受け取るユーザーです。
グループや個別のチャットにメッセージを送信するのと同じ方法で、ブロードキャスト リストにメッセージを送信できます。
現時点では、WA Web はブロードキャスト リストの作成をサポートしていませんが、ブロードキャスト リストを削除することはできます。
ブロードキャスト ID の形式は12345678@broadcast
ブロードキャスト リストの受信者と名前をクエリするには:
const bList = await sock . getBroadcastListInfo ( "1234@broadcast" )
console . log ( `list name: ${ bList . name } , recps: ${ bList . recipients } ` ) Baileys はカスタム機能を念頭に置いて作成されています。プロジェクトをフォークして内部を書き直す代わりに、独自の拡張機能を作成するだけで済みます。
まず、次のように設定して、WhatsApp からの未処理メッセージのログ記録を有効にします。
const sock = makeWASocket ( {
logger : P ( { level : 'debug' } ) ,
} )これにより、WhatsApp が送信するあらゆる種類のメッセージをコンソールで確認できるようになります。
いくつかの例:
携帯電話のバッテリーの割合を追跡する機能。ログ記録を有効にすると、バッテリーに関するメッセージがコンソールにポップアップ表示されます。 {"level":10,"fromMe":false,"frame":{"tag":"ib","attrs":{"from":"@s.whatsapp.net"},"content":[{"tag":"edge_routing","attrs":{},"content":[{"tag":"routing_info","attrs":{},"content":{"type":"Buffer","data":[8,2,8,5]}}]}]},"msg":"communication"}
「フレーム」は受信したメッセージであり、次の 3 つのコンポーネントで構成されます。
tag -- このフレームの内容 (例: メッセージには「メッセージ」が含まれます)attrs -- メタデータを含む文字列のキーと値のペア (通常はメッセージの ID が含まれます)content -- 実際のデータ (例: メッセージ ノードには実際のメッセージ コンテンツが含まれます)以下を使用して、イベントのコールバックを登録できます。
// for any message with tag 'edge_routing'
sock . ws . on ( `CB:edge_routing` , ( node : BinaryNode ) => { } )
// for any message with tag 'edge_routing' and id attribute = abcd
sock . ws . on ( `CB:edge_routing,id:abcd` , ( node : BinaryNode ) => { } )
// for any message with tag 'edge_routing', id attribute = abcd & first content node routing_info
sock . ws . on ( `CB:edge_routing,id:abcd,routing_info` , ( node : BinaryNode ) => { } )また、このリポジトリは libsignal-node を使用しているため、GPL 3 に基づいてライセンスされています。
