POST /api/push/start
プッシュグループを作成し、その参加ボタンを取得します。
APIキーをx-api-keyヘッダーで送ります。グループの作成は請求されません。エラーの一覧はエラーと制限にあります。
本文
| フィールド | 型 | 説明 |
|---|---|---|
group | string | 必須。アプリでユーザーに表示されるグループ名。 |
pushGroupId | string | 必須。グループを示す任意のテキスト。すべての送信とブランディングの呼び出しで使います。 |
brand | object | グループのブランド。下記を参照してください。 |
reuse | boolean | trueにすると、参加したスマートフォンごとにグループの専用のコピーが作られ、各スマートフォンが参加元のWebサイトを記録します。どちらの場合も、送信はすべてのスマートフォンに届きます。 |
brandオブジェクト
| フィールド | 型 | 説明 |
|---|---|---|
logo | string | 正方形の画像URL。すべての通知とアプリで、グループの画像になります。 |
name | string | アプリに表示されるブランド名。省略するとブランド名は表示されません。 |
description | string | アプリに表示される、グループについての短い説明。 |
brand.colorとbrand.titleはライブアクティビティ用のフィールドです。プッシュグループでは無視されます。
例
1 2 3 4 5 6 7 8 9 10 11 12 13
curl -X POST https://api.webliveactivity.com/api/push/start \ -H 'Content-Type: application/json' \ -H 'x-api-key: wla_your_key' \ -d '{ "group": "Acme Orders", "pushGroupId": "acme-orders", "reuse": true, "brand": { "name": "Acme", "logo": "https://acme.example/logo.webp", "description": "Order updates from Acme" } }'
レスポンス
201を返します。groupIdは参加ボタンが使うIDです。links.iframeをWebページに置きます。ボタンは起動ボタンと同じように動作し、ボタンの種類はnotify、subscribe、followです。
1 2 3 4 5 6 7 8
{ "ok": true, "groupId": "pg-7hk3mzq2wd9x", "pushGroupId": "acme-orders", "links": { "iframe": "<iframe src=\"https://api.webliveactivity.com/embed/button?type=notify&userId=pg-7hk3mzq2wd9x\" width=\"340\" height=\"95\" style=\"border:0;color-scheme:light\"></iframe>" } }
注意事項
- 開始するたびに新しい参加ボタンが作られます。同じ
pushGroupIdで再び開始すると同じグループにボタンが追加され、どちらのボタンから参加したスマートフォンにも送信が届きます。 - あとから名前やブランドを変更するには、POST /api/push/brandingを使います。
- プッシュグループはWebhookを送りません。
