購読¶
POST /api/v1/channel/{channel_uuid}/subscribe
概要¶
現在の API 呼び出し元 ID によるチャンネル購読タイプを設定または解除します。
呼び出し前の確認事項と使用手順¶
対象の UUID はチャンネル簡易リストから取得します。type には responsible、participate、attention、または cancel を選択します。1 つの ID につき同一チャンネルで保存されるタイプは 1 つのみで、後から設定した内容が元のタイプを上書きします。操作は現在の呼び出し元 ID を対象とし、true が返された後はリストの subscribeType で確認できます。
ルートパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| channel_uuid | string | Y | 現在のワークスペースのチャンネル UUID。 例: chan_example取得または入力方法: チャンネル簡易リスト の content[].uuid から取得します。 |
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証情報。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。 |
リクエスト Body パラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| type | string | Y | responsible は責任者、participate は参加者、attention はフォロワー、cancel は購読解除です。 null を許可: False 選択可能な値: ['responsible', 'participate', 'attention', 'cancel'] 例: attention取得または入力方法: 実際のコラボレーション上の役割に応じて選択し、購読を解除する場合は cancel を使用します。 |
パラメータの補足説明¶
解除後、リストで返される subscribeType は空文字列になります。別の API Key または ID を使用する場合、購読状態が異なることがあります。
リクエスト例¶
curl --request POST 'https://openapi.guance.com/api/v1/channel/chan_example/subscribe' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"type":"attention"}'
レスポンス¶
HTTP 200、application/json。以下の例は、直接読み取れる主なフィールドを示しています。
| フィールド | 型 | 説明 |
|---|---|---|
| content | boolean | 購読タイプの保存に成功した場合は true。 |
{
"code": 200,
"content": true,
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
エラーレスポンス¶
認証、レート制限、および共通リクエストエラーについては共通エラー定義を参照してください。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたはレスポンスの説明 | 対処方法 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | リクエストフィールドの欠落、またはフィールド値が宣言された検証条件に違反している | パラメータの解析に失敗しました | パラメータの位置、フィールド名、型、値を確認してください。 |
| 400 | ft.RequestJsonFormatError | リクエスト JSON の構文が無効 | リクエスト JSON の形式エラー | content.reason、line、column に従って JSON を修正してください。 |
| 400 | ft.JsonFormatError | JSON のトップレベルがオブジェクトではない | 一部の json ファイル形式エラー | 単一の JSON オブジェクトを渡してください。 |
| 404 | ft.NotFoundChannel | 対象チャンネルが存在しない、削除済み、または現在のワークスペースに属していない | 指定されたチャンネルが見つかりません | チャンネル簡易リストを使用して有効な UUID を再取得してください。 |