PyMessager
1.0.0
PyMessager adalah API Python untuk Facebook Messenger dan contoh proyek untuk mendemonstrasikan cara mengembangkan chatbot di Facebook Messenger.
Tutorial lengkap ada di Mengembangkan Bot Facebook Menggunakan Python dan Chatbot: Dari 0 Hingga 1 di mana Anda dapat menemukan informasi lebih detail untuk menyiapkan dan mengembangkan.
Untuk menginstal PyMessager, jalankan saja:
$ pip install pymessageratau instal dari repositori:
$ git clone [email protected]:enginebai/PyMessager.git
$ cd PyMessager
$ pip install -r requirements.txt from pymessager . message import Messager , ... # something else you needAnda dapat menginisialisasi klien pengirim pesan melalui Token Akses Facebook dari konsol pengembang:
from pymessager . message import Messager
client = Messager ( config . facebook_access_token )Kode berikut digunakan untuk membangun penerima pesan, ada tiga langkah utama untuk mempersiapkan bot Anda:
@ app . route ( API_ROOT + FB_WEBHOOK , methods = [ "GET" ])
def fb_webhook ():
verification_code = 'I_AM_VERIFICIATION_CODE'
verify_token = request . args . get ( 'hub.verify_token' )
if verification_code == verify_token :
return request . args . get ( 'hub.challenge' ) @ app . route ( API_ROOT + FB_WEBHOOK , methods = [ 'POST' ])
def fb_receive_message ():
message_entries = json . loads ( request . data . decode ( 'utf8' ))[ 'entry' ]
for entry in message_entries :
for message in entry [ 'messaging' ]:
if message . get ( 'message' ):
print ( "{sender[id]} says {message[text]}" . format ( ** message ))
return "Hi" if __name__ == '__main__' :
context = ( 'ssl/fullchain.pem' , 'ssl/privkey.pem' )
app . run ( host = '0.0.0.0' , debug = True , ssl_context = context ) Ada beberapa jenis pesan: text , image , quick replies , button template , atau generic template . API menyediakan kelas berbeda untuk menghasilkan template pesan.
Kirim teks atau gambar sederhana ke penerima, pastikan saja URL gambar tersebut adalah tautan yang valid.
client . send_text ( user_id , "Hello, I'm enginebai." )
client . send_image ( user_id , "http://image-url.jpg" ) Kelas QuickReply(title, payload, image_url, content_type) mendefinisikan tombol yang ada kepada pengguna sebagai respons terhadap sebuah pesan.
| Parameter | Keterangan | Diperlukan |
|---|---|---|
title | Judul tombol | Y |
payload | String muatan klik | Y |
image_url | URL gambar ikon | N |
content_type | TEXT atau LOCATION | Y |
client . send_quick_replies ( user_id , "Help" , [
QuickReply ( "Projects" , Intent . PROJECT ),
QuickReply ( "Blog" , Intent . BLOG ),
QuickReply ( "Contact Me" , Intent . CONTACT_ME )
]) Kelas ActionButton(button_type, title, url, payload) mendefinisikan templat tombol yang berisi lampiran teks dan tombol untuk meminta masukan dari pengguna.
| Parameter | Keterangan | Diperlukan |
|---|---|---|
button_type | WEB_URL atau POSTBACK | Y |
title | Judul tombol | Y |
url | Tautannya | Hanya jika button_type adalah url |
payload | String muatan klik | Hanya jika button_type adalah POSTBACK |
client . send_buttons ( user_id , "You can find me with below" , [
ActionButton ( ButtonType . WEB_URL , "Blog" , "http://blog.enginebai.com" ),
ActionButton ( ButtonType . POSTBACK , "Email" , Intent . EMAIL )
]) Kelas GenericElement(title, subtitle, image_url, buttons) mendefinisikan carousel item yang dapat digulir secara horizontal, masing-masing terdiri dari lampiran gambar, deskripsi singkat, dan tombol untuk meminta masukan dari pengguna.
| Parameter | Keterangan | Diperlukan |
|---|---|---|
title_text | Judul utama pesan | Y |
subtitle_text | Subjudul pesan, biarkan kosong jika tidak diperlukan | N |
button_list | Daftar ActionButton | Y |
project_list = []
for project_id , project in projects . items ():
project_list . append ( GenericElement (
project [ "title" ],
project [ "description" ],
config . api_root + project [ "image_url" ], [
ActionButton ( ButtonType . POSTBACK ,
self . _get_string ( "button_more" ),
# Payload use Intent for the beginning
payload = Intent . PROJECTS . name + project_id )
]))
client . send_generic ( user_id , project_list )Sebelum chatbot Anda mulai menerima pesan, Anda harus berlangganan aplikasi tersebut ke halaman chatbot Anda. Untuk berlangganan halaman, panggil saja:
client . subscribe_to_page ()Teks ucapan akan muncul saat pertama kali Anda membuka chatbot ini di ponsel saja. Payload adalah pemicu ketika pengguna mengklik tombol "Memulai".
client . set_greeting_text ( "Hi, this is Engine Bai. Nice to meet you!" )
client . set_get_started_button_payload ( "HELP" ) # Specify a payload string. Jangan ragu untuk mengirimkan laporan bug atau permintaan fitur dan pastikan Anda membaca pedoman kontribusi sebelum membuka terbitan apa pun.
feature / bug ).Baca lebih lanjut tentang berkontribusi.
The MIT License (MIT)
Copyright © 2017 Engine Bai.
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
