Pymessager

Pymessager

Pymessager是Facebook Messenger的Python API，也是一個示例項目，以演示如何在Facebook Messenger上開發聊天機器人。

完整的教程正在使用Python和Chatbot開發一個Facebook機器人：從0到1，您可以在其中找到更多詳細的信息進行設置和開發。

開始之前

1. 準備一個Facebook頁面。 （如果沒有一個，則創建）
2. 為開發人員在Facebook上創建開發人員應用程序。
3. 啟動一個Python項目，然後安裝所需的軟件包和模塊：燒瓶，請求。
4. 使用讓我們加密為您的域名應用SSL認證。

安裝

要安裝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

初始化

您可以通過開發人員控制台通過Facebook訪問令牌初始化Messager客戶端：

 from pymessager . message import Messager
client = Messager ( config . facebook_access_token )

接收器API

以下代碼用於構建消息接收器，有三個主要步驟可以為您的機器人準備：

1. 設置Webhook

 @ 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' )

2. 收到消息

 @ 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"

3. 使用https啟動服務器

 if __name__ == '__main__' :
    context = ( 'ssl/fullchain.pem' , 'ssl/privkey.pem' )
    app . run ( host = '0.0.0.0' , debug = True , ssl_context = context )

發件人API

消息有幾種類型： 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	點擊有效負載字符串	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	點擊有效負載字符串	只有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 )

實用程序API

訂閱頁面

在聊天機器人開始接收消息之前，您必須將應用程序訂閱到聊天機器人頁面。要訂閱頁面，請調用它：

 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. 

問題

請隨時提交錯誤報告或功能請求，並確保在打開任何問題之前閱讀貢獻指南。

貢獻

1. 檢查打開 /關閉問題或打開新的問題，以獲取具有不同標籤（ feature / bug ）的功能請求或錯誤報告。
2. 在Github上為此存儲庫分叉，以開始在主或新分支上自定義。
3. 編寫一個測試，該測試表明該功能可以按預期工作或修復錯誤。
4. 發送拉動請求並等待代碼審核。

閱讀更多有關貢獻的信息。

執照

 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.