カテゴリー内の他の記事

通知の登録(POST)

フォローする

Index

通知の登録

通知を登録することができます。
アプリケーション管理のAPIの外部通知の設定が必要です。Garoon ヘルプ - APIの外部通知の設定 クラウド版 をご確認ください。

HTTP メソッド

POST

URI

クラウド版

https://(サブドメイン名).cybozu.com/g/api/v1/notification/items

パッケージ版(Windows環境)

http://(サーバーのIPアドレスまたはホスト名)/scripts/(インストール識別子)/grn.exe/api/v1/notification/items

パッケージ版(Linux環境)

http://(サーバーのIPアドレスまたはホスト名)/cgi-bin/(インストール識別子)/grn.cgi/api/v1/notification/items

使用可能なガルーンのバージョン

  • クラウド版 Garoon
  • パッケージ版 Garoon バージョン 5.0.0以降

必要なアクセス権

  • 通知を登録するアプリケーションの利用権限
  • アプリケーション管理のAPIの外部通知が有効になっている

リクエストの例 

POST /g/api/v1/notification/items HTTP/1.1
  Host: {subdomain}.cybozu.com:443
  X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=
  Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU=
Content-Type: application/json
  • Content-Type に application/json を指定して下さい。 指定しない場合は JSON が解釈できないため、実行時エラーとなります。

リクエストボディ

リクエストボディには、次のパラメータが必須です。

  1. app
  2. notificationKey
  3. operation
  4. url
  5. title
  6. destinations
     ①type ②idまたはcode が必須です。

以下に、外部サービスのConcurの通知をGaroonに登録する例を記載します。

パラメータ 指定する値 説明
app 文字列 外部通知コード
Garoonのアプリケーションの管理で設定されている「外部通知コード」を指定します。
設定方法はヘルプをご参照ください。
notificationKey 文字列 通知キー
複数のユーザーに対して通知を作成する場合、このキーはすべてのユーザーで同じです。
過去に登録した通知と同じ値のKeyを指定すると、その通知が更新されます。
operation 文字列

通知操作の概要。
次の3つの値から1つを指定できます。

  • add
  • modify
  • remove
url 文字列 通知に含まれるURL
URLをGaroonのアプリケーションの管理で設定されている「許可するURL」に設定する必要があります。
設定方法はヘルプをご参照ください。
title 文字列 通知タイトル
body 文字列 通知本文
icon 文字列

通知アイコン 
URL指定のみ可能です。
URLをGaroonのアプリケーションの管理で設定されている「許可するURL」に設定する必要があります。
設定方法はヘルプをご参照ください。

destinations 配列 通知先のリスト
destinations[].id 数値 通知先のGaroonユーザーID
destinations[].type 文字列 通知先のタイプ
destinations[].code 文字列 通知先のGaroonユーザー名

レスポンスの例

処理が成功すると、通知の内容がJSON形式で返されます。 

プロパティ

プロパティ名 説明
moduleId 文字列

GaroonのユーザーID

creator.id

数値 

通知の作成者のGaroonユーザーID

creator.code

文字列 

通知の作成者のGaroonユーザー名

creator.name 文字列 

通知の作成者のGaroonユーザーログイン名

createdAt 文字列 

通知の作成日時

operation 文字列 

通知操作の概要
次の3つの値から1つを指定できます。

  • add
  • modify
  • remove
url 文字列 

通知に含まれるURL

title 文字列 

通知タイトル

body 文字列 

通知本文

icon 文字列 

通知アイコン
サンプルアイコンまたはURIを指定できます。

isRead 真偽値

通知が既読かどうか 

制限事項

共通仕様の制限事項 をご確認ください。

記事に関するフィードバック

直接的に記事と関連がないご質問はcybozu developer コミュニティをご活用ください。

ログインしてコメントを残してください。