curlでAndroidに通知を送る
自動化に組み込む前に、ターミナルから手動で通知を送って試します。
QuickStart
必要な環境: Bash + curl
- AndroidにQueueRingをインストールし、端末登録と通知の許可を済ませて、現在のQueue IDをコピーします。端末をオンラインにしてください。
- Bashに貼り付け、入力が表示されないプロンプトにQueue IDを入力してください。
- 端末で結果を確認する
Queue IDは送信権限を与える秘密です。公開せず、漏えい時はアプリで再発行して設定を更新してください。秘密管理の詳細。
202は受理のみで、端末表示・履歴保存・IDの有効性は保証されません。再送により重複する場合があります。再試行は通知だけにし、ジョブやagentをやり直さないでください。HTTPエラーと再試行の対処。
(
set +x
set -eu
read -r -s -p 'Paste the Queue ID from your Android app: ' QUEUE_ID
printf '\n'
set +x
: "${QUEUE_ID:?Load your Queue ID before sending}"
[[ "$QUEUE_ID" =~ ^qr1\.[A-Za-z0-9_-]{1,16}\.[A-Za-z0-9_-]{59}$ ]] || {
printf 'Invalid Queue ID format; copy it from the app.\n' >&2
exit 1
}
message=$(printf '%s\n' 'Deployment completed' 'Check the release on Android.')
status=$(curl --silent --connect-timeout 10 --max-time 30 \
--output /dev/null --dump-header /dev/stderr --write-out '%{http_code}' \
--request POST "https://api.queuering.org/q/$QUEUE_ID" \
--header 'Content-Type: text/plain; charset=utf-8' \
--data-binary "$message") || {
printf 'Notification transport failed; check connectivity.\n' >&2
exit 1
}
printf 'Notification HTTP %s\n' "$status" >&2
[[ "$status" == 202 ]]
)ボタンはコードだけをコピーします。使えない場合はコードを選択して手動でコピーしてください。コード内の表示メッセージは英語版と共通です。
端末で結果を確認する
HTTP 202が返り、Deployment completedで始まる2行の通知が端末に表示されることを確認します。QueueRingを開き、最近の履歴にもメッセージが記録されたかを確認してください。
HTTP 202が返っても端末に通知が出ない場合は、現在のQueue ID・Androidの通知権限・端末の接続状態を先に確認してください。アプリの最近の履歴は追加の確認材料であり、配信を証明する受領記録ではありません。
追加例と外部連携の制限
連携の手順と制限
LinuxまたはmacOSのBashとcurl、インターネット接続が必要です。
タイトル付きのJSONを送る
次の独立したBashの例を貼り付け、非表示のプロンプトへQueue IDを入力してください。JSONのbodyは空でない文字列が必須です。titleは省略できますが、指定する場合は空白だけにしないでください。JSON全体を単一引用符で囲むと、引用符と改行のエスケープをそのまま渡せます。動的な値は文字列連結せず、jqやJSON.stringifyなどのJSONエンコーダーで組み立ててください。
(
set +x
set -eu
read -r -s -p 'Paste the Queue ID from your Android app: ' QUEUE_ID
printf '\n'
set +x
: "${QUEUE_ID:?Load your Queue ID before sending}"
[[ "$QUEUE_ID" =~ ^qr1\.[A-Za-z0-9_-]{1,16}\.[A-Za-z0-9_-]{59}$ ]] || {
printf 'Invalid Queue ID format; copy it from the app.\n' >&2
exit 1
}
status=$(curl --silent --connect-timeout 10 --max-time 30 \
--output /dev/null --dump-header /dev/stderr --write-out '%{http_code}' \
--request POST "https://api.queuering.org/q/$QUEUE_ID" \
--header 'Content-Type: application/json' \
--data-binary '{"title":"Build finished","body":"Result: \"success\"\nReady to review."}') || {
printf 'Notification transport failed; check connectivity.\n' >&2
exit 1
}
printf 'Notification HTTP %s\n' "$status" >&2
[[ "$status" == 202 ]]
)HTTP 202と、端末上のBuild finishedというタイトルを確認します。この固定値の例にはJSONエンコーダーは不要です。
Queue IDの秘密管理の詳細
Queue IDを秘密として管理する
Queue IDを知る人は端末に通知を送れます。送信権限を与える認証情報として扱い、実IDを公開リポジトリ・Issue・ログ・スクリーンショット・プロンプト・サンプルの固定値に載せないでください。シェルトレース（set -x）、curlのverbose/trace出力、共有するターミナル録画は使わないでください。URLやプロセスの引数にIDが含まれるため、信頼できる端末でだけ実行し、プロキシやアクセスログへの記録も制限してください。
漏えいした場合は、アプリでQueue IDを再発行し、古いIDを使うすべてのローカル設定やActions secretsを更新してください。古い値を編集せず、アプリから新しい値をコピーします。202応答では古いIDがまだ有効かどうかを確認できません。
API契約・HTTPエラー・再試行
応答の意味と安全な再試行
通知とメッセージ履歴はベストエフォートです。HTTP 202はリクエストの受理を示し、Androidでの表示や履歴への保存を保証しません。無効・非アクティブ・古いQueue IDにも意図的に同じ202を返すため、IDの有効性も判断できません。履歴には端末で取得できたメッセージを最大100件保存します。履歴にないことだけでは、HTTP処理の失敗とは判断できません。
送信先はPOST https://api.queuering.org/q/{queueId}です。UTF-8のtext/plain; charset=utf-8、またはapplication/jsonを使います。JSONでは空でないbody文字列が必須で、titleは任意ですが、指定する場合は空白だけにしないでください。JSON構文も含めたリクエスト本文全体の上限は4096 bytesです。
| 結果 | 対処 |
|---|---|
| 202 | Androidの通知権限・接続状態と、アプリの現在のQueue IDを確認します。通知が表示されないという理由だけで再送しないでください。 |
| 400 | リクエスト、Content-Type、JSON構文、必須フィールドを修正してから再送します。 |
| 413 | UTF-8本文を4096 bytes以下に短くします。JSONのエスケープも容量に含まれます。 |
| 429 | Retry-Afterがあれば、指定された秒数以上待ちます。なければ待ち時間を増やしながら、回数を制限して再試行します。短い間隔で繰り返さないでください。 |
| 503 | 一時的に利用できません。障害を確認し、待ち時間を増やしながら、回数を制限して後で再試行します。 |
| 通信失敗・タイムアウト | 結果が不明な場合があります。接続状態を確認してから再送するか判断してください。 |
サンプルは接続タイムアウト10秒・全体タイムアウト30秒で1回だけ送信します。HTTPステータスとRetry-Afterを含む応答ヘッダーを出力し、自動では再試行しません。再送すると通知が重複する可能性があります。この例には冪等性キーはありません。再試行するのは通知だけにし、状態を知らせるためにバックアップ・デプロイ・agentの本体処理をやり直さないでください。通常のジョブログや監視を判断の根拠にしてください。