FAQカテゴリリストの取得

リクエストURL

リクエストパラメータ

クエリパラメータ

パラメータ 型 オプション 説明
robotId Integer false ボットID.

レスポンス結果

パス 型 説明
code Integer 実行結果コード
message String 実行結果の説明
data Array カテゴリ情報
data[].id Integer カテゴリID.
data[].name String カテゴリ名.
data[].parentId Integer カテゴリの親ID.
data[].parentIds String カテゴリの親IDパス（カンマ区切り）.
data[].robotId Integer ボットID.
data[].type Integer 1:システムカテゴリ（全て、未分類） 2:ユーザー定義カテゴリ
data[].classify Integer 1:FAQカテゴリを示す
data[].num Integer カテゴリ内のFAQの数

サンプル

$ curl 'https://km.udesk.cn/api/v1/categories?email=admin@udesk.cn&timestamp=1529402433&sign=e4f683120c26df279b3642ac77b0bd8bf621584a&robotId=102' -i -H 'Accept: application/json'
レスポンス
{
  "code" : 200,
  "message" : "OK",
  "visible" : false,
  "data" : [ {
    "id" : 406,
    "name" : "分類2",
    "parentId" : 342,
    "parentIds" : "0,342,",
    "robotId" : 102,
    "type" : 1,
    "classify" : 1,
    "num" : 10
  }, {
    "id" : 342,
    "name" : "全て",
    "parentId" : 0,
    "parentIds" : "0,",
    "robotId" : 102,
    "type" : 1,
    "classify" : 1,
    "num" : 10
  }, {
    "id" : 343,
    "name" : "未分類",
    "parentId" : 342,
    "parentIds" : "0,342,",
    "robotId" : 102,
    "type" : 1,
    "classify" : 1,
    "num" : 10
  } ]
}

FAQナレッジベースカテゴリ詳細の取得

リクエストURL

リクエストパラメータ

パスパラメータ

パラメータ 型 オプション 説明
id Integer false カテゴリID.

レスポンス結果

パス 型 説明
code Integer 実行結果コード
message String 実行結果の説明
data Object ナレッジベース情報
data.id Integer カテゴリID.
data.name String カテゴリ名.
data.parentId Integer カテゴリの親ID.
data.parentIds String カテゴリの親IDパス（カンマ区切り）.
data.robotId Integer ボットID.
data.type Integer 1:システムカテゴリ（全て、未分類） 2:ユーザー定義カテゴリ
data.classify Integer 1:FAQカテゴリ
data.num Integer カテゴリ内のFAQの数
### サンプル 
$ curl 'https://km.udesk.cn/api/v1/categories/403?email=admin@udesk.cn&timestamp=1529402429&sign=c8b3e4dfef80a80e6125d2863912f6cdf1d20509' -i -H 'Accept: application/json'
レスポンス
{
  "code" : 200,
  "message" : "OK",
  "visible" : false,
  "data" : {
    "id" : 403,
    "name" : "カテゴリ2",
    "parentId" : 342,
    "parentIds" : "0,342,",
    "robotId" : 102,
    "type": 2,
    "classify": 1,
    "num": 10
  }
}

リクエスト失敗の原因

Message Description
"Required int parameter 'robotId' is not present" パラメータ中のrobotIdの値は空にできません

FAQナレッジベースカテゴリの削除

リクエストURL

リクエストパラメータ

パスパラメータ

Parameter Type Optional Description
id Integer false カテゴリID.

リクエスト結果

サンプル

$ curl 'https://km.udesk.cn/api/v1/categories/379?email=admin@udesk.cn&timestamp=1529402432&sign=67df1ddd1aad415933d63da93ca24b59c8970740' -i -X DELETE -H 'Content-Type: application/json'

FAQナレッジベースカテゴリの新規作成

リクエストURL

リクエストパラメータ

リクエストフィールド

Parameter Type Optional Description
name String false カテゴリ名.
parentId Integer false カテゴリの親ID.
robotId Integer false ロボットID.
classify Integer true 1.ナレッジベースカテゴリ 2.挨拶文庫カテゴリ.

リクエスト結果

Path Type Description
code Integer 実行結果コード
message String 実行結果の説明
data Object カテゴリ情報
data.id Integer カテゴリID.
data.name String カテゴリ名.
data.parentId Integer カテゴリの親ID.
data.parentIds String カテゴリの親IDパス（カンマ区切り）.
data.robotId Integer ロボットID.
data.type Integer 1:システムカテゴリ（全て、未分類） 2:ユーザー定義カテゴリ
data.classify Integer 1:FAQのカテゴリを表します
### サンプル 
$ curl 'https://km.udesk.cn/api/v1/categories?email=admin@udesk.cn&timestamp=1529402431&sign=bd23cf273d088d9c9031958712670673dae1d5ce' -i -X POST -H 'Content-Type: application/json' -d '{
  "name" : "分類2",
  "parentId" : 342,
  "robotId" : 102,
  "classify": 1
}'
レスポンス
{
  "code" : 200,
  "message" : "OK",
  "visible" : false,
  "data" : {
    "id" : 404,
    "name" : "分類2",
    "parentId" : 342,
    "parentIds" : "0,342,",
    "robotId" : 102,
    "num": null, // numは現在の分類下のFAQ数を示します
    "type": 2,
    "classify": 1
  }
}

リクエスト失敗の原因

Message Description
"Duplicates name with existing directories" 既に同名の分類が存在する、または整数型パラメータの値が異常です
"【name】org.hibernate.validator.constraints.NotBlank.message" パラメータnameは空にできません
"【parentId】javax.validation.constraints.NotNull.message" パラメータparentIdは空にできません
"【robotId】javax.validation.constraints.NotNull.message" パラメータrobotIdは空にできません