เครื่องปั่น
1.0.0
Pymessager เป็น Python API สำหรับ Facebook Messenger และโครงการตัวอย่างเพื่อสาธิตวิธีการพัฒนา chatbot บน Facebook Messenger
บทเรียนที่สมบูรณ์อยู่ในการพัฒนาบอท Facebook โดยใช้ Python และ Chatbot: จาก 0 ถึง 1 ซึ่งคุณสามารถค้นหาข้อมูลรายละเอียดเพิ่มเติมเพื่อตั้งค่าและพัฒนา
ในการติดตั้ง pymessager เพียงแค่เรียกใช้:
$ pip install pymessagerหรือติดตั้งจากที่เก็บ:
$ git clone [email protected]:enginebai/PyMessager.git
$ cd PyMessager
$ pip install -r requirements.txt from pymessager . message import Messager , ... # something else you needคุณสามารถเริ่มต้นไคลเอนต์ Messager ผ่านโทเค็นการเข้าถึง Facebook จากคอนโซลนักพัฒนา:
from pymessager . message import Messager
client = Messager ( config . facebook_access_token )รหัสต่อไปนี้ใช้เพื่อสร้างตัวรับข้อความมีสามขั้นตอนหลักในการเตรียมตัวสำหรับบอทของคุณ:
@ 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 ) มีข้อความหลายประเภท: text , image , quick replies , button template หรือ generic template API จัดเตรียมคลาสที่แตกต่างกันเพื่อสร้างเทมเพลตข้อความ
ส่งข้อความง่าย ๆ หรือรูปภาพไปยังผู้รับเพียงตรวจสอบให้แน่ใจว่า URL รูปภาพเป็นลิงค์ที่ถูกต้อง
client . send_text ( user_id , "Hello, I'm enginebai." )
client . send_image ( user_id , "http://image-url.jpg" ) คลาส QuickReply(title, payload, image_url, content_type) คลาสกำหนดปุ่มปัจจุบันให้กับผู้ใช้เพื่อตอบสนองต่อข้อความ
| พารามิเตอร์ | คำอธิบาย | ที่จำเป็น |
|---|---|---|
title | ชื่อปุ่ม | y |
payload | สตริง Payload คลิก | y |
image_url | url ภาพไอคอน | n |
content_type | TEXT หรือ LOCATION | y |
client . send_quick_replies ( user_id , "Help" , [
QuickReply ( "Projects" , Intent . PROJECT ),
QuickReply ( "Blog" , Intent . BLOG ),
QuickReply ( "Contact Me" , Intent . CONTACT_ME )
]) คลาส ActionButton(button_type, title, url, payload) คลาสจะกำหนดเทมเพลตปุ่มซึ่งมีข้อความที่แนบข้อความและปุ่มเพื่อขออินพุตจากผู้ใช้
| พารามิเตอร์ | คำอธิบาย | ที่จำเป็น |
|---|---|---|
button_type | WEB_URL หรือ POSTBACK | y |
title | ชื่อปุ่ม | y |
url | ลิงค์ | เฉพาะในกรณีที่ button_type เป็น url |
payload | สตริง Payload คลิก | เฉพาะในกรณีที่ button_type เป็น 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 )
]) คลาส GenericElement(title, subtitle, image_url, buttons) กำหนดการหมุนม้าหมุนที่สามารถเลื่อนได้ในแนวนอนแต่ละรายการประกอบด้วยการแนบรูปภาพคำอธิบายสั้น ๆ และปุ่มเพื่อขออินพุตจากผู้ใช้
| พารามิเตอร์ | คำอธิบาย | ที่จำเป็น |
|---|---|---|
title_text | ชื่อเรื่องหลักของข้อความ | y |
subtitle_text | คำบรรยายข้อความว่างเปล่าถ้าคุณไม่ต้องการมัน | n |
button_list | รายการ 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 )ก่อนที่ chatbot ของคุณจะเริ่มรับข้อความคุณต้องสมัครสมาชิกแอปพลิเคชันไปยังหน้า Chatbot ของคุณ ในการสมัครสมาชิกหน้าเพียงแค่เรียกมันว่า:
client . subscribe_to_page ()ข้อความทักทายจะแสดงในครั้งแรกที่คุณเปิดแชทบ็อตนี้บนมือถือเท่านั้น น้ำหนักบรรทุกเป็นทริกเกอร์เมื่อผู้ใช้คลิกปุ่ม "เริ่มต้นใช้งาน"
client . set_greeting_text ( "Hi, this is Engine Bai. Nice to meet you!" )
client . set_get_started_button_payload ( "HELP" ) # Specify a payload string. อย่าลังเลที่จะส่งรายงานข้อผิดพลาดหรือคำขอคุณสมบัติและตรวจสอบให้แน่ใจว่าคุณอ่านแนวทางการบริจาคก่อนที่จะเปิดปัญหาใด ๆ
feature / bug )อ่านเพิ่มเติมเกี่ยวกับการมีส่วนร่วม
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.
