ナレッジベース分類インターフェース

knowledge_type の値

日本語名称 英語名称
問題 question
定型文 useful_expression 　　
便利なリンク useful_link 　
添付ファイル attachment

異なるナレッジベースタイプの分類を作成

このインターフェースは、異なるタイプのナレッジベースの分類を作成するために使用されます。

リクエストメソッド

POST /knowledge_catalogs

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

パラメータ名 タイプ 必須 説明 制限
knowledge_catalog オブジェクト はい ナレッジベースのパラメータ 　

knowledge_catalogの構造は以下の通りです：

パラメータ名 タイプ 必須 説明 制限
name 文字列 はい ナレッジベースの名称 255文字以内
knowledge_type_name 文字列 はい knowledge_typeの英語名称を使用　
parent_id 整数 いいえ 上位の分類ID
agent_id 整数 はい 　 サポート担当者ID
説明：

レスポンスデータ

属性名 タイプ 説明 　　
code　　　 整数 実行結果コード、1000は成功を表します
name 文字列 新規作成した分類の名称
id 整数 新規作成した分類のID

例

リクエスト

curl https://demo.udesk.cn/open_api_v1/knowledge_catalogs?email=admin@udesk.cn&timestamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2 \
-X POST \
-H 'content-type: appliacation/json' \
-d '
{
    "knowledge_catalog": {
        "knowledge_type_name": "question",
        "name": "問題庫１",
        "agent_id":0,
        "parent_id": ""
    }
}
'

結果

{
    "code": 1000,
    "id": 22,
    "name": "問題庫１"
}

異なるナレッジベースタイプのカテゴリを変更

このインターフェースは、既存の異なるタイプのナレッジベースのカテゴリを変更するために使用されます。

リクエストメソッド

PUT /knowledge_catalogs/:id

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

パラメータ名 タイプ 必須 説明 制限
id 整数 はい カテゴリのID

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

パラメータ名 タイプ 必須 説明 制限
knowledge_catalog オブジェクト はい ナレッジベースのパラメータ

knowledge_catalogの構造は以下の通りです：

パラメータ名 タイプ 必須 説明 制限
name 文字列 はい ナレッジベースの名称 255文字以内
agent_id 整数 はい サポート担当者ID
説明：

レスポンスデータ

属性名 タイプ 説明
code 整数 実行結果コード、1000は成功を表します
name 文字列 新規作成したカテゴリの名称
id 整数 新規作成したカテゴリのID

例

リクエスト

curl https://demo.udesk.cn/open_api_v1/knowledge_catalogs/11?email=admin@udesk.cn&timestamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2
-X PUT \
-H 'content-type: appliacation/json' \
-d '
{
    "knowledge_catalog": {
        "name": "よく使うリンク",
        "agent_id": 0
    }
}
'

結果

{
    "code": 1000,
    "id": 11,
    "name": "よく使うリンク"
}

異なる知識ベースタイプのカテゴリ削除

このインターフェースは、既存の異なるタイプの知識ベースのカテゴリを削除するために使用されます。

リクエストメソッド

DELETE /knowledge_catalogs/:id

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

パラメータ名 タイプ 必須 説明 制限
id 整数 はい カテゴリのID

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

パラメータ名 タイプ 必須 説明 制限
knowledge_catalog オブジェクト はい 知識ベースのパラメータ

knowledge_catalogの構造は以下の通りです：

パラメータ名 タイプ 必須 説明 制限
agent_id 整数 はい エージェントID
説明：

レスポンスデータ

属性名 タイプ 説明
code 整数 実行結果コード、1000は成功を表します
id 整数 削除されたカテゴリID
message 文字列 カテゴリ削除のメッセージ

例

リクエスト

curl https://demo.udesk.cn/open_api_v1/knowledge_catalogs/19?email=admin@udesk.cn&timestamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2 \
-X DELETE \
-H 'content-type: appliacation/json' \
-d '
{
    "knowledge_catalog": {
        "agent_id":"0"
    }
}
'

結果

{
    "code": 1000,
    "message": "カテゴリ削除成功",
    "id": "19"
}

異なる知識ベースタイプのカテゴリリスト取得

このインターフェースは、既存の異なるタイプの知識ベースのカテゴリリストを取得するために使用されます。

リクエスト方法

GET /knowledge_catalogs

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

パラメータ名 タイプ 必須 説明 制限
knowledge_type_name 文字列 はい knowledge_typeの英語名を使用します
agent_id 整数 はい カスタマーサポートID、デフォルトは管理者
説明：

レスポンスデータ

属性名 タイプ 説明
code 整数 実行結果コード、1000は成功を表します
catalogs 配列 カテゴリリスト

catalogsの構造は以下の通りです：

属性名 タイプ 説明
name 文字列 カテゴリの名称
id 整数 カテゴリのID
parent_id 整数 カテゴリの親ID、parent_id=0の場合は最上位カテゴリを表します
children オブジェクト カテゴリのサブカテゴリ

例

リクエスト

curl https://demo.udesk.cn/open_api_v1/knowledge_catalogs?email=admin@udesk.cn&timestamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2&knowledge_type_name=useful_expression&agent_id=0

結果

{
    "code": 1000,
    "catalogs": [
        {
            "id": 4,
            "parent_id": 0,
            "name": "常用語１"
        },
        {
            "id": 5,
            "parent_id": 0,
            "name": "常用語2",
            "children": [
                {
                    "id": 6,
                    "parent_id": 5,
                    "name": "常用語1-1"
                }
            ]
        }
    ]
}

定型文インターフェース

定型文リストの取得

このインターフェースは、特定のカスタマーサポート担当者に属するすべての定型文、または指定されたカテゴリの定型文を取得するために使用されます。

リクエストメソッド

GET /useful_expressions

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

パラメータ名 タイプ 必須 説明 制限
catalog_id 整数 はい 定型文カテゴリID
agent_id 整数 はい 定型文カテゴリ所有者のID
page 整数 いいえ ページ番号（1から開始、デフォルトは1）
per_page 整数 いいえ 1ページあたりの件数（デフォルト20、最大100）
説明：

レスポンスデータ

属性名 タイプ 説明
code 整数 実行結果コード（1000は成功を表します）
useful_expressions 配列 定型文リスト
meta オブジェクト ページネーション関連情報（共通データ を参照）

useful_expressions のデータ構造

属性名 タイプ 説明
id 整数 定型文ID
content 文字列 定型文の内容
catalog_id 整数 定型文カテゴリID

例

リクエスト

curl https://demo.udesk.cn/open_api_v1/useful_expressions?email=admin@udesk.cn&timestamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2&catalog_id=15&agent_id=12

レスポンス

{
    "code": 1000,
    "useful_expressions": [
        {
            "id": 1,
            "content": "content1",
            "catalog_id": 4
        },
        {
            "id": 2,
            "content": "content2",
            "catalog_id": 5
        },
        {
            "id": 3,
            "content": "content2",
            "catalog_id": 6
        },
        {
            "id": 4,
            "content": "content4",
            "catalog_id": 6
        }
    ],
    "meta": {
        "current_page": 1,
        "total_pages": 1,
        "total_count": 4
    }
}

よく使う表現を更新

このインターフェースは、特定のよく使う表現の内容を変更するために使用されます。

リクエストメソッド

PUT /useful_expressions/:id

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

パラメータ名 タイプ 必須 説明 制限
id 整数 はい よく使う表現ID

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

パラメータ名 タイプ 必須 説明 制限
content 文字列 はい よく使う表現の内容
agent_id 整数 はい よく使う表現作成者のID
説明：

レスポンスデータ

属性名 タイプ 説明
code 整数 実行結果コード、1000は成功を表します
id 整数 よく使う表現ID
content 文字列 よく使う表現の内容

例

リクエスト

curl https://demo.udesk.cn/open_api_v1/useful_expressions/4?email=admin@udesk.cn&timestamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2 \
-X PUT \
-H 'content-type: appliacation/json' \
-d '
{
  "content": "content12",
  "agent_id": 0
}
'

レスポンス

{
    "code": 1000,
    "id": 4,
    "content": "content12",
    "catalog_id": 6
}

よく使う表現を追加

このインターフェースは、特定のサポート担当者の特定のよく使う表現カテゴリの下に新しいよく使う表現を作成するために使用されます。

リクエストメソッド

POST /useful_expressions

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

パラメータ名 タイプ 必須 説明 制限
content 文字列 はい よく使う表現の内容
catalog_id 整数 はい よく使う表現カテゴリID
agent_id 整数 はい よく使う表現作成者のID
##### 説明：

返却データ

属性名 タイプ 説明 　　
code 整数型 実行結果コード、1000は成功を表します
id 整数型 定型文ID
content 文字列 定型文内容
catalog_id 整数型 定型文分類ID

例

リクエスト

curl https://demo.udesk.cn/open_api_v1/useful_expressions?email=admin@udesk.cn&timestamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2 \
-X POST \
-H 'content-type: appliacation/json' \
-d '
{
  "content": "kakkakakakakakakaka",
  "agent_id": 0,
  "catalog_id": 6
}
'

レスポンス

{
    "code": 1000,
    "id": 4,
    "content": "kakkakakakakakakaka",
    "catalog_id": 6
}

定型文の削除

このAPIは、特定の定型文を削除するために使用されます

リクエストメソッド

DELETE /useful_expressions/:id

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

パラメータ名 タイプ 必須 説明 制限
id 整数型 はい 定型文ID

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

パラメータ名 タイプ 必須 説明 制限
agent_id 整数型 はい 定型文作成者のID

返却データ

属性名 タイプ 説明 　　
code 整数型 実行結果コード、1000は成功を表します
id 整数型 定型文ID
message 文字列 結果説明
#### サンプル

リクエスト

curl https://demo.udesk.cn/open_api_v1/useful_expressions/4?email=admin@udesk.cn&timestamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2 \
-X DELETE \
-H 'content-type: appliacation/json' \
-d '
{
  "agent_id": 0
}
'

レスポンス

{
    "code": 1000,
    "message": "定型文の削除に成功しました",
    "id": "4"
}

よく使うリンク API

よく使うリンクリストの取得

このAPIは、特定のエージェントのすべての、または指定されたカテゴリのよく使うリンクを取得するために使用されます。

リクエストメソッド

GET /useful_links

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

パラメータ名 タイプ 必須 説明 制限
catalog_id 整数 はい よく使うリンクカテゴリID
agent_id 整数 はい よく使うリンクカテゴリ所有者のID
page 整数 いいえ ページ番号、1から開始、デフォルトは1
per_page 整数 いいえ 1ページあたりの件数、デフォルト20、最大100
説明：

レスポンスデータ

属性名 タイプ 説明 　　
code 整数 実行結果コード、1000は成功を表します
useful_links 配列 よく使うリンクリスト
meta オブジェクト ページネーション関連の内容、共通データ を参照してください

useful_links のデータ構造

属性名 タイプ 説明
id 整数 よく使うリンクID
name 文字列 よく使うリンク名
url 文字列 よく使うリンクURL
catalog_id 整数 よく使うリンクカテゴリID

サンプル

リクエスト

curl https://demo.udesk.cn/open_api_v1/useful_links?email=admin@udesk.cn&timestamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2&catalog_id=15&agent_id=12

レスポンス

{
    "code": 1000,
    "useful_links": [
        {
            "id": 6,
            "name": "リンク６",
            "url": "https://www.baidu1.com",
            "catalog_id": 11
        },
        {
            "id": 8,
            "name": "リンク８",
            "url": "https://www.baidu1.com",
            "catalog_id": 11
        },
        {
            "id": 9,
            "name": "リンク９",
            "url": "https://www.baidu1.com",
            "catalog_id": 11
        },
        {
            "id": 10,
            "name": "リンク１０",
            "url": "https://www.baidu1.com",
            "catalog_id": 11
        },
        {
            "id": 11,
            "name": "リンク１１",
            "url": "https://www.baidu1.com",
            "catalog_id": 11
        }
    ],
    "meta": {
        "current_page": 1,
        "total_pages": 1,
        "total_count": 5
    }
}

よく使うリンクの更新

このインターフェースは、特定のよく使うリンクを変更するために使用されます。

リクエストメソッド

PUT /useful_links/:id

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

パラメータ名 タイプ 必須 説明 制限
id 整数 はい よく使うリンクID

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

パラメータ名 タイプ 必須 説明 制限
name 文字列 いいえ よく使うリンクの内容
url 文字列 いいえ よく使うリンクのアドレス
agent_id 整数 はい よく使うリンク作成者のID
説明：

レスポンスデータ

属性名 タイプ 説明
code 整数 実行結果コード、1000は成功を表します
id 整数 よく使うリンクID
name 文字列 よく使うリンク名
url 文字列 よく使うリンクアドレス
catalog_id 整数 よく使うリンクカテゴリID

例

リクエスト

curl https://demo.udesk.cn/open_api_v1/useful_links/12?email=admin@udesk.cn&timestamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2 \
-X PUT \
-H 'content-type: appliacation/json' \
-d '
{
  "name": "",
  "url": "https://www.bai.com",
  "agent_id": 4
}'

レスポンス

{
    "code": 1000,
    "id": 12,
    "name": "name",
    "url": "https://www.bai.com",
    "catalog_id": 12
}

よく使うリンクの追加

このインターフェースは、特定のサポート担当者の特定のよく使うリンクカテゴリの下に新しいよく使うリンクを作成するために使用されます。

リクエストメソッド

POST /useful_links

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

パラメータ名 タイプ 必須 説明 制限
name 文字列 はい よく使うリンク名
url 文字列 はい よく使うリンクアドレス
catalog_id 整数 はい よく使うリンクカテゴリID
agent_id 整数 はい よく使うリンク作成者のID
##### 説明：

返却データ

属性名 タイプ 説明 　　
code 整数型 実行結果コード、1000は成功を表します
id 整数型 よく使うリンクID

例

リクエスト

curl https://demo.udesk.cn/open_api_v1/useful_expressions?email=admin@udesk.cn&timestamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2 \
-X POST \
-H 'content-type: appliacation/json' \
-d '
{
  "name": "リンク１0",
  "url": "https://www.baidu1.com",
  "catalog_id": 12,
  "agent_id": 4
}
'

レスポンス

{
    "code": 1000,
    "id": 12,
    "name": "リンク１0",
    "url": "https://www.baidu1.com",
    "catalog_id": 12
}

よく使うリンクの削除

このAPIは、特定のよく使うリンクを削除するために使用されます

リクエストメソッド

DELETE /useful_links/:id

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

パラメータ名 タイプ 必須 説明 制限
id 整数型 はい よく使うリンクID

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

パラメータ名 タイプ 必須 説明 制限
agent_id 整数型 はい よく使うリンク作成者のID

返却データ

属性名 タイプ 説明 　　
code 整数型 実行結果コード、1000は成功を表します
id 整数型 よく使うリンクID
message 文字列 結果の説明

例

リクエスト

curl https://demo.udesk.cn/open_api_v1/useful_expressions/7?email=admin@udesk.cn&timestamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2 \
-X DELETE \
-H 'content-type: appliacation/json' \
-d '
{
  "agent_id": 4
}
'

レスポンス

{
    "code": 1000,
    "id": "7",
    "message": "よく使うリンクの削除に成功しました"
}

問題ライブラリインターフェース

問題ライブラリの質問リストを取得

このインターフェースは、特定のカスタマーサポート担当者に属するすべて、または指定されたカテゴリの問題ライブラリの質問リストを取得するために使用されます。

リクエストメソッド

GET /knowledge_questions

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

パラメータ名 タイプ 必須 説明 制限
catalog_id 整数 はい 問題ライブラリカテゴリID
agent_id 整数 はい 問題ライブラリカテゴリ所有者のID
page 整数 いいえ ページ番号、1から開始、デフォルトは1
per_page 整数 いいえ 1ページあたりの件数、デフォルト20、最大100
説明：

レスポンスデータ

属性名 タイプ 説明 　　
code 整数 実行結果コード、1000は成功を表します
knowledge_questions 配列 問題ライブラリ質問リスト
meta オブジェクト ページネーション関連の内容、共通データを参照

knowledge_questions のデータ構造

属性名 タイプ 説明
id 整数 問題ライブラリ質問ID
title 文字列 問題ライブラリ質問名
content 文字列 問題ライブラリ質問の回答
content_type 文字列 問題ライブラリ質問の回答タイプ
catalog_id 整数 問題ライブラリカテゴリID
updated_at 日時 問題ライブラリ質問の最終更新時間
lasts 　　 ブール値　　 問題ライブラリ質問が永久に有効かどうか
last_min 　　 日時 問題ライブラリ質問の有効期限下限
last_max 　　 日時 問題ライブラリ質問の有効期限上限

例

リクエスト

curl https://demo.udesk.cn/open_api_v1/knowledge_questions?email=admin@udesk.cn&timestamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2&catalog_id=0&agent_id=0

レスポンス

{
    "code": 1000,
    "knowledge_questions": [
        {
            "id": 1,
            "title": "問題１",
            "content": "ああああ",
            "content_type": "text",
            "lasts": true,
            "catalog_id": null,
            "updated_at": "2018-03-22T11:29:59.000+08:00",
            "last_min": null,
            "last_max": null
        },
        {
            "id": 3,
            "title": "水水水水",
            "content": "水水水水",
            "content_type": "text",
            "lasts": true,
            "catalog_id": 17,
            "updated_at": "2018-03-22T18:35:02.000+08:00",
            "last_min": "2018-03-31",
            "last_max": "2018-04-03"
        }
    ],
    "meta": {
        "current_page": 1,
        "total_pages": 1,
        "total_count": 2
    }
}

問題ライブラリの更新

このインターフェースは、特定の問題ライブラリの質問を修正するために使用されます。

リクエストメソッド

PUT /knowledge_questions/:id

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

パラメータ名 タイプ 必須 説明 制限
id 整数 はい 問題ライブラリ質問ID

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

パラメータ名 タイプ 必須 説明 制限
question オブジェクト はい 質問の具体的な値

questionのデータ構造

パラメータ名 タイプ 必須 説明 制限
agent_id 整数 はい 質問の作成者のID
content 文字列 いいえ 質問の回答
title 文字列 いいえ 質問の名称
content_type 文字列 いいえ 質問の回答タイプ
lasts ブール値 はい 質問が永久に有効かどうか
last_min 日時 いいえ 質問の有効期限下限
last_max 日時 いいえ 質問の有効期限上限
説明：

レスポンスデータ

属性名 タイプ 説明
code 整数 実行結果コード、1000は成功を表します
id 整数 問題ライブラリID
title 文字列 問題ライブラリの質問
content_type 文字列 問題ライブラリ質問のコンテンツタイプ
content 文字列 問題ライブラリのコンテンツ
lasts ブール値 問題ライブラリの質問が永久に有効かどうか
last_min 日時 問題ライブラリ質問の有効期限下限
last_max 日時 問題ライブラリ質問の有効期限上限
#### サンプル

リクエスト

curl https://demo.udesk.cn/open_api_v1/knowledge_questions/8?email=admin@udesk.cn&timestamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2 \
-X PUT \
-H 'content-type: appliacation/json' \
-d '
{
    "question": {
        "agent_id": 0,
        "content": "asasasaasasadasass",
        "title": "",
        "content_type": "",
        "lasts": false,
        "last_min": "2018-03-31",
        "last_max": "2018-04-03"
    }
}
'

レスポンス

{
    "code": 1000,
    "id": 8,
    "title": "title5",
    "content": "asasasaasasadasass",
    "content_type": "html",
    "catalog_id": null,
    "lasts": false,
    "last_min": "2018-03-31",
    "last_max": "2018-04-03"

}

ナレッジベースへの質問追加

このAPIは、特定のカスタマーサポート担当者の特定のナレッジベースカテゴリに新しい質問を作成するために使用されます。

リクエストメソッド

POST /knowledge_questions

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

パラメータ名 タイプ 必須 説明 制約
question オブジェクト はい 質問の詳細値

questionのデータ構造

パラメータ名 タイプ 必須 説明 制約
agent_id 整数 はい 質問作成者のID
content 文字列 はい 質問の回答
title 文字列 はい 質問のタイトル
content_type 文字列 はい 回答のタイプ
catalog_id 整数 はい ナレッジベースカテゴリID
lasts ブール値 はい 質問が永久に有効かどうか
last_min 日付時刻 いいえ 質問の有効期限（下限）
last_max 日付時刻 いいえ 質問の有効期限（上限）
##### 説明：

戻りデータ

属性名 タイプ 説明 　　
code 整数型 実行結果コード、1000は成功を表します
id 整数型 ナレッジベースID

例

リクエスト

curl https://demo.udesk.cn/open_api_v1/useful_expressions?email=admin@udesk.cn&timestamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2 \
-X POST \
-H 'content-type: appliacation/json' \
-d '
{
    "question": {
        "agent_id": 0,
        "content": "asasasas",
        "title": "title1",
        "content_type": "html",
        "catalog_id":0,
        "lasts": true
    }
}
'

レスポンス

{
    "code": 1000,
    "id": 8,
    "title": "title5",
    "content": "asasasas",
    "content_type": "html",
    "catalog_id": null,
    "lasts": true,
    "last_min": null,
    "last_max": null
}

ナレッジベースの削除

このAPIは、特定のナレッジベース項目を削除するために使用されます。

リクエストメソッド

DELETE /knowledge_questions/:id

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

パラメータ名 タイプ 必須 説明 制限
id 整数型 はい ナレッジベース項目ID

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

パラメータ名 タイプ 必須 説明 制限
agent_id 整数型 はい ナレッジベース項目作成者のID

戻りデータ

属性名 タイプ 説明 　　
code 整数型 実行結果コード、1000は成功を表します
id 整数型 ナレッジベースID
#### サンプル

リクエスト

curl https://demo.udesk.cn/open_api_v1/knowledge_questions/8?email=admin@udesk.cn&timestamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2 \
-X DELETE \
-H 'content-type: appliacation/json' \
-d '
{
  "agent_id": 0
}
'

レスポンス

{
    "code": 1000,
    "id": "8",
    "message": "問題の削除に成功しました"
}

添付ファイルライブラリインターフェース

添付ファイルライブラリの添付ファイルリストを取得

このインターフェースは、特定のカスタマーサポート担当者に属するすべての添付ファイル、または指定されたカテゴリに属する添付ファイルのリストを取得するために使用されます。

リクエストメソッド

GET /knowledge_attachments

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

パラメータ名 タイプ 必須 説明 制限
catalog_id 整数 はい 添付ファイルライブラリカテゴリID
agent_id 整数 はい 添付ファイルライブラリカテゴリ所有者のID
page 整数 いいえ ページ番号、1から開始、デフォルトは1
per_page 整数 いいえ 1ページあたりの件数、デフォルト20、最大100
説明：

レスポンスデータ

属性名 タイプ 説明 　　
code 整数 実行結果コード,1000は成功を表します
knowledge_attachments 配列 添付ファイルリスト
meta オブジェクト ページネーション関連の内容、共通データを参照

knowledge_attachments のデータ構造

属性名 タイプ 説明
id 整数 添付ファイルID 　　　　
file_name 文字列 添付ファイル名 　　　　
file_type 文字列 添付ファイルタイプ 　　　　
file_size 文字列 添付ファイルサイズ 　　　　
file_url 文字列 添付ファイルURL 　　　　
catalog_id 整数 添付ファイルが属するカテゴリID
#### サンプル

リクエスト

curl https://demo.udesk.cn/open_api_v1/knowledge_attachments?email=admin@udesk.cn&timestamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2&catalog_id=0&agent_id=0

レスポンス

{
    "code": 1000,
    "knowledge_attachments": [
        {
            "id": 1,
            "catalog_id": 9,
            "file_name": "JPG.JPG",
            "file_type": "image/jpeg",
            "file_size": null,
            "file_url": "https://qn-public.udesk.cn/1472632419-JPG.JPG"
        },
        {
            "id": 2,
            "catalog_id": 10,
            "file_name": "JPG.JPG",
            "file_type": "image/jpeg",
            "file_size": null,
            "file_url": "https://qn-public.udesk.cn/JPG.JPG"
        },
        {
            "id": 3,
            "catalog_id": null,
            "file_name": "jira任务记录.docx",
            "file_type": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
            "file_size": "11858",
            "file_url": "https://qn-public.udesk.cn/Fs65I3NAYnqt_URMYQB8NAwerWI3"
        }
    ],
    "meta": {
        "current_page": 1,
        "total_pages": 1,
        "total_count": 3
    }
}

添付ファイルの再アップロード

このAPIは、特定の添付ファイルを修正するために使用されます。

リクエストメソッド

PUT /knowledge_attachments/:id

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

パラメータ名 タイプ 必須 説明 制限
id 整数型 はい 添付ファイルID
file_name 文字列 はい 添付ファイル名
type 文字列 はい 添付ファイルタイプ
agent_id 整数型 はい 添付ファイル作成者のID
##### 説明：
- agent_idの値は具体的なカスタマーサポートIDまたは0で、0は管理者を表します
- リクエストにContent-type:application/octet-streamを明記し、アップロードファイルをストリームファイルに変換してrequest bodyに配置してください
- ファイルタイプtypeの正確性を必ず保証してください。そうでないとファイルを認識できません

返却データ

属性名 タイプ 説明
id 整数型 添付ファイルID 　　　　
file_name 文字列 添付ファイル名 　　　　
file_type 文字列 添付ファイルタイプ 　　　　
file_size 文字列 添付ファイルサイズ 　　　　
file_url 文字列 添付ファイルURL 　　　　
catalog_id 整数型 添付ファイルが属するカテゴリID

例

リクエスト

curl https://demo.udesk.cn/open_api_v1/knowledge_attachments?email=admin@udesk.cn&timestamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2&file_name=aaa&type=jpg&agent_id=0&catalog_id=10 \
-X PUT \
-H 'content-type: appliacation/json' \
-d '
'

レスポンス

{
    "code": 1000,
    "id": 5,
    "catalog_id": 10,
    "file_name": "9747.jpg_wh300.jpg",
    "file_type": "jpg",
    "file_size": 79044,
    "file_url": "https://qn-public.udesk.cn/Fk8NQDfDUqbImbZvD37VVDejCNfv"
}

添付ファイルの新規作成

このAPIは、特定のカスタマーサポートの特定の添付ファイルカテゴリに新しい添付ファイルを作成するために使用します

リクエストメソッド

POST /knowledge_attachments

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

パラメータ名 タイプ 必須 説明 制限
file_name 文字列　 はい 添付ファイル名 　　　　　　　　
type 文字列　 はい 添付ファイルタイプ　　　　　
catalog_id 整数型 はい 添付ファイルカテゴリID 　　　　
agent_id 整数型 はい 添付ファイル作成者のID　　　　
##### 説明：

返却データ

属性名 タイプ 説明
id 整数型 添付ファイルID 　　　　
file_name 文字列 添付ファイル名 　　　　
file_type 文字列 添付ファイルタイプ 　　　　
file_size 文字列 添付ファイルサイズ 　　　　
file_url 文字列 添付ファイルURL 　　　　
catalog_id 整数型 添付ファイルが属するカテゴリID

例

リクエスト

curl https://demo.udesk.cn/open_api_v1/knowledge_attachments?email=admin@udesk.cn&timestamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2&file_name=aaa&type=jpg&agent_id=0&catalog_id=10 \
-X POST \
-H 'content-type: appliacation/json' \
-d '
'

レスポンス

{
    "code": 1000,
    "id": 4,
    "catalog_id": 10,
    "file_name": "9747.jpg_wh300.jpg",
    "file_type": "jpg",
    "file_size": 79044,
    "file_url": "https://qn-public.udesk.cn/Fk8NQDfDUqbImbZvD37VVDejCNfv"
}

添付ファイルの削除

このAPIは、特定の添付ファイルを削除するために使用されます

リクエストメソッド

DELETE /knowledge_attachments/:id

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

パラメータ名 タイプ 必須 説明 制限
id 整数型 はい 添付ファイルID
agent_id 整数型 はい 添付ファイル作成者のID

返却データ

属性名 タイプ 説明 　　
code 整数型 実行結果コード（1000は成功を表します）
id 整数型 添付ファイルID
message 文字列 結果の説明
#### サンプル

リクエスト

curl https://demo.udesk.cn/open_api_v1/knowledge_attachments/4111?email=admin@udesk.cn&timestamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2 \
-X DELETE \
-H 'content-type: appliacation/json' \
-d '
{
  "agent_id": 12
}
'

レスポンス

{
    "code": 1000,
    "id": "4111",
    "message": "添付ファイルの削除に成功しました"
}

エラーコード説明

エラーコード message情報 exception:message情報 説明
2000 agent_idは必須項目です パラメータにagent_idが記入されていません
agent_idは整数型です agent_idが非整数型パラメータです
該当カテゴリは存在しません IDが{catelog_id}のカテゴリは存在しません
該当カスタマーサポートの配下にこのカテゴリは存在しません IDが{catelog_id}のカテゴリは、IDが{agent_id}のカスタマーサポートに属していないため、変更できません
catalog_idは必須項目です パラメータ{catalog_id}は空にできません
catalog_idは整数型です パラメータ{catalog_id}の値は整数型でなければなりません
リソースが見つかりませんでした 対応するIDのデータが見つかりませんでした
該当カスタマーサポートの配下にこのリンクカテゴリは存在しません IDが{catelog_id}のよく使うリンクカテゴリは、IDが{agent_id}のカスタマーサポートに属していません
不明なエラー
knowledge_type_nameの値が不正です パラメータ{knowledge_type_name}の値が誤っています
検証失敗: 名前は空文字にできません パラメータ{name}の値を空にすることはできません
検証失敗: Parentが同じカテゴリに属していません {knowledge_type_name}タイプの下で、IDが{parent_id}のカテゴリが見つかりません
親カテゴリ配下にコンテンツが存在するため、カテゴリを作成できません IDが{parent_id}のカテゴリはリーフノードではありません（他のデータが存在します）
最大4階層までのカテゴリを作成できます IDが{parent_id}のカテゴリは第4階層のカテゴリです（ナレッジベースカテゴリの階層は最大4階層まで許可されています）
検証失敗: 名前は既に使用されています IDが{parent_id}のカテゴリ配下に、{name}と同じ名前のサブカテゴリが存在します
管理者の既存カテゴリ配下にIDが{parent_id}のカテゴリは存在しません IDが{parent_id}のカテゴリは存在しません
パラメータが不足しているか、値が空です: knowledge_catalog パラメータにオブジェクト{knowledge_catalog}が不足しています
定型文コンテンツcontentは空にできません パラメータcontentの値を空にすることはできません
変更するコンテンツが設定されていません よく使うリンクを変更する際、パラメータnameまたはurlの少なくとも一方に値が必要です
よく使うリンク名nameは必須項目です パラメータnameの値を空にすることはできません
よく使うリンクアドレスurlは必須項目です パラメータurlの値を空にすることはできません
パラメータが不足しているか、値が空です: question パラメータにquestionオブジェクトが不足しています
content_typeの値が不正です パラメータcontent_typeの値はtext、htmlのみ可能です
問題の有効期限lastsは空にできません パラメータlastsの値を空にすることはできません、true/falseでなければなりません
last_minの形式が不正です パラメータlastsの値がfalseの場合、パラメータlast_minの値は日付形式に従い、空にできません
last_maxの形式が不正です パラメータlastsの値がfalseの場合、パラメータlast_maxの値は日付形式に従い、空にできません
last_maxはlast_min以下にできません パラメータlastsの値がfalseの場合、パラメータlast_maxの値はパラメータlast_minの値以下でなければなりません
contentは空にできません パラメータcontentの値を空にすることはできません
titleは空にできません パラメータtitleの値を空にすることはできません
content_typeは空にできません パラメータcontent_typeの値を空にすることはできません
問題の有効期限lastsの値が不正です パラメータlastsの値を空にすることはできません、true/falseでなければなりません
問題の有効期限の時間上限と時間下限は空にできません パラメータlast_min、last_maxの値を空にすることはできません
file_nameは必須項目であり、空にできません パラメータfile_nameの値を空にすることはできません
typeは必須項目であり、空にできません パラメータtypeの値を空にすることはできません
2005 該当リソースが見つかりませんでした ActiveRecord::RecordNotFound パラメータ{id}に一致するデータが見つかりませんでした