SENSの概要

Prev Next

Classic/VPC環境で利用できます。

Simple & Easy Notification Serviceは、別途のメッセージサーバを構築せずに、さまざまなメッセージタイプ(SMS、通知トーク、友達トーク、ブランドメッセージ)の通知メッセージ機能を実装できる NAVERクラウドプラットフォームのサービスです。Simple & Easy Notification Serviceは、メッセージの送信および管理機能関連の APIを RESTful形式で提供します。

Simple & Easy Notification Serviceの共通設定

Simple & Easy Notification Service APIで共通して使用されるリクエスト形式とレスポンス形式を説明します。

リクエスト

共通リクエスト形式を説明します。

API URL

リクエスト API URLは次の通りです。

https://sens.apigw.ntruss.com

リクエストヘッダ

リクエストヘッダの説明は次の通りです。

フィールド 必須の有無 説明
x-ncp-apigw-timestamp Required 1970年1月1日00:00:00協定世界時(UTC)からの経過時間(ミリ秒)
  • API Gatewayサーバとの時間差が5分以上の場合は無効なリクエストとみなす
  • Unix Timestamp形式
x-ncp-iam-access-key Required NAVERクラウドプラットフォームから発行された Access Key
x-ncp-apigw-signature-v2 Required NAVERクラウドプラットフォームから発行された Access Keyとマッピングする Secret Keyと HMAC暗号化アルゴリズム(HmacSHA256)でリクエスト情報を暗号化した後、Base64にエンコードした署名
Content-Type Required リクエストデータの形式
  • application/json

レスポンス

共通レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

error
errorは API呼び出し失敗情報を定義します。errorの説明は次の通りです。

フィールド タイプ 必須の有無 説明
status Integer Required エラーコード
errors String Required エラー名
errorMessage String Required エラーメッセージ

レスポンスステータスコード

レスポンスステータスコードの説明は次の通りです。

HTTPステータスコード メッセージ 説明
200 OK リクエスト成功
202 Accepted リクエスト成功
204 No Content リクエスト成功
400 Bad Request 無効なリクエスト
401 Unauthorized 認証失敗
403 Forbidden アクセス権限なし
404 Not Found リソースが見つからない
429 Too Many Requests リクエスト回数超過
500 Internal Server Error サーバ内部エラー
参考

NAVERクラウドプラットフォームで共通して使用されるレスポンスステータスコードの詳細は、Ncloud APIのレスポンスステータスコードをご参照ください。

レスポンス例

呼び出しが成功した場合のレスポンス例は、API仕様書を確認してください。呼び出しに失敗した場合のレスポンスのサンプルコードは次の通りです。

{
    "status": 403,
    "error": "Forbidden",
    "message": "Do not have access to this 'serviceId'"
}

Simple & Easy Notification Service API

Simple & Easy Notification Serviceサービスで提供する APIの説明は次の通りです。

プロジェクト

プロジェクト関連 APIの説明は次の通りです。

API 説明
プロジェクトの作成 プロジェクトを作成
プロジェクトリストの照会 プロジェクトリストを照会
プロジェクトの照会 プロジェクトの詳細情報を照会
プロジェクトの更新 プロジェクト情報の更新
プロジェクトの削除 プロジェクトの削除

SMS

SMS関連 APIの説明は次の通りです。

API 説明
メッセージの送信 SMS/LMS/MMSメッセージを送信
メッセージ送信リストの照会 メッセージ送信リストを照会
メッセージ送信結果の照会 メッセージ送信結果を照会
メッセージ予約状態の照会 メッセージ送信予約状態を照会
メッセージ予約のキャンセル メッセージ送信予約をキャンセル
受信拒否番号の登録 受信拒否番号を登録
受信拒否番号の照会 受信拒否番号を照会
受信拒否番号の削除 受信拒否番号を削除
添付ファイルのアップロード MMS送信用ファイルをアップロード

通知トーク

通知トーク関連 APIの説明は次の通りです。

API 説明
チャンネルの照会 通知トークチャンネルを照会
テンプレートの照会 通知トークテンプレートを照会
メッセージの送信 通知トークメッセージを送信
メッセージ送信リストの照会 通知トーク送信リクエストを照会
メッセージ送信結果の照会 通知トーク送信結果を照会
メッセージ予約状態の照会 通知トーク送信予約状態を照会
メッセージ予約のキャンセル 通知トーク送信予約をキャンセル

友達トーク

友達トーク関連 APIの説明は次の通りです。

API 説明
チャンネルの照会 友達トークチャンネルを照会
友達トークの送信 友達トークメッセージを送信
友達トーク送信リストの照会 友達トーク送信リストを照会
友達トーク送信結果の照会 友達トーク送信結果を照会
メッセージ予約状態の照会 友達トーク送信予約状態を照会
メッセージ予約のキャンセル 友達トーク送信予約をキャンセル
画像のアップロード 友達トークに使用する画像をアップロード
画像リストの照会 アップロードされた画像リストを照会
画像の照会 アップロードされた画像の詳細情報を照会
画像の削除 アップロードされた画像を削除

ブランドメッセージ

ブランドメッセージ関連 APIの説明は次の通りです。

API 説明
メッセージの送信 ブランドメッセージを送信
メッセージ送信リストの照会 ブランドメッセージ送信リストを照会
メッセージ送信結果の照会 ブランドメッセージ送信結果を照会
テンプレートリストの照会 ブランドメッセージテンプレートリストを照会
画像のアップロード ブランドメッセージに使用する画像をアップロード
画像リストの照会 アップロードされた画像リストを照会
画像の照会 アップロードされた画像の詳細情報を照会
画像の削除 アップロードされた画像を削除

Simple & Easy Notification Service関連リソース

Simple & Easy Notification Service APIについてユーザーの理解に役立つよう、さまざまな関連リソースを提供しています。