POST /api/push/send
プッシュグループ内のすべてのスマートフォンに通知を送ります。
本文
| フィールド | 型 | 説明 |
|---|---|---|
pushGroupId | string | 必須。送信先のグループ。 |
title | string | 太字の1行目。タイトル、メッセージ、またはその両方を送ります。 |
subtitle | string | タイトルの下の行。 |
message | string | 本文のテキスト。タイトル、メッセージ、またはその両方を送ります。 |
imageUrl | string | 通知と一緒に表示される画像。WebP、PNG、JPEG。 |
actionURL | string | タップで開くページ。http://またはhttps://で始まる必要があります。省略すると、タップでアプリのグループが開きます。 |
name | string | ダッシュボードのログに表示される、このメッセージのラベル。スマートフォンには表示されません。 |
例
1 2 3 4 5 6 7 8 9 10 11 12
curl -X POST https://api.webliveactivity.com/api/push/send \ -H 'Content-Type: application/json' \ -H 'x-api-key: wla_your_key' \ -d '{ "pushGroupId": "acme-orders", "title": "Your order shipped!", "subtitle": "Order #1234", "message": "Your package is on the way. Expected delivery: tomorrow by 5 PM.", "imageUrl": "https://acme.example/shipped.webp", "actionURL": "https://acme.example/orders/1234", "name": "Shipping notice" }'
レスポンス
targetedは通知を送信したスマートフォンの台数です。誰も参加していない場合は0で、その場合は何も請求されません。
1 2 3 4 5 6
{ "ok": true, "targeted": 42, "groupId": "pg-7hk3mzq2wd9x", "pushGroupId": "acme-orders" }
配信
- 送信はすぐに行われます。ライブアクティビティの更新のようにまとめられることはなく、2回送れば2件の通知になります。
- どの通知も、スマートフォンで音やバナーで知らせます。静かに送る方法はありません。
- 電源が切れていたスマートフォンには、最大3日後まで、再び電源が入ったときに届きます。iPhoneでは最新の1件だけが残ります。
- 受け取ったスマートフォン1台ごとに1プッシュと数えます。配信と請求を参照してください。
エラー
| ステータス | 意味 |
|---|---|
| 400 | pushGroupIdがない、titleもmessageもない、またはactionURLがhttpでもhttpsでもない。 |
| 402 | FREE_TIER_LIMIT_REACHED：無料プランの毎月のプッシュ数を使い切りました。誰かが参加している場合のみです。 |
| 413 | 通知が4KBを超えています。テキストを短くします。 |
その他のエラーはすべてエラーと制限にあります。
