ログインユーザーが閲覧可能なナレッジスペースの検索

このAPIは、ログインユーザーが閲覧可能なナレッジスペースを検索するために使用されます。

リクエストメソッド

GET /knowledgeBaseChoices

レスポンスデータ

属性名	タイプ	説明
code	整数	実行結果コード、200は成功を表します
succeed	ブール値	成功したかどうか
bizCode	文字列	業務ステータスコード
message	文字列	返却メッセージ
visible	ブール値	閲覧可能かどうか
data	オブジェクト	返却データ

例

リクエスト

curl --location --request GET 'https://knowledgeservice.s4.udesk.cn/api/knowledgeBaseChoices' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiJrbSIsImNvbXBhbnlJZCI6MzM3MDYsImFwcElkIjoiNmYwZDMwNWItZmNhMS00MDU2LTY1YzQtNjNhN2RlOWY0N2VjIiwiaXNzIjoia20iLCJ1c2VyVHlwZSI6MiwiZXhwIjoxNzYyNDM2NjQ0LCJpYXQiOjE3NjI0MzM2NDQsInVzZXJJZCI6Mn0.kly1GqZOZFdB6haTBYeHRKHsTZmMjMkirXLy_iBrld1b04oT8dI-E1JeyFwu4KIKY9ilAMw3P29deCKyJ9u-ficG38E2yb3f-NlktZWkg7f4ywRdjm6mU5xKYlILEUTxEv389goIBexRnOmzKnxY5aErRVYWrW7pPEDBA3jk4yc' \
--header 'User-Agent: Apifox/1.0.0 (https://apifox.com)' \
--header 'Content-Type: application/json' \
--header 'Accept: */*' \
--header 'Cache-Control: no-cache' \
--header 'Host: knowledgeservice.s4.udesk.cn' \
--header 'Connection: keep-alive' \
--header 'Cookie: kcs-session-id=469a7a84-99bd-4e50-a4a7-ebb5e3fa0dbd'

結果

{
  "succeed": true,
  "code": 200,
  "bizCode": "000000",
  "message": "OK",
  "visible": false,
  "data": {
    "all": [
      {
        "id": 1662,
        "name": "マイスペース",
        "type": 2
      },
      {
        "id": 2842,
        "name": "カスタマーサポートシステムテスト",
        "description": "",
        "type": 1,
        "knowledgeType": [
          1,
          2,
          3,
          4,
          5,
          6,
          7
        ]
      },
      {
        "id": 1376,
        "name": "hlテストスペース2",
        "description": "hl",
        "type": 1,
        "knowledgeType": [
          1,
          2,
          3,
          4,
          5,
          6,
          7
        ]
      },
      {
        "id": 1348,
        "name": "hlテストスペース1",
        "description": "hlテスト",
        "type": 1,
        "knowledgeType": [
          1,
          2,
          3,
          4,
          5,
          6,
          7
        ]
      },
      {
        "id": 871,
        "name": "領星テスト大規模モデル",
        "description": "領星テスト大規模モデル",
        "type": 1,
        "knowledgeType": [
          1,
          2,
          3,
          4,
          5,
          6,
          7
        ]
      },
      {
        "id": 598,
        "name": "回帰0525",
        "description": "",
        "type": 1,
        "knowledgeType": [
          1,
          2,
          3,
          4,
          5,
          6,
          7
        ]
      }
    ],
    "choice": [
      1662,
      2842,
      1376,
      1348,
      871,
      598
    ],
    "noChoice": []
  }
}

ナレッジスペースにバインドされた同期チャネルの検索

このAPIは、ナレッジスペースにバインドされた同期チャネルを検索するために使用されます。

リクエストメソッド

GET /sdk/channelBinds/findBindChannel/{knowledgeBaseId}

リクエストパラメータ(URL)

パラメータ名	タイプ	必須	説明	制限
knowledgeBaseId	string	はい	ナレッジスペースID

リクエストパラメータ(Query String)

パラメータ名	タイプ	必須	説明	制限
type	integer	はい	タイプ、1：スペースにバインドされたチャネル
systemType	string	いいえ	システムタイプ

レスポンスデータ

プロパティ名	タイプ	説明
code	整数	実行結果コード、200は成功を表します
succeed	ブール値	成功したかどうか
bizCode	文字列	ビジネスステータスコード
message	文字列	返却メッセージ
visible	ブール値	表示可能かどうか
paging	オブジェクト	ページング情報
data	配列	バインドされたチャネルリスト

例

リクエスト

curl --location --request GET 'https://knowledgeservice.s4.udesk.cn/api/sdk/channelBinds/findBindChannel/12246?type=1&systemType&email=admin@udesk.cn&timestamp=&sign=&nonce=&sign_version=v2' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiJrbSIsImNvbXBhbnlJZCI6MzM3MDYsImFwcElkIjoiNmYwZDMwNWItZmNhMS00MDU2LTY1YzQtNjNhN2RlOWY0N2VjIiwiaXNzIjoia20iLCJ1c2VyVHlwZSI6MiwiZXhwIjoxNzYyNDM2NjQ0LCJpYXQiOjE3NjI0MzM2NDQsInVzZXJJZCI6Mn0.kly1GqZOZFdB6haTBYeHRKHsTZmMjMkirXLy_iBrld1b04oT8dI-E1JeyFwu4KIKY9ilAMw3P29deCKyJ9u-ficG38E2yb3f-NlktZWkg7f4ywRdjm6mU5xKYlILEUTxEv389goIBexRnOmzKnxY5aErRVYWrW7pPEDBA3jk4yc' \
--header 'User-Agent: Apifox/1.0.0 (https://apifox.com)' \
--header 'Content-Type: application/json' \
--header 'Accept: */*' \
--header 'Cache-Control: no-cache' \
--header 'Host: knowledgeservice.s4.udesk.cn' \
--header 'Connection: keep-alive' \
--header 'Cookie: kcs-session-id=469a7a84-99bd-4e50-a4a7-ebb5e3fa0dbd'

結果

{
  "succeed": true,
  "code": 200,
  "bizCode": "000000",
  "message": "OK",
  "visible": false,
  "paging": {
    "pageNum": 1,
    "pageSize": 1,
    "total": 1
  },
  "data": [
    {
      "id": 283060,
      "bindType": 1,
      "channelId": 207,
      "bindContentId": 1376,
      "name": "ベビーテスト(双方向同期)"
    }
  ]
}

ログインユーザーのナレッジスペースにおける役割タイプの取得

このAPIは、ログインユーザーが指定したナレッジスペースで持つ役割タイプを取得するために使用します。

リクエストメソッド

GET /sdk/knowledgeBaseSettings/findUserKnowledgeBasePermission

リクエストパラメータ(Query String)

パラメータ名	タイプ	必須	説明	制限
knowledgeBaseId	integer	はい	ナレッジスペースID
systemType	string	いいえ	システムタイプ

レスポンスデータ

属性名	タイプ	説明
code	整数	実行結果コード、200は成功を表します
succeed	ブール値	成功したかどうか
bizCode	文字列	業務ステータスコード
message	文字列	返却メッセージ
visible	ブール値	表示可能かどうか
data	配列	役割タイプリスト

例

リクエスト

curl --location --request GET 'https://knowledgeservice.s4.udesk.cn/api/sdk/knowledgeBaseSettings/findUserKnowledgeBasePermission?knowledgeBaseId=12246' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiJrbSIsImNvbXBhbnlJZCI6MzM3MDYsImFwcElkIjoiNmYwZDMwNWItZmNhMS00MDU2LTY1YzQtNjNhN2RlOWY0N2VjIiwiaXNzIjoia20iLCJ1c2VyVHlwZSI6MiwiZXhwIjoxNzYyNDM3MDg5LCJpYXQiOjE3NjI0MzQwODksInVzZXJJZCI6Mn0.UsQHIlBEPXxiAsgz8kztcSe6JU00hIy_bb1ylO-ieeSEz6B1vuQTtUvzDp5RjLm_fE77fEg5w-1JCsuJnIgBoWYNHSjzmfQMwwLgUZi9ZLmJrMVWV9BUgvAGprb_wzNFt9pIJ0EJzgajwr9ZJvUnRiijnm1R6bxVJThdN63NulM' \
--header 'User-Agent: Apifox/1.0.0 (https://apifox.com)' \
--header 'Content-Type: application/json' \
--header 'Accept: */*' \
--header 'Cache-Control: no-cache' \
--header 'Host: knowledgeservice.s4.udesk.cn' \
--header 'Connection: keep-alive' \
--header 'Cookie: kcs-session-id=0ccd88a2-0a12-4960-b643-b47918d29821'

結果

{
  "succeed": true,
  "code": 200,
  "bizCode": "000000",
  "message": "OK",
  "visible": false,
  "data": [
    1
  ]
}