Pymessagerのダウンロード-Pymessagerソースコードのダウンロード

Pymessager

AI ソースコード

1.0.0

ダウンロード

Pymessager

Pymessagerは、Facebook MessengerのPython APIであり、Facebook Messengerでチャットボットを開発する方法を示すサンプルプロジェクトです。

完全なチュートリアルは、PythonとChatbot：0から1を使用してFacebookボットを開発しています。

始める前に

Facebookページを準備します。（持っていない場合に作成する）
Facebookで開発者向けの開発者アプリケーションを作成します。
Pythonプロジェクトを開始し、必要なパッケージとモジュールをインストールします：フラスコ、リクエスト。
ドメイン名に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

次のコードを使用してメッセージ受信機を構築するために使用されます。ボットに備えるための3つの主な手順があります。

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

メッセージを受け取ります

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

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.

問題

問題を開く前に、バグレポートまたは機能リクエストを自由に送信し、貢献ガイドラインを必ずお読みください。

貢献

オープン /クローズの問題を確認するか、さまざまなラベル（ feature / bug ）を使用した機能リクエストまたはバグレポートのために新鮮な問題を開きます。
GitHubのこのリポジトリをフォークして、マスターまたは新しいブランチでカスタマイズを開始します。
機能が期待どおりに機能するか、バグが修正されたことを示すテストを作成します。
プルリクエストを送信し、コードレビューを待ちます。

貢献の詳細を読んでください。

ライセンス

 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.

拡大する

追加情報