通知の登録
通知を登録することができます。
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の外部通知を有効にしてください。
設定方法は、Garoon ヘルプ - 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 が解釈できないため、実行時エラーとなります。
リクエストボディ
| パラメータ | 指定する値 | 必須 | 説明 |
|---|---|---|---|
| app | 文字列 | 必須 |
外部通知コード Garoonのアプリケーションの管理で設定されている「外部通知コード」を指定します。 |
| notificationKey | 文字列 | 必須 |
通知キー 複数のユーザーに対して通知を作成する場合、このキーはすべてのユーザーで同じです。 |
| operation | 文字列 | 必須 |
通知操作の概要 通知の種類を表す項目です。次のいずれかの値を指定します。
|
| url | 文字列 | 必須 |
通知に含まれるURL URLをGaroonのアプリケーションの管理で設定されている「許可するURL」に設定する必要があります。 |
| title | 文字列 | 必須 | 通知タイトル |
| body | 文字列 | 必須 | 通知本文 |
| icon | 文字列 | 省略可 |
通知アイコン URL指定のみ可能です。 |
| destinations | 配列 | 必須 | 通知先のリスト |
| destinations[].type | 文字列 | 必須 |
通知先のタイプ
|
| destinations[].id | 数値 | 条件必須 |
通知先の Garoon ユーザー ID |
| destinations[].code | 文字列 | 条件必須 |
通知先の Garoon ユーザー名（ログイン名） |
以下に、外部サービスのConcurの通知をGaroonに登録する例を記載します。
レスポンスの例
処理が成功すると、通知の内容がJSON形式で返されます。
プロパティ
| プロパティ名 | 型 | 説明 |
|---|---|---|
| moduleId | 文字列 |
GaroonのユーザーID |
| creator.id |
数値 |
通知の作成者のGaroonユーザーID |
|
creator.code |
文字列 |
通知の作成者のGaroonユーザー名 |
| creator.name | 文字列 |
通知の作成者のGaroonユーザーログイン名 |
| createdAt | 文字列 |
通知の作成日時 |
| operation | 文字列 |
通知操作の概要 通知の種類を表す項目です。次のいずれかの値を指定します。
|
| url | 文字列 |
通知に含まれるURL |
| title | 文字列 |
通知タイトル |
| body | 文字列 |
通知本文 |
| icon | 文字列 |
通知アイコン |
| isRead | 真偽値 |
通知が既読かどうか |
JavaScript サンプル
XMLHttpRequest
制限事項
共通仕様の制限事項 をご確認ください。
記事に関するフィードバック
記事のコメント欄は記事に対するフィードバックをする場となっております。
右の記事フィードバックのためのガイドを参照してコメントしてください。
記事のリンク切れなど、気になる点がある場合も、こちらのフォームからフィードバックいただけますと幸いです。