コンテンツへスキップ
Wbiztool

リマインダーAPI

リマインダー一覧API

ワークスペース内のリマインダーを、50件ずつ新しい順に取得します。リマインダーIDの確認、自動化の点検、バックアップなどに利用できます。

POSThttps://wbiztool.com/api/v1/reminder/list/

リクエストボディ: JSONまたはフォームフィールド

このエンドポイントはPOSTのみを受け付けます。GETリクエストは、クエリ文字列を付けても、HTTP 400Invalid JSON format: Expecting value…を返します。

一覧には、API経由で作成したかリマインダーページで作成したかにかかわらず、ワークスペース全体の有効なリマインダーと一時停止中のリマインダーが含まれます。キャンセルされたリマインダーは含まれません。

クイック例#

curl -X POST https://wbiztool.com/api/v1/reminder/list/ \
  -H "Content-Type: application/json" \
  -d '{
    "client_id": 12345,
    "api_key": "YOUR_API_KEY",
    "page": 1
  }'

12345YOUR_API_KEYはご自身の値に置き換えてください。値の確認場所は認証をご覧ください。

リクエストパラメータ#

client_idinteger必須

設定 → APIキーに表示されるAPIクライアントIDです。

api_keystring必須

同じページにあるAPIキーです。

pageinteger任意

ページ番号で、1(デフォルト)から始まります。1ページには50件のリマインダーが含まれ、ページサイズは変更できません。1以上の整数でない値は1として扱われます。

レスポンス#

リクエストが成功すると、HTTP 200が返ります。

{
  "reminders": [
    {
      "id": 3187,
      "name": "Monthly rent reminder",
      "to_number": "919876543210",
      "message_template": "Hi Aman, a reminder that your rent is due on {current_date_formatted}.",
      "msg_type": 0,
      "msg_type_display": "Text",
      "img_url": "",
      "file_name": "",
      "cron_expression": "0 10 1 * *",
      "next_run": "2026-10-01 10:00:00 UTC",
      "is_active": true,
      "whatsapp_client_id": 678,
      "created_at": "2026-09-16 04:45:12"
    }
  ],
  "total": 1,
  "page": 1,
  "page_size": 50,
  "message": "Success",
  "status": 1
}
フィールド説明
statusinteger成功時は1、リクエストが失敗した場合は0
messagestringSuccess、それ以外はエラー内容。
remindersarrayこのページのリマインダー(新しい順)。ページが末尾を超えている場合は空です。
totalinteger全ページを通じた、ワークスペース内のリマインダーの数。
pageinteger返されたページ。
page_sizeinteger常に50

リマインダーのフィールド#

フィールド説明
idintegerリマインダーID。リマインダーのキャンセルで使用します。
namestringリマインダーの名前。名前がない場合はUnnamed Reminder
to_numberstringリマインダーの送信先の電話番号またはグループ名。
message_templatestringテンプレート変数に値が入る前のメッセージ。
msg_typeinteger0テキスト、1画像、2ファイル。
msg_type_displaystringTextImageFileのいずれか。
img_urlstring or null画像リマインダーの画像URL、またはAPIで作成したファイルリマインダーのファイルURL。それ以外の場合は空またはnullになることがあります。
file_namestring or nullファイルリマインダーの場合:ファイルURL(ダッシュボードで作成したリマインダー)またはファイル名(APIで作成したリマインダー。URLはimg_urlに入ります)。それ以外の場合は空またはnullになることがあります。
cron_expressionstringスケジュール。cron式を参照してください。
next_runstring次にスケジュールが一致する日時で、YYYY-MM-DD HH:MM:SS UTC形式。式を読み取れない場合はInvalid cron。下の注意事項を参照してください。
is_activebooleanリマインダーが実行中の場合はtrue、一時停止中の場合はfalse
whatsapp_client_idinteger or null送信に使うWhatsApp番号。最初の接続済み番号を使う場合はnull
created_atstringリマインダーが作成された日時(UTC)で、YYYY-MM-DD HH:MM:SS形式。

エラー#

特に記載がない限り、エラーはHTTP 400で返り、status0になります。

{ "status": 0, "message": "Upgrade your plan to use reminders feature" }
メッセージ対処方法
Invalid JSON format: …JSONボディが無効です。GETリクエストや、client_idなしのフォームリクエストでもこのエラーになります。
Auth Error - Please send correct API key and Client idclient_idapi_keyの両方を送信してください。
Invalid client idclient_idを数値で送信してください。
Auth Error: invalid api keyキーが別のclient_idに属しています。
Auth Error: please check client idキーがワークスペースに紐付いていません。使用したいワークスペースで新しいキーを作成してください。
Demo Account cannot access APIs通常のアカウントを使用してください。
Upgrade your plan to use reminders featureご利用のプランにはリマインダーが含まれていません。プランをアップグレードしてください。ダウングレード後も、既存のリマインダーは実行され続けてクレジットを消費しますが、アップグレードするまで一覧の取得、キャンセル、一時停止はできません。
Error fetching reminders: …(HTTP 500サーバー側で問題が発生しました。もう一度お試しください。

api_keyが存在しないか削除されている場合、レスポンスはJSONではなく、HTTP 500のHTMLエラーページになります。認証情報の確認でキーをテストしてください。

すべてのページを読み取る#

リマインダーが50件未満のページが返るまで、次のページをリクエストし続けてください。

すべてのリマインダーを取得する
import requests

reminders, page = [], 1

while True:
    response = requests.post(
        "https://wbiztool.com/api/v1/reminder/list/",
        json={"client_id": 12345, "api_key": "YOUR_API_KEY", "page": page},
        timeout=60,
    )
    try:
        result = response.json()
    except ValueError:
        raise SystemExit(f"HTTP {response.status_code}: not JSON. Check that your api_key exists.")
    if result["status"] != 1:
        raise RuntimeError(result["message"])

    reminders += result["reminders"]
    if len(result["reminders"]) < result["page_size"]:
        break
    page += 1

print(len(reminders), "reminders")

ヒント#

  • 自分でコピーを保存する:このエンドポイントはtimezoneを返さないため、作成時に各リマインダーのtimezoneを保存しておいてください。
  • 一時停止中のリマインダーを見つけるis_activefalseのものを絞り込みます。再開はリマインダーページで行ってください。
  • 古い自動化を整理する:まずすべてのページからキャンセルしたいIDを集め、その後それぞれに対してリマインダーのキャンセルを呼び出してください。ページを読み進めながらキャンセルすると、後のリマインダーが前のページにずれるため、一部が読み飛ばされます。