通知 API

通知を表示した際のイベントを受け取るための設定を行う

通知を表示した際にWebSocket経由でイベントを受け取るためのセッションキーを登録します。

基本情報

APIパス : /gotapi/notification/onshow

HTTPメソッド : PUT

リクエスト

HTTPヘッダー

ヘッダーの種類 内容
Content-Type application/json

パラメータ

キー 必須 場所 説明
serviceId 文字列 クエリー サービスID
accessToken 文字列 クエリー アクセストークン
sessionKey 文字列 クエリー WebSocketでイベントを受け取るためのユニークなキー

レスポンス

HTTPレスポンス

HTTPステータスコード 内容
200

エラーについては エラーについて を参照してください。

レスポンス内容

キー
result 数値
product 文字列
version 文字列

通知がタップされた際のイベントを受け取るための設定を行う

通知がタップされた際にWebSocket経由でイベントを受け取るためのセッションキーを登録します。

基本情報

APIパス : /gotapi/notification/onclick

HTTPメソッド : PUT

リクエスト

HTTPヘッダー

ヘッダーの種類 内容
Content-Type application/json

パラメータ

キー 必須 場所 説明
serviceId 文字列 クエリー サービスID
accessToken 文字列 クエリー アクセストークン
sessionKey 文字列 クエリー WebSocketでイベントを受け取るためのユニークなキー

レスポンス

HTTPレスポンス

HTTPステータスコード 内容
200

エラーについては エラーについて を参照してください。

レスポンス内容

キー
result 数値
product 文字列
version 文字列

通知が閉じられた際のイベントを受け取るための設定を行う

通知が閉じられた際にWebSocket経由でイベントを受け取るためのセッションキーを登録します。

基本情報

APIパス : /gotapi/notification/onclose

HTTPメソッド : PUT

リクエスト

HTTPヘッダー

ヘッダーの種類 内容
Content-Type application/json

パラメータ

キー 必須 場所 説明
serviceId 文字列 クエリー サービスID
accessToken 文字列 クエリー アクセストークン
sessionKey 文字列 クエリー WebSocketでイベントを受け取るためのユニークなキー

レスポンス

HTTPレスポンス

HTTPステータスコード 内容
200

エラーについては エラーについて を参照してください。

レスポンス内容

キー
result 数値
product 文字列
version 文字列