通知API
[更新: 2025年2月10日]
概要
APIを利用することで、お客様の任意のタイミングで登録済みの通知先グループに通知を送信することが可能です。
※さくらのクラウドAPIの利用方法など、一般的な情報については APIドキュメント を参照ください。
API URL
APIを利用する際のベースURLは以下のものを使用します。
NOTIFICATION_GROUP_ID="対象の通知先グループのID"
https://secure.sakura.ad.jp/cloud/zone/is1a/api/cloud/1.1/commonserviceitem/${NOTIFICATION_GROUP_ID}/simplenotification/message
注意事項
APIを実行するためには、APIキーに「作成・削除」のアクセスレベルが必要になります。
詳細は、 アクセスレベルのページ をご覧ください。
使用例
APIキーの作成
APIキーの発行方法は APIキー をご覧ください。
通知の送信
あらかじめ通知先グループの詳細画面から、通知を送信する通知先グループの「リソースID」を確認します。
重要
通知は通知先グループに対してのみ送信可能です。
通知先のリソースIDを指定してもAPIを実行できませんのでご注意ください。
手順内で使用するパラメータは以下の通りです。
パラメータ |
説明 |
省略時のデフォルト値 |
|---|---|---|
アクセストークン |
APIキーのアクセストークンです。 |
省略不可 |
アクセストークンシークレット |
APIキーのアクセストークンシークレットです。 |
省略不可 |
NOTIFICATION_GROUP_ID |
通知先グループのリソースID |
省略不可 |
Message |
通知するメッセージ内容 |
省略不可 |
$ NOTIFICATION_GROUP_ID="123456789012"
$ curl -X POST \
-u "ACCESS_TOKEN:ACCESS_TOKEN_SECRET" \
-d '{"Message":"Hello world"}' \
https://secure.sakura.ad.jp/cloud/zone/is1a/api/cloud/1.1/commonserviceitem/${NOTIFICATION_GROUP_ID}/simplenotification/message
APIサーバからのレスポンスは以下のようになります。
{
"is_ok": true,
}
通知APIで送信されるメールの例
通知APIで送信されるメールの文面は以下のようになります。
さくらのクラウド シンプル通知サービスです。
以下のご契約においてメッセージを受信いたしました。
■ご契約情報
会員ID: {会員ID}
アカウントコード: {アカウントコード}
リソースID: {通知先グループのリソースID}
リソース名: {通知先グループの名称}
■メッセージ
{メッセージ本文}
シンプル通知サービスの詳細については以下URLをご確認ください。
▼さくらのクラウドマニュアル - シンプル通知
https://manual.sakura.ad.jp/cloud/appliance/simplenotification/index.html
ご不明な点やご質問等ございましたら、弊社カスタマーセンターまでお問い合わせください。
なお、弊社ではメッセージの内容に関するお問い合わせは、お答え致しかねます。
リソースの管理者様にご確認くださいますようお願い申し上げます。
今後ともさくらインターネットをよろしくお願いいたします。
─── さくらインターネット株式会社 カスタマーセンター ───────
■サポートサイト
https://help.sakura.ad.jp/
■カスタマーセンターへのお問い合わせ
https://help.sakura.ad.jp/contact/
メールは24時間365日受け付けております（返信は弊社営業時間内に行います）
■会員メニュー（契約内容の変更、請求内容や適格請求書の照会）
https://secure.sakura.ad.jp/auth/login
───────────────────────────────────