現在は開発環境です。App がこのサーバーで登録して生成した Webhook を使ってください。
パラメーター
以下の名前はクエリ文字列、フォームデータ、JSON のどれでも使えます。名前の大文字と小文字は区別せず、値は文字列でも数値でもかまいません。Breeze は Bark と同じパラメーター名を使うため、ほとんどの Bark スクリプトはそのまま動きます。プラットフォーム列の「すべて」は iPhone と Android の両方を指します。
内容#
| パラメーター | 説明 | プラットフォーム |
|---|---|---|
title |
タイトル | すべて |
subtitle |
サブタイトル | すべて |
body |
本文。message も使えます |
すべて |
markdown |
Markdown の本文。バナーにはプレーンテキスト、履歴には整形済みの内容を表示します。body の代わりに使います |
すべて |
group |
通知センターと履歴でまとめるグループ。thread_id も使えます |
すべて |
url |
通知をタップしたときに開く HTTPS リンク | すべて |
image |
通知と履歴に表示する HTTPS 画像 | すべて |
icon |
送信者のアイコンとして表示する HTTPS 画像 | すべて |
copy |
通知の「コピー」でコピーする文字列。省略時は本文 | すべて |
autoCopy |
1 で、通知の到着時に copy(または本文)をクリップボードにコピー |
iOS |
badge |
アプリアイコンの数字。0 で消去 |
iOS |
サウンドと通知レベル#
| パラメーター | 説明 | プラットフォーム |
|---|---|---|
sound |
内蔵またはカスタムのサウンド名、または default。Android は default のみ。サウンドと通知レベルを参照 |
すべて |
call |
1 で、着信のようにサウンドを 30 秒間繰り返す |
iOS |
soundUrl |
この通知で鳴らす .caf サウンドへの HTTPS リンク(最大 6 MB) |
iOS |
level |
active(既定)、passive(音もバナーもなし)、timeSensitive(許可されていれば集中モードを突破)、critical(未対応) |
すべて |
volume |
重大な通知の音量(0〜1)。提供開始後に使用可能 | iOS |
通知の管理#
| パラメーター | 説明 | プラットフォーム |
|---|---|---|
id |
独自のメッセージ ID。同じ id の新しい通知が前の通知を置き換えます |
すべて |
delete |
1 と id を指定すると、その通知を端末から取り消します |
すべて |
ttl |
履歴に残す秒数。0 で保存しません |
すべて |
isArchive |
0 でこの通知を履歴に保存しません。1 で保存がオフでも保存します |
iOS |
collapse_id |
同じ値の未配信の通知を 1 つにまとめます。最大 64 バイト | すべて |
これらの組み合わせ方は更新と取り消しをご覧ください。
暗号化とフィルタ#
| パラメーター | 説明 | プラットフォーム |
|---|---|---|
ciphertext |
暗号化したパラメーター。暗号化を参照 | iOS |
iv |
ciphertext の IV。アプリに保存したものと異なる場合のみ |
iOS |
filter_criteria |
Breeze の集中モードフィルタで使う名前。例:work |
iOS |
別名#
Breeze は次の長い名前も受け付けます。両方を指定した場合は Bark の名前が優先されます。
| 名前 | 同じ意味 |
|---|---|
message |
body |
thread_id |
group |
open_url |
url |
image_url / icon_url |
image / icon |
sound_url |
soundUrl |
interruption_level |
level。time-sensitive も使えます |
Android は対応できないパラメーターを無視せず、HTTP 422 を返します。expiration_date、priority、data、Apple の生の payload などの高度なフィールドは API リファレンスをご覧ください。