はじめに
Webex Messaging (Teams) API 向けの Python ライブラリとして提供されている webexteamssdk を紹介します。webexteamssdk を使うことによって、Webex Messaging (Teams) API について、シンプルな Python コードを書くことができます。
ドキュメント
インストール
pip でインストールできます。
$ pip install webexteamssdk
利用例
まず、以下は Python ライブラリ (webexteamssdk) を使わない例です。 BOT のアクセストークン (BOT_ACCESS_TOKEN) で Webex のスペースにメッセージ (Hello World!) を送信しています。ペイロードとヘッダを設定して requests を使って API アクセスを行う形となります。
import requests
BOT_ACCESS_TOKEN = <BOT のアクセストークン>
ROOM_ID = <ROOM ID>
url = "https://webexapis.com/v1/messages"
markdown = "Hello World!"
payload = {
"roomId": ROOM_ID,
"markdown" : markdown
}
headers = {
"Authorization": f"Bearer {BOT_ACCESS_TOKEN}",
"Content-Type": "application/json"
}
response = requests.post(url, headers=headers, json=payload)
print(response.text)
次に、Python ライブラリ (webexteamssdk) を使った例が以下となります。ヘッダを意識する必要がなく、ライブラリを使わない場合と比べてコードがすっきりとしているのが確認できます。
from webexteamssdk import WebexTeamsAPI
BOT_ACCESS_TOKEN = <BOT のアクセストークン>
ROOM_ID = <ROOM ID>
markdown = "Hello World!"
api = WebexTeamsAPI(access_token=BOT_ACCESS_TOKEN)
messages = api.messages.create(roomId=ROOM_ID, markdown=markdown)
print(messages)
API の定義
各オブジェクトの API の定義は下記のドキュメントに記載があります。
Learning Labs
以下の webexteamssdk の学習用のラボ (Learning Labs) を利用して webexteamssdk の理解を深めることができます。
Exploring the 'webexteamssdk' Webex Python Library
参考情報