さくらのクラウド さくらのクラウド API ポータル クラウドマニュアルへ
API docs by Redocly

シンプル通知 API (1.0.0)

Download OpenAPI specification:Download OpenAPI Spec (YAML)Download OpenAPI Spec (JSON)

Copyright SAKURA internet Inc.

はじめに

「シンプル通知」は、メールや Webhook を利用し、任意のタイミングで通知を送信するサービスです。

基本的な使い方

APIキーの発行

APIを利用するためには、認証のための「APIキー」が必要です。事前にキーを発行しておきます。 APIキーは「ユーザーID」「パスワード」に相当する「トークン」と呼ばれる認証情報で構成されています。

項目名 APIキー発行時の項目名 このドキュメント内での例
ユーザーID アクセストークン(UUID) 01234567-89ab-cdef-0123-456789abcdef
パスワード アクセストークンシークレット SAMPLETOKENSAMPLETOKENSAMPLETOKENSAM
操作マニュアル

通知送信

通知送信関連のエンドポイント

メッセージの送信

指定した通知先グループに対してメッセージを送信します。

path Parameters
id
required
string^[0-9]{12}$
Request Body schema: application/json
Message
required
string <= 2048 characters

Responses

Request samples

Content type
application/json
{
  • "Message": "string"
}

Response samples

Content type
application/json
{
  • "is_ok": true
}

通知履歴

通知履歴関連のエンドポイント

通知履歴の一覧取得

通知履歴の一覧取得。 直近30日間以内の通知送信履歴が最大100件まで取得可能です。

Responses

Response samples

Content type
application/json
{
  • "NotificationHistories": [
    ]
}

通知履歴の取得

指定したrequest_idに対応する通知履歴の取得。

path Parameters
request_id
required
string^[0-9]+$

Responses

Response samples

Content type
application/json
{
  • "NotificationHistory": {
    }
}

通知先

通知先関連のエンドポイント

リソースの一覧取得

リソースの一覧取得。クエリパラメータにて下記のようにProvider.Classを指定してフィルタを設定することで通知先、通知先グループまたは通知ルーティングのリソースのみを取得できます。

  • 通知先: /commonserviceitem?{"Filter":{"Provider.Class":"saknoticedestination"}}
  • 通知先グループ: /commonserviceitem?{"Filter":{"Provider.Class":"saknoticegroup"}}
  • 通知ルーティング: /commonserviceitem?{"Filter":{"Provider.Class":"saknoticerouting"}}

Responses

Response samples

Content type
application/json
Example
{
  • "From": 0,
  • "Count": 2,
  • "Total": 2,
  • "CommonServiceItems": [
    ]
}

リソースの作成

リソースの作成。Provider.Classの値に応じて必要なSettingsの内容が異なります。

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
Example
{
  • "CommonServiceItem": {
    }
}

Response samples

Content type
application/json
{
  • "CommonServiceItem": {
    }
}

リソースの取得

リソースの取得。取得されたCommonServiceItemのProvider.Classの値に応じてSettingsの内容は異なります。

path Parameters
id
required
string^[0-9]{12}$

Responses

Response samples

Content type
application/json
Example
{
  • "CommonServiceItem": {
    }
}

リソースの更新

リソースの更新。更新されるCommonServiceItemのProvider.Classの値に応じてSettingsの内容は異なります。

path Parameters
id
required
string^[0-9]{12}$
Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
Example
{
  • "CommonServiceItem": {
    }
}

Response samples

Content type
application/json
{
  • "CommonServiceItem": {
    }
}

リソースの削除

リソースの削除。

path Parameters
id
required
string^[0-9]{12}$

Responses

Response samples

Content type
application/json
{
  • "CommonServiceItem": {
    }
}

通知先ステータス情報の取得

通知先が通知送信可能かどうかのステータス情報を取得します。

path Parameters
id
required
string^[0-9]{12}$

Responses

Response samples

Content type
application/json
{
  • "NotificationStatus": {
    }
}

通知先グループ

通知先グループ関連のエンドポイント

リソースの一覧取得

リソースの一覧取得。クエリパラメータにて下記のようにProvider.Classを指定してフィルタを設定することで通知先、通知先グループまたは通知ルーティングのリソースのみを取得できます。

  • 通知先: /commonserviceitem?{"Filter":{"Provider.Class":"saknoticedestination"}}
  • 通知先グループ: /commonserviceitem?{"Filter":{"Provider.Class":"saknoticegroup"}}
  • 通知ルーティング: /commonserviceitem?{"Filter":{"Provider.Class":"saknoticerouting"}}

Responses

Response samples

Content type
application/json
Example
{
  • "From": 0,
  • "Count": 2,
  • "Total": 2,
  • "CommonServiceItems": [
    ]
}

リソースの作成

リソースの作成。Provider.Classの値に応じて必要なSettingsの内容が異なります。

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
Example
{
  • "CommonServiceItem": {
    }
}

Response samples

Content type
application/json
{
  • "CommonServiceItem": {
    }
}

リソースの取得

リソースの取得。取得されたCommonServiceItemのProvider.Classの値に応じてSettingsの内容は異なります。

path Parameters
id
required
string^[0-9]{12}$

Responses

Response samples

Content type
application/json
Example
{
  • "CommonServiceItem": {
    }
}

リソースの更新

リソースの更新。更新されるCommonServiceItemのProvider.Classの値に応じてSettingsの内容は異なります。

path Parameters
id
required
string^[0-9]{12}$
Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
Example
{
  • "CommonServiceItem": {
    }
}

Response samples

Content type
application/json
{
  • "CommonServiceItem": {
    }
}

リソースの削除

リソースの削除。

path Parameters
id
required
string^[0-9]{12}$

Responses

Response samples

Content type
application/json
{
  • "CommonServiceItem": {
    }
}

通知ルーティング

通知ルーティング関連のエンドポイント

リソースの一覧取得

リソースの一覧取得。クエリパラメータにて下記のようにProvider.Classを指定してフィルタを設定することで通知先、通知先グループまたは通知ルーティングのリソースのみを取得できます。

  • 通知先: /commonserviceitem?{"Filter":{"Provider.Class":"saknoticedestination"}}
  • 通知先グループ: /commonserviceitem?{"Filter":{"Provider.Class":"saknoticegroup"}}
  • 通知ルーティング: /commonserviceitem?{"Filter":{"Provider.Class":"saknoticerouting"}}

Responses

Response samples

Content type
application/json
Example
{
  • "From": 0,
  • "Count": 2,
  • "Total": 2,
  • "CommonServiceItems": [
    ]
}

リソースの作成

リソースの作成。Provider.Classの値に応じて必要なSettingsの内容が異なります。

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
Example
{
  • "CommonServiceItem": {
    }
}

Response samples

Content type
application/json
{
  • "CommonServiceItem": {
    }
}

リソースの取得

リソースの取得。取得されたCommonServiceItemのProvider.Classの値に応じてSettingsの内容は異なります。

path Parameters
id
required
string^[0-9]{12}$

Responses

Response samples

Content type
application/json
Example
{
  • "CommonServiceItem": {
    }
}

リソースの更新

リソースの更新。更新されるCommonServiceItemのProvider.Classの値に応じてSettingsの内容は異なります。

path Parameters
id
required
string^[0-9]{12}$
Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
Example
{
  • "CommonServiceItem": {
    }
}

Response samples

Content type
application/json
{
  • "CommonServiceItem": {
    }
}

リソースの削除

リソースの削除。

path Parameters
id
required
string^[0-9]{12}$

Responses

Response samples

Content type
application/json
{
  • "CommonServiceItem": {
    }
}

通知ルーティングの並び替え

通知ルーティングの優先順位を並び替えます。 PriorityRankの値は他の通知ルーティングと重複しないように指定する必要があります。

Request Body schema: application/json
required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "Orders": [
    ]
}

Response samples

Content type
application/json
{
  • "is_ok": true
}

通知元一覧の取得

通知ルーティングに設定する通知元の情報を取得します。

Responses

Response samples

Content type
application/json
{
  • "Sources": [
    ]
}