クイックスタート
3つのステップで最初のプッシュ通知を送ります。
1. プッシュグループを開始する
groupはユーザーに表示される名前です。pushGroupIdはグループを示す任意のテキストです。以降のすべての呼び出しで同じ値を送ります。
1 2 3 4 5 6 7 8 9 10 11 12
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.png" } }'
レスポンス（201）には参加ボタンであるlinks.iframeが含まれます。POST /api/push/startを参照してください。
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>" } }
2. ユーザーに参加してもらう
links.iframeをWebページに貼り付けます。スマートフォンではタップでグループに参加できます。パソコンではクリックすると、スマートフォンのカメラでスキャンするQRコードが表示されます。色を変えたり暗いページで使ったりするには、起動ボタンを参照してください。
3. 通知を送る
グループ内のすべてのスマートフォンに届きます。POST /api/push/sendを参照してください。
1 2 3 4 5 6 7 8 9 10 11
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" }'
レスポンスのtargetedは、送信先のスマートフォンの台数です。誰かが参加するまでは0で、その場合は何も請求されません。
