一覧¶
GET /api/v1/channel/quick_list
概要¶
現在のワークスペースのチャンネル簡易情報と、現在の呼び出し元 ID の購読状態を取得します。
呼び出し前の準備と使用手順¶
対象ワークスペースでこの API の権限を持つ API Key を使用して呼び出します。Query パラメータは不要です。結果は content 配列に直接格納され、ページネーションはありません。デフォルトチャンネルが先頭に並び、それ以外は現在の呼び出し元 ID のピン留め時刻の降順、次に作成時刻の降順で並びます。
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証情報。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。 |
パラメータの補足説明¶
一覧で返される uuid は、このモジュールの変更、削除、購読 API にそのまま使用できます。
リクエスト例¶
レスポンス¶
HTTP 200、application/json。以下の例は、直接読み取れる主要なフィールドを示しています。
| フィールド | 型 | 説明 |
|---|---|---|
| content | array<object> |
チャンネル一覧。結果がない場合は空の配列です。 |
| content[].id | integer | データベースのレコード番号。チャンネルの操作には uuid を使用してください。 |
| content[].uuid | string | チャンネル UUID。変更、削除、購読に使用します。 |
| content[].workspaceUUID | string | チャンネルが属するワークスペース。 |
| content[].name | string | チャンネル名。default はデフォルトチャンネルを表します。 |
| content[].description | string | チャンネルの説明。 |
| content[].notifyTarget | array<string> |
このチャンネルに直接設定された通知先の UUID。 |
| content[].notifyTarget[] | string | 個々の通知先 UUID。 |
| content[].notifyUpgradeCfg | object | エスカレーション通知設定。未設定の場合は空のオブジェクトです。 |
| content[].notifyUpgradeCfg.triggerTime | integer | エスカレーション通知をトリガーするまでの待機時間(秒)。 |
| content[].notifyUpgradeCfg.notifyTarget | array<string> |
エスカレーション通知先 UUID のリスト。 |
| content[].notifyUpgradeCfg.notifyTarget[] | string | エスカレーション通知先 UUID。 |
| content[].status | integer | レコード状態。正常は 0 です。 |
| content[].creator | string | 作成した呼び出し元 ID。 |
| content[].updator | string | 最後に更新した呼び出し元 ID。未更新の場合は空文字列になることがあります。 |
| content[].createAt | integer | 作成日時(Unix 秒)。 |
| content[].updateAt | integer | 更新日時(Unix 秒)。未更新の場合は -1 です。 |
| content[].deleteAt | integer | 削除日時(Unix 秒)。未削除の場合は -1 です。 |
| content[].pinnedAt | integer | 現在の呼び出し元 ID によるピン留め時刻(Unix 秒)。ピン留めされていない場合は -1 です。 |
| content[].subscribeType | string | 現在の呼び出し元 ID の購読タイプ: responsible は責任者、participate は参加者、attention はフォロワー。未購読または解除済みの場合は空文字列です。 |
| content[].declaration | object または null | ワークスペースの共通宣言。 |
{
"code": 200,
"content": [
{
"id": 42,
"uuid": "chan_example",
"workspaceUUID": "wksp_example",
"name": "生产异常",
"description": "生产异常协作频道",
"notifyTarget": [
"notify_example"
],
"notifyUpgradeCfg": {
"triggerTime": 300,
"notifyTarget": [
"notify_example"
]
},
"status": 0,
"creator": "wsak_example",
"updator": "",
"createAt": 1785427200,
"updateAt": -1,
"deleteAt": -1,
"pinnedAt": -1,
"subscribeType": "",
"declaration": {}
}
],
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
エラー応答¶
認証、レート制限、共通リクエストエラーの詳細は共通エラー定義を参照してください。
チャンネルがない場合、成功時は空の配列を返します。この API には追加の業務 Query 宣言はありません。認証およびレート制限のエラーについては共通エラーを参照してください。