テンプレート削除API

リクエストURL

リクエストパラメータ

リクエストパラメータ

Parameter Type Optional 説明
id Integer false テンプレートID

レスポンス

サンプル

$ curl 'https://km.udesk.cn/api/v1/datumTemplates/57?email=admin@udesk.cn&timestamp=1573026139&sign=31322f38618d50ee671ef073305ac9917e652374' -i -X DELETE -H 'Content-Type: application/json' -H 'Accept: application/json'

テンプレート詳細取得API

リクエストURL

リクエストパラメータ

リクエストフィールド

path Type Optional 説明
id Integer false テンプレートID.

レスポンス

Path Type 説明
code Integer 実行結果コード
message String 実行結果の説明
data Object テンプレート情報
data[].id Integer テンプレートID
data[].name String テンプレート名
data[].robotId Integer ロボットID
data[].orders Integer テンプレート順序
data[].parentId Integer テンプレート親ID（一級テンプレートの場合は0、それ以外の場合は具体的なID）
data[].remark String テンプレート説明（説明の長さは255文字以内）
data[].questionAndAnswerSet Integer テンプレートQ&A設定（0.なし 1.ナレッジデフォルト返信 2.ナレッジ明確化 4.ナレッジ推薦 8.ナレッジ検索）
data[].similarList[] String テンプレート別名
data[].attributes Array テンプレート属性リスト.
data[].attributes[].id Integer テンプレート属性ID
data[].attributes[].robotId Integer ロボットID
data[].attributes[].templateId Integer テンプレートID
data[].attributes[].name String テンプレート属性名
data[].attributes[].allowInherited Integer テンプレート継承可否（0.継承しない 1.継承可能）
data[].attributes[].answer String 属性名
data[].attributes[].askBack String 属性反問文
data[].attributes[].askBackFlag Integer 属性反問文タイプ
data[].attributes[].switchStatus Integer 属性スイッチ (0.オフ 1.オン)
data[].attributes[].similarList[] String 属性別名
data[].attributes[].expressionList[] String 属性表現
data[].datumDefaultAnswer Array ナレッジデフォルト返信
data[].datumDefaultAnswer.id Integer ID
data[].datumDefaultAnswer.robotId Integer ロボットID
data[].datumDefaultAnswer.templateId Integer テンプレートID
data[].datumDefaultAnswer.answerType Integer 返信タイプ(1.一部属性 2.属性反問をトリガー 3.全属性)
data[].datumDefaultAnswer.attributeIdList[] Integer 属性ID
data[].datumRecommendation Array ナレッジ推薦
data[].datumRecommendation.id Integer ナレッジID
data[].datumRecommendation.robotId Integer ロボットID
data[].datumRecommendation.templateId Integer テンプレートID
data[].datumRecommendation.noResultContent String 結果なし時の返信文言
data[].datumRecommendation.recommendationNumber Integer 推薦ナレッジ数
data[].datumSearch Array ナレッジ検索
data[].datumSearch.id Integer ID
data[].datumSearch.robotId Integer ロボットID
data[].datumSearch.templateId Integer テンプレートID
data[].datumSearch.noResultContent String 結果なし時の返信文言
data[].datumSearch.recommendationNumber Integer 推薦ナレッジ数
data[].datumSearch.strategies Array ナレッジ検索戦略
data[].datumSearch.strategies[].id Integer ID
data[].datumSearch.strategies[].robotId Integer ロボットID
data[].datumSearch.strategies[].templateId Integer テンプレートID
data[].datumSearch.strategies[].datumSearchId Integer ナレッジ検索ID
data[].datumSearch.strategies[].name String 戦略名
data[].datumSearch.strategies[].remark String 戦略説明
data[].datumSearch.strategies[].clarificationAskContent String 検索戦略問いかけ文
data[].datumSearch.strategies[].retrievalTarget Integer 検索対象 1: 属性取得 2: ナレッジ取得
data[].datumSearch.strategies[].attributeId Integer 属性ID 検索対象が属性取得の場合は必須（一つだけ選択可能）、ナレッジ取得の場合は空欄、全ナレッジを検索
data[].datumSearch.strategies[].clarificationContent String 明確化文言
data[].datumSearch.strategies[].clarificationRounds String 明確化ラウンド数
data[].datumSearch.strategies[].failureContent String 失敗文言
data[].datumClarify Object true
data[].datumClarify.robotId Integer true
data[].datumClarify.templateId Integer true
data[].datumClarify.recommendationNumber Integer true
data[].datumClarify.noResultContent String true
data[].datumClarify.clarifyType Integer true
data[].datumClarify.askType String true
data[].datumClarify.strategies Array true
data[].datumClarify.strategies[].robotId Integer true
data[].datumClarify.strategies[].templateId Integer true
data[].datumClarify.strategies[].datumClarifyId Integer true
data[].datumClarify.strategies[].name String true
data[].datumClarify.strategies[].remark String true
data[].datumClarify.strategies[].clarificationAskContent String true
data[].datumClarify.strategies[].retrievalTarget Integer true
data[].datumClarify.strategies[].attributeId Integer true
data[].datumClarify.strategies[].alternativePushContent Object true
data[].datumClarify.strategies[].alternativePushStatus.chosen Integer true
data[].datumClarify.strategies[].alternativePushStatus.style String true
data[].datumClarify.strategies[].alternativePushStatus.labelList Array true
data[].datumClarify.strategies[].alternativePushStatus.labelList[].id Integer true
data[].datumClarify.strategies[].alternativePushStatus.labelList[].name Integer true
data[].datumClarify.strategies[].alternativePushStatus.labelList[].content Integer true
data[].datumClarify.strategies[].clarificationContent String true
data[].datumClarify.strategies[].clarificationRounds String true
data[].datumClarify.strategies[].failureContent String true
data[].datumClarify.strategies[].orders Integer true
### サンプル 
$ curl 'https://km.udesk.cn/api/v1/datumTemplates/56?email=admin@udesk.cn&timestamp=1559022283&sign=aa8164470dff8468e6129c1e7d5767651cdedd7c' -i -X GET -H 'Content-Type: application/json' -H 'Accept: application/json'
レスポンス
{
    "code": 200,
    "message": "OK",
    "visible": false,
    "data": {
        "id": 56,
        "name": "小さなテンプレート",
        "robotId": 83,
        "orders": 1,
        "parentId": 21,
        "parentIds": "0-21",
        "remark": "テンプレートの説明です",
        "questionAndAnswerSet": 15,
        "attributes": [
            {
                "id": 135,
                "name": "テンプレートツリー行2",
                "robotId": 83,
                "templateId": 56,
                "similarList": [
                    "テンプレートツリー行2エイリアス",
                    "テンプレートツリー行2エイリアス2"
                ],
                "askBack": "どのテストで新規作成したテンプレートのテンプレートツリー行2について知りたいですか？",
                "askBackFlag": 0,
                "orders": 1,
                "allowInherited": 1,
                "switchStatus": 1,
                "answer": "<p>テンプレートツリー行2の値</p>",
                "expressionList": [
                    "haha",
                    "你好"
                ]
            },
            {
                "id": 136,
                "name": "テンプレート属性",
                "robotId": 83,
                "templateId": 56,
                "similarList": [
                    "テンプレート属性エイリアス",
                    "テンプレート属性エイリアス2"
                ],
                "askBack": "どのテストで新規作成したテンプレートのテンプレート属性について知りたいですか？",
                "askBackFlag": 0,
                "orders": 2,
                "allowInherited": 1,
                "switchStatus": 1,
                "answer": "<p>テンプレート属性の属性値</p>",
                "expressionList": [
                    "テンプレート属性表現2",
                    "テンプレート属性表現"
                ]
            }
        ],
        "similarList": [
            "テンプレートエイリアス"
        ],
        "datums": [],
        "datumDefaultAnswer": {
            "id": 8,
            "answerType": 3,
            "robotId": 83,
            "templateId": 56,
            "attributeIdList": [
                null
            ]
        },
        "datumRecommendation": {
            "id": 3,
            "robotId": 83,
            "templateId": 56,
            "recommendationNumber": 3,
            "noResultContent": "申し訳ございません。お客様の条件に合うナレッジが見つかりませんでした。再度質問してください"
        },
        "datumSearch": {
            "id": 3,
            "robotId": 83,
            "templateId": 56,
            "recommendationNumber": 3,
            "noResultContent": "申し訳ございません。お客様の条件に合うナレッジが見つかりませんでした。再度質問してください",
            "strategies": [
                {
                    "id": 2,
                    "robotId": 83,
                    "templateId": 56,
                    "datumSearchId": 3,
                    "name": "戦略2",
                    "remark": "戦略2の説明",
                    "retrievalTarget": 2,
                    "attributeId": null,
                    "clarificationAskContent": "戦略2の説明です",
                    "clarificationContent": "戦略2の説明 明確化ツリー",
                    "clarificationRounds": 2,
                    "failureContent": "申し訳ございません。検索に失敗しました。再度質問してください",
                    "orders": 1
                },
                {
                    "id": 3,
                    "robotId": 83,
                    "templateId": 56,
                    "datumSearchId": 3,
                    "name": "検索戦略",
                    "remark": "検索戦略の説明",
                    "retrievalTarget": 2,
                    "attributeId": null,
                    "clarificationAskContent": "検索の問い方",
                    "clarificationContent": "明確化ツリーです",
                    "clarificationRounds": 2,
                    "failureContent": "申し訳ございません。検索に失敗しました。再度質問してください",
                    "orders": 2
                }
            ]
        }
    }
}

リクエスト失敗の原因

message description
"データが削除されたか存在しません" 対応するIDのテンプレートが存在しません

新規テンプレート作成インターフェース

リクエストURL

リクエストパラメータ

リクエストフィールド

Path Type Optional 説明
name String false テンプレート名
robotId Integer false ロボットID
parentId Integer false 継承元テンプレート（1階層目のテンプレートの場合は0、それ以外の階層の場合は親テンプレートIDを指定）
remark String true テンプレートの説明（説明の長さは255文字以内）
questionAndAnswerSet Integer false テンプレートの質問応答設定（0.なし 1.ナレッジデフォルト応答 2.ナレッジ明確化 4.ナレッジ推薦 8.ナレッジ検索）
similarList[] String true 別名
attributes Array true 属性リスト
attributes[].name String true 属性名
attributes[].allowInherited Integer false 継承を許可するか（0.継承しない 1.継承可能）
attributes[].answer String true 属性値()
attributes[].askBack String true 逆質問の仕方
attributes[].askBackFlag Integer true 逆質問のタイプ
attributes[].switchStatus Integer false 属性スイッチ (0.オフ 1.オン)
attributes[].changeType Integer false 変更タイプ (0.変更なし 1.新規追加 2.更新 3.削除)
attributes[].similarList[] String true 属性の別名
attributes[].expressionList[] String true 属性の表現
datumDefaultAnswer Array true ナレッジデフォルト応答
datumDefaultAnswer.answerType Integer false 応答タイプ(1.一部属性 2.属性逆質問をトリガー 3.全属性)
datumDefaultAnswer.attributeIdList[] Integer true 属性ID（応答タイプが全属性でない場合は必須）
datumRecommendation Array true ナレッジ推薦
datumRecommendation.noResultContent String false 結果なし時の返答文言
datumRecommendation.recommendationNumber Integer false 推薦ナレッジ数
datumSearch Object true ナレッジ検索
datumSearch.noResultContent String false 結果なし時の返答文言
datumSearch.recommendationNumber Integer false 推薦ナレッジ数
datumSearch.strategies Array true ナレッジ検索戦略
datumSearch.strategies[].name String false 戦略名
datumSearch.strategies[].remark String true 戦略の説明
datumSearch.strategies[].clarificationAskContent String false 検索戦略の問い方
datumSearch.strategies[].retrievalTarget Integer false 検索対象 1: 属性を取得 2: ナレッジを取得
datumSearch.strategies[].attributeId Integer true 属性ID（検索対象が属性取得の場合は必須（1つのみ選択可能）、ナレッジ取得の場合は不要、全ナレッジを検索）
datumSearch.strategies[].clarificationContent String true 明確化文言
datumSearch.strategies[].clarificationRounds String true 明確化ラウンド数
datumSearch.strategies[].failureContent String true 失敗文言
datumClarify Object true ナレッジ明確化
datumClarify.robotId Integer true ロボットID
datumClarify.templateId Integer true テンプレートID
datumClarify.recommendationNumber Integer true ナレッジ推薦数
datumClarify.noResultContent String true 結果なし時の返答文言
datumClarify.clarifyType Integer true 検索戦略 1 属性逆質問 2 戦略追跡質問
datumClarify.askType String true 検索タイプ 1.優先度 2.インテリジェント検索
datumClarify.strategies Array true 戦略名
datumClarify.strategies[].robotId Integer true ロボットID
datumClarify.strategies[].templateId Integer true テンプレートID
datumClarify.strategies[].datumClarifyId Integer true ナレッジ明確化ID
datumClarify.strategies[].name String true 戦略名
datumClarify.strategies[].remark String true 戦略の説明
datumClarify.strategies[].clarificationAskContent String true 検索戦略の問い方
datumClarify.strategies[].retrievalTarget Integer true 検索対象 1: 属性を取得 2: ナレッジを取得
datumClarify.strategies[].attributeId Integer true 属性ID（検索対象が属性取得の場合は必須（1つのみ選択可能）、ナレッジ取得の場合は不要、全ナレッジを検索）
datumClarify.strategies[].alternativePushContent Object true 代替プッシュスイッチ
datumClarify.strategies[].alternativePushStatus.chosen Integer true 選択されたスタイル 0 1 2
datumClarify.strategies[].alternativePushStatus.style String true スタイルテンプレート
datumClarify.strategies[].alternativePushStatus.labelList Array true ラベルリスト
datumClarify.strategies[].alternativePushStatus.labelList[].id Integer true ラベルID
datumClarify.strategies[].alternativePushStatus.labelList[].name Integer true ラベル名
datumClarify.strategies[].alternativePushStatus.labelList[].content Integer true ラベル内容
datumClarify.strategies[].clarificationContent String true 明確化文言
datumClarify.strategies[].clarificationRounds String true 明確化ラウンド数
datumClarify.strategies[].failureContent String true 失敗文言
datumClarify.strategies[].orders Integer true ソート優先度
### リクエスト結果
Path Type Description
--- --- ---
code Integer 実行結果コード
message String 実行結果説明
data Object テンプレート情報
data[].id Integer テンプレートID
data[].name String テンプレート名
data[].robotId Integer ロボットID
data[].orders Integer 並び順
data[].parentId Integer 継承元テンプレート
data[].remark String テンプレート説明
data[].questionAndAnswerSet Integer テンプレートQ&A設定（0.なし 1.ナレッジデフォルト返信 2.ナレッジ明確化 4.ナレッジ推薦 8.ナレッジ検索）
data[].similarList[] String 別名
data[].attributes Array 属性リスト
data[].attributes[].id Integer ID
data[].attributes[].robotId Integer ロボットID
data[].attributes[].templateId Integer テンプレートID
data[].attributes[].name String 属性名
data[].attributes[].allowInherited Integer 継承を許可するか（0.継承しない 1.継承可能）
data[].attributes[].answer String 属性値()
data[].attributes[].askBack String 逆質問の問い方
data[].attributes[].askBackFlag Integer 逆質問の問い方タイプ
data[].attributes[].switchStatus Integer 属性スイッチ (0.オフ 1.オン)
data[].attributes[].changeType Integer 変更タイプ (0.変更なし 1.新規追加 2.更新 3.削除)
data[].attributes[].similarList[] String 属性別名
data[].attributes[].expressionList[] String 属性表現
data[].datumDefaultAnswer Array ナレッジベースデフォルト返信
data[].datumDefaultAnswer.id Integer ID
data[].datumDefaultAnswer.robotId Integer ロボットID
data[].datumDefaultAnswer.templateId Integer テンプレートID
data[].datumDefaultAnswer.answerType Integer 返信タイプ(1.一部属性 2.属性逆質問をトリガー 3.全属性)
data[].datumDefaultAnswer.attributeIdList[] Integer 属性ID 返信タイプが全属性でない場合は必須
data[].datumRecommendation Array ナレッジ推薦
data[].datumRecommendation.id Integer ID
data[].datumRecommendation.robotId Integer ロボットID
data[].datumRecommendation.templateId Integer テンプレートID
data[].datumRecommendation.noResultContent String 結果なし時の返信文言
data[].datumRecommendation.recommendationNumber Integer 推薦ナレッジ数
data[].datumSearch Array ナレッジ検索
data[].datumSearch.id Integer ID
data[].datumSearch.robotId Integer ロボットID
data[].datumSearch.templateId Integer テンプレートID
data[].datumSearch.noResultContent String 結果なし時の返信文言
data[].datumSearch.recommendationNumber Integer 推薦ナレッジ数
data[].datumSearch.strategies Array ナレッジ検索戦略
data[].datumSearch.strategies[].id Integer ID
data[].datumSearch.strategies[].robotId Integer ロボットID
data[].datumSearch.strategies[].templateId Integer テンプレートID
data[].datumSearch.strategies[].datumSearchId Integer ナレッジ検索ID
data[].datumSearch.strategies[].name String 戦略名
data[].datumSearch.strategies[].remark String 戦略説明
data[].datumSearch.strategies[].clarificationAskContent String 検索戦略の問い方
data[].datumSearch.strategies[].retrievalTarget Integer 検索対象 (1. 属性を取得 2. ナレッジを取得)
data[].datumSearch.strategies[].attributeId Integer 属性ID 検索対象が属性取得の場合は必須（1つのみ選択可能）、ナレッジ取得の場合は入力不要、全ナレッジを検索
data[].datumSearch.strategies[].clarificationContent String 明確化文言
data[].datumSearch.strategies[].clarificationRounds String 明確化ラウンド数
data[].datumSearch.strategies[].failureContent String 失敗時の文言
data[].datumClarify Object true ナレッジ明確化
data[].datumClarify.robotId Integer true ロボットId
data[].datumClarify.templateId Integer true テンプレートId
data[].datumClarify.recommendationNumber Integer true ナレッジ推薦数
data[].datumClarify.noResultContent String true 結果なし時の返信文言
data[].datumClarify.clarifyType Integer true 検索戦略1 属性逆質問 2戦略追跡質問
data[].datumClarify.askType String true 検索タイプ 1.優先順位 2.インテリジェント検索
data[].datumClarify.strategies Array true 戦略名
data[].datumClarify.strategies[].robotId Integer true ロボットId
data[].datumClarify.strategies[].templateId Integer true テンプレートId
data[].datumClarify.strategies[].datumClarifyId Integer true ナレッジ明確化Id
data[].datumClarify.strategies[].name String true 戦略名
data[].datumClarify.strategies[].remark String true 戦略説明
data[].datumClarify.strategies[].clarificationAskContent String true 検索戦略の問い方
data[].datumClarify.strategies[].retrievalTarget Integer true 検索対象 1: 属性を取得 2: ナレッジを取得
data[].datumClarify.strategies[].attributeId Integer true 属性ID 検索対象が属性取得の場合は必須（1つのみ選択可能）、ナレッジ取得の場合は入力不要、全ナレッジを検索
data[].datumClarify.strategies[].alternativePushContent Object true 代替プッシュスイッチ
data[].datumClarify.strategies[].alternativePushStatus.chosen Integer true 選択されたスタイル 0 1 2
data[].datumClarify.strategies[].alternativePushStatus.style String true スタイルテンプレート
data[].datumClarify.strategies[].alternativePushStatus.labelList Array true ラベルリスト
data[].datumClarify.strategies[].alternativePushStatus.labelList[].id Integer true ラベルId
data[].datumClarify.strategies[].alternativePushStatus.labelList[].name Integer true ラベル名
data[].datumClarify.strategies[].alternativePushStatus.labelList[].content Integer true ラベル内容
data[].datumClarify.strategies[].clarificationContent String true 明確化文言
data[].datumClarify.strategies[].clarificationRounds String true 明確化ラウンド数
data[].datumClarify.strategies[].failureContent String true 失敗時の文言
data[].datumClarify.strategies[].orders Integer true 並び順優先度
### サンプル 
$ curl 'https://km.udesk.cn/api/v1/datumTemplates?email=admin@udesk.cn&timestamp=1559016113&sign=f16d7f6fcc3fbab73855f4510cd4904f0f60e258' -i -X POST -H 'Content-Type: application/json' -H 'Accept: application/json' -d '{
    "name": "小さなテンプレート",
    "robotId": 83,
    "similarList": ["テンプレート別名"],
    "parentId": 21,
    "remark": "テンプレートの説明です",
    "questionAndAnswerSet": 15,
    "attributes": [{
        "name": "テンプレートツリー行2",
        "similarList": ["テンプレートツリー行2別名", "テンプレートツリー行2別名2"],
        "allowInherited": 1,
        "answer": "<p>テンプレートツリー行2の値</p>",
        "askBack": "どのテストで新規作成したテンプレートのテンプレートツリー行2について知りたいですか？",
        "askBackFlag": 0,
        "switchStatus": 1,
        "expressionList": ["こんにちは", "haha"],
        "changeType": 1
    }, {
        "name": "テンプレート属性",
        "similarList": ["テンプレート属性別名", "テンプレート属性別名2"],
        "allowInherited": 1,
        "answer": "<p>テンプレート属性の属性値</p>",
        "askBack": "どのテストで新規作成したテンプレートのテンプレート属性について知りたいですか？",
        "askBackFlag": 0,
        "switchStatus": 1,
        "expressionList": ["テンプレート属性の表現", "テンプレート属性の表現2"],
        "changeType": 1
    }],
    "datumDefaultAnswer": {
        "answerType": 3
    },
    "datumRecommendation": {
        "noResultContent": "申し訳ございません。お客様の条件に合うナレッジが見つかりませんでした。再度質問してください。",
        "recommendationNumber": 3
    },
    "datumSearch": {
        "noResultContent": "申し訳ございません。お客様の条件に合うナレッジが見つかりませんでした。再度質問してください。",
        "recommendationNumber": 3,
        "strategies": [{
            "name": "戦略2",
            "remark": "戦略2の説明",
            "clarificationAskContent": "戦略2の説明です",
            "retrievalTarget": 2,
            "clarificationContent": "戦略2の説明の明確化ツリー",
            "clarificationRounds": 2,
            "failureContent": "申し訳ございません。検索に失敗しました。再度質問してください。"
        }, {
            "name": "検索戦略",
            "remark": "検索戦略の説明",
            "clarificationAskContent": "検索の問い方",
            "retrievalTarget": 2,
            "clarificationContent": "明確化ツリーです",
            "clarificationRounds": 2,
            "failureContent": "申し訳ございません。検索に失敗しました。再度質問してください。"
        }]
    }
}'
戻り値
{
    "code": 200,
    "message": "OK",
    "visible": false,
    "data": {
        "id": 56,
        "name": "小さなテンプレート",
        "robotId": 83,
        "orders": 1,
        "parentId": 21,
        "parentIds": "0-21",
        "remark": "テンプレートの説明です",
        "questionAndAnswerSet": 15,
        "attributes": [
            {
                "id": 135,
                "name": "テンプレートツリー行2",
                "robotId": 83,
                "templateId": 56,
                "similarList": [
                    "テンプレートツリー行2エイリアス",
                    "テンプレートツリー行2エイリアス2"
                ],
                "askBack": "どのテストで新規作成したテンプレートのテンプレートツリー行2について知りたいですか？",
                "askBackFlag": 0,
                "orders": 1,
                "allowInherited": 1,
                "switchStatus": 1,
                "answer": "<p>テンプレートツリー行2の値</p>",
                "expressionList": [
                    "こんにちは",
                    "haha"
                ]
            },
            {
                "id": 136,
                "name": "テンプレート属性",
                "robotId": 83,
                "templateId": 56,
                "similarList": [
                    "テンプレート属性エイリアス",
                    "テンプレート属性エイリアス2"
                ],
                "askBack": "どのテストで新規作成したテンプレートのテンプレート属性について知りたいですか？",
                "askBackFlag": 0,
                "orders": 2,
                "allowInherited": 1,
                "switchStatus": 1,
                "answer": "<p>テンプレート属性の属性値</p>",
                "expressionList": [
                    "テンプレート属性の表現",
                    "テンプレート属性の表現2"
                ]
            }
        ],
        "similarList": [
            "テンプレートエイリアス"
        ],
        "datums": [],
        "datumDefaultAnswer": {
            "id": null,
            "answerType": 3,
            "robotId": 83,
            "templateId": 56,
            "attributeIdList": null
        },
        "datumRecommendation": {
            "id": 3,
            "robotId": 83,
            "templateId": 56,
            "recommendationNumber": 3,
            "noResultContent": "申し訳ございません。お客様の条件に合致するナレッジが見つかりませんでした。再度質問してください"
        },
        "datumSearch": {
            "id": 3,
            "robotId": 83,
            "templateId": 56,
            "recommendationNumber": 3,
            "noResultContent": "申し訳ございません。お客様の条件に合致するナレッジが見つかりませんでした。再度質問してください",
            "strategies": [
                {
                    "id": 1,
                    "robotId": 83,
                    "templateId": 56,
                    "datumSearchId": 3,
                    "name": "戦略2",
                    "remark": "戦略2の説明",
                    "retrievalTarget": 2,
                    "attributeId": 1,
                    "clarificationAskContent": "戦略2の説明です",
                    "clarificationContent": "戦略2の説明の明確化ツリー",
                    "clarificationRounds": 2,
                    "failureContent": "申し訳ございません。検索に失敗しました。再度質問してください",
                    "orders": 1
                },
                {
                    "id": 2,
                    "robotId": 83,
                    "templateId": 56,
                    "datumSearchId": 3,
                    "name": "検索戦略",
                    "remark": "検索戦略の説明",
                    "retrievalTarget": 2,
                    "attributeId": 2,
                    "clarificationAskContent": "検索の問い方",
                    "clarificationContent": "明確化ツリーです",
                    "clarificationRounds": 2,
                    "failureContent": "申し訳ございません。検索に失敗しました。再度質問してください",
                    "orders": 2
                }
            ]
        }
    }
}

テンプレート更新インターフェース

リクエストアドレス

リクエストパラメータ

リクエストフィールド

path タイプ オプション 説明
id Integer false ID
name String false テンプレート名
robotId Integer false ロボットID
orders Integer true ソート順
parentId Integer false 継承元テンプレート（1階層目のテンプレートの場合は0、それ以外の場合は親テンプレートIDを指定）
remark String true テンプレート説明（説明は255文字以内）
questionAndAnswerSet Integer false テンプレートQ&A設定（0.なし 1.ナレッジデフォルト返信 2.ナレッジ明確化 4.ナレッジ推薦 8.ナレッジ検索）
similarList[] String true エイリアス
attributes Array true 属性リスト
attributes[].id Integer false ID
attributes[].robotId Integer false ロボットID
attributes[].templateId Integer false テンプレートID
attributes[].name String true 属性名
attributes[].allowInherited Integer false 継承を許可するか（0.継承しない 1.継承可能）
attributes[].answer String true 属性値
attributes[].askBack String true 逆質問の仕方
attributes[].askBackFlag Integer true 逆質問タイプ
attributes[].switchStatus Integer false 属性スイッチ (0.オフ 1.オン)
attributes[].changeType Integer false 変更タイプ (0.変更なし 1.追加 2.更新 3.削除)
attributes[].similarList[] String true 属性エイリアス
attributes[].expressionList[] String true 属性表現
datumDefaultAnswer Array true 資料庫デフォルト返信
datumDefaultAnswer.id Integer false ID
datumDefaultAnswer.robotId Integer false ロボットID
datumDefaultAnswer.templateId Integer false テンプレートID
datumDefaultAnswer.answerType Integer false 返信タイプ(1.一部属性 2.属性逆質問をトリガー 3.全属性)
datumDefaultAnswer.attributeIdList[] Integer true 属性ID（返信タイプが全属性でない場合は必須）
datumRecommendation Array true ナレッジ推薦
datumRecommendation.id Integer false ID
datumRecommendation.robotId Integer false ロボットID
datumRecommendation.templateId Integer false テンプレートID
datumRecommendation.noResultContent String false 結果なし時の返信文言
datumRecommendation.recommendationNumber Integer false 推薦ナレッジ数
datumSearch Array true ナレッジ検索
datumSearch.id Integer false ID
datumSearch.robotId Integer false ロボットID
datumSearch.templateId Integer false テンプレートID
datumSearch.noResultContent String false 結果なし時の返信文言
datumSearch.recommendationNumber Integer false 推薦ナレッジ数
datumSearch.strategies Array true ナレッジ検索戦略
datumSearch.strategies[].id Integer false ID
datumSearch.strategies[].robotId Integer false ロボットID
datumSearch.strategies[].templateId Integer false テンプレートID
datumSearch.strategies[].datumSearchId Integer false ナレッジ検索ID
datumSearch.strategies[].name String false 戦略名
datumSearch.strategies[].remark String true 戦略説明
datumSearch.strategies[].clarificationAskContent String false 検索戦略の問い方
datumSearch.strategies[].retrievalTarget Integer false 検索対象 1. 属性取得 2. ナレッジ取得
datumSearch.strategies[].attributeId Integer true 属性ID（検索対象が属性取得の場合は必須（1つのみ選択可能）、ナレッジ取得の場合は入力不要、全ナレッジを検索）
datumSearch.strategies[].clarificationContent String true 明確化文言
datumSearch.strategies[].clarificationRounds String true 明確化ラウンド数
datumSearch.strategies[].failureContent String true 失敗文言
datumClarify Object true ナレッジ明確化
datumClarify.robotId Integer true ロボットID
datumClarify.templateId Integer true テンプレートID
datumClarify.recommendationNumber Integer true ナレッジ推薦数
datumClarify.noResultContent String true 結果なし時の返信文言
datumClarify.clarifyType Integer true 検索戦略 1 属性逆質問 2 戦略追跡質問
datumClarify.askType String true 検索タイプ 1.優先順位 2.インテリジェント検索
datumClarify.strategies Array true 戦略名
datumClarify.strategies[].robotId Integer true ロボットID
datumClarify.strategies[].templateId Integer true テンプレートID
datumClarify.strategies[].datumClarifyId Integer true ナレッジ明確化ID
datumClarify.strategies[].name String true 戦略名
datumClarify.strategies[].remark String true 戦略説明
datumClarify.strategies[].clarificationAskContent String true 検索戦略の問い方
datumClarify.strategies[].retrievalTarget Integer true 検索対象 1: 属性取得 2: ナレッジ取得
datumClarify.strategies[].attributeId Integer true 属性ID（検索対象が属性取得の場合は必須（1つのみ選択可能）、ナレッジ取得の場合は入力不要、全ナレッジを検索）
datumClarify.strategies[].alternativePushContent Object true 代替プッシュスイッチ
datumClarify.strategies[].alternativePushStatus.chosen Integer true 選択したスタイル 0 1 2
datumClarify.strategies[].alternativePushStatus.style String true スタイルテンプレート
datumClarify.strategies[].alternativePushStatus.labelList Array true ラベルリスト
datumClarify.strategies[].alternativePushStatus.labelList[].id Integer true ラベルID
datumClarify.strategies[].alternativePushStatus.labelList[].name Integer true ラベル名
datumClarify.strategies[].alternativePushStatus.labelList[].content Integer true ラベル内容
datumClarify.strategies[].clarificationContent String true 明確化文言
datumClarify.strategies[].clarificationRounds String true 明確化ラウンド数
datumClarify.strategies[].failureContent String true 失敗文言
datumClarify.strategies[].orders Integer true ソート優先順位
### リクエスト結果
Path Type Description
--- --- ---
code Integer ステータスコード
message String 返却メッセージ
visible Boolean
data Object 返却内容

例

$ curl 'https://km.udesk.cn/api/v1/datumTemplates/56?email=admin@udesk.cn&timestamp=1559022283&sign=aa8164470dff8468e6129c1e7d5767651cdedd7c' -i -X PUT -H 'Content-Type: application/json' -H 'Accept: application/json' -d '{
    "id":56,
    "name": "小小テンプレート",
    "robotId": 83,
    "similarList": ["テンプレート別名"],
    "parentId": 21,
    "remark": "テンプレートの説明",
    "questionAndAnswerSet": 15,
    "attributes": [{
        "name": "テンプレートツリー行2",
        "similarList": ["テンプレートツリー行2別名", "テンプレートツリー行2別名2"],
        "allowInherited": 1,
        "answer": "<p>テンプレートツリー行2の値</p>",
        "askBack": "どのテストで新規作成したテンプレートのテンプレートツリー行2について知りたいですか？",
        "askBackFlag": 0,
        "switchStatus": 1,
        "expressionList": ["こんにちは", "haha"],
        "changeType": 1
    }, {
        "name": "テンプレート属性",
        "similarList": ["テンプレート属性別名", "テンプレート属性別名2"],
        "allowInherited": 1,
        "answer": "<p>テンプレート属性の値</p>",
        "askBack": "どのテストで新規作成したテンプレートのテンプレート属性について知りたいですか？",
        "askBackFlag": 0,
        "switchStatus": 1,
        "expressionList": ["テンプレート属性の表現", "テンプレート属性の表現2"],
        "changeType": 1
    }],
    "datumDefaultAnswer": {
        "answerType": 3
    },
    "datumRecommendation": {
        "noResultContent": "申し訳ございません。お客様の条件に合うナレッジが見つかりませんでした。再度質問してください。",
        "recommendationNumber": 3
    },
    "datumSearch": {
        "noResultContent": "申し訳ございません。お客様の条件に合うナレッジが見つかりませんでした。再度質問してください。",
        "recommendationNumber": 3,
        "strategies": [{
            "name": "戦略2",
            "remark": "戦略2の説明",
            "clarificationAskContent": "戦略2の説明です",
            "retrievalTarget": 2,
            "clarificationContent": "戦略2の説明 明確化ツリー",
            "clarificationRounds": 2,
            "failureContent": "申し訳ございません。検索に失敗しました。再度質問してください。"
        }, {
            "name": "検索戦略",
            "remark": "検索戦略の説明",
            "clarificationAskContent": "検索の問い方",
            "retrievalTarget": 2,
            "clarificationContent": "明確化ツリー",
            "clarificationRounds": 2,
            "failureContent": "申し訳ございません。検索に失敗しました。再度質問してください。"
        }]
    }
}'
レスポンス
{
    "code": 200,
    "message": "OK",
    "visible": false,
    "exception":null,
    "paging":null,
    "data": null
}

テンプレートリスト取得インターフェース

リクエストURL

リクエストパラメータ

リクエストフィールド

Path Type Optional 説明
pageNum Integer true ページ番号
pageSize Integer true 1ページあたりの件数
robotId Integer false ボットID
leafFlag Integer true テンプレートタイプ（1. リーフテンプレート 2. すべてのテンプレート）（デフォルトはリーフテンプレート）
keyword String true キーワード検索

レスポンス結果

Path Type 説明
code Integer ステータスコード
message String 返却メッセージ
data Object 返却内容
data[].id Integer テンプレートID
data[].name String テンプレート名
data[].robotId Integer ボットID
data[].parentId Integer 親テンプレートID
data[].leafFlag Integer リーフテンプレートかどうか（0. いいえ 1. はい）
data[].rootId Integer ルートテンプレートID
data[].remark String テンプレート説明
data[].questionAndAnswerSet Integer テンプレートQ&A設定（0.なし 1.ナレッジデフォルト返信 2.ナレッジ明確化 4.ナレッジ推奨 8.ナレッジ検索）
data[].similarList[] String テンプレート別名

サンプル

$ curl 'https://km.udesk.cn/api/v1/datumTemplates/search?email=admin@udesk.cn&timestamp=1578367138&sign=4e6cfa92d0ef5f5ed214e7dfa4be766cc1b86254' -i -X POST -H 'Content-Type: application/json' -H 'Accept: application/json' -d '{
    "pageNum":1,
    "pageSize":10,
    "robotId":83,
    "keyword":"国"
}'
レスポンス
{
    "code": 200,
    "message": "OK",
    "visible": false,
    "paging": {
        "pageNum": 1,
        "pageSize": 10,
        "total": 1
    },
    "data": [
        {
            "id": 127,
            "name": "国家",
            "robotId": 83,
            "parentId": 0,
            "remark": "",
            "questionAndAnswerSet": 15,
            "leafFlag": 1,
            "rootId": 127,
            "similarList": []
        }
    ]
}

ナレッジ削除API

リクエストURL

リクエストパラメータ

リクエストパラメータ

パラメータ 型 オプション 説明
id Integer false ナレッジID

レスポンス

サンプルコード

$ curl 'https://km.udesk.cn/api/v1/datums/2?email=admin@udesk.cn&timestamp=1573026139&sign=31322f38618d50ee671ef073305ac9917e652374' -i -X DELETE -H 'Content-Type: application/json' -H 'Accept: application/json'

ナレッジ詳細取得API

リクエストURL

リクエストパラメータ

リクエストフィールド

パス 型 オプション 説明
id Integer false ナレッジID

レスポンス

パス 型 説明
code Integer 実行結果コード
message String 実行結果の説明
data Object ナレッジ情報
data[].id Array ナレッジID
data[].robotId Integer ボットID
data[].name String ナレッジ名
data[].displayName String ナレッジ表示名
data[].templateId Integer テンプレートID
data[].templateName String テンプレート名
data[].similarList[] String 同義語
data[].categoryId Integer カテゴリID
data[].orders Integer ソートID
dada[].attributes Array ナレッジ属性値
data[].attributes[].id Integer ID
data[].attributes[].name String 属性名
data[].attributes[].robotId Integer ボットID
data[].attributes[].datumId Integer ナレッジID
data[].attributes[].templateId Integer テンプレートID
data[].attributes[].templateAttributeId Integer テンプレート属性ID
data[].attributes[].switchStatus Integer 有効/無効（0.無効 1.有効）
data[].attributes[].answer String リッチテキスト回答
data[].attributes[].srcType Integer ソースタイプ（0.カスタム 1.テンプレート属性値から継承）

サンプルコード

$ curl 'https://km.udesk.cn/api/v1/datums/2?email=admin@udesk.cn&timestamp=1559022283&sign=aa8164470dff8468e6129c1e7d5767651cdedd7c' -i -X GET -H 'Content-Type: application/json' -H 'Accept: application/json'
返却
{
    "code": 200,
    "message": "OK",
    "visible": false,
    "data": {
        "id": 1,
        "name": "Udeskテスト名称",
        "similarList": [],
        "robotId": 83,
        "templateId": 45,
        "templateName": "Udeskテストテンプレート",
        "categoryId": 23,
        "orders": null,
        "category": null,
        "attributes": [
            {
                "id": 330,
                "name": "Udeskナレッジ名",
                "robotId": 83,
                "datumId": 1,
                "templateId": 45,
                "templateAttributeId": 53,
                "switchStatus": null,
                "answer": "Udeskナレッジ回答",
                "srcType": 0
            }
        ]
    }
}

ナレッジ作成API

リクエストURL

リクエストパラメータ

リクエストフィールド

Path Type Optional 説明
robotId Integer false ボットID
name String false ナレッジ名
templateId Integer false テンプレートID
categoryId Integer false カテゴリID
displayName String false ナレッジ表示名
### レスポンス
Path Type 説明
--- --- ---
code Integer 実行結果コード
message String 実行結果メッセージ
data Object ナレッジ情報
data[].id Array ナレッジID
data[].robotId Integer ボットID
data[].name String ナレッジ名
data[].displayName String ナレッジ表示名
data[].templateId Integer テンプレートID
data[].templateName String テンプレート名
data[].similarList[] String 同義語
data[].categoryId Integer カテゴリID
data[].orders Integer ソートID
dada[].attributes Array ナレッジ属性値
data[].attributes[].id Integer ナレッジ属性値ID
data[].attributes[].name String 属性名
data[].attributes[].robotId Integer ボットID
data[].attributes[].datumId Integer ナレッジID
data[].attributes[].templateId Integer テンプレートID
data[].attributes[].templateAttributeId Integer テンプレート属性ID
data[].attributes[].switchStatus Integer 有効/無効 (0.無効 1.有効)
data[].attributes[].answer String リッチテキスト回答
data[].attributes[].srcType Integer ソースタイプ (0.カスタム 1.テンプレート属性値から継承)
### サンプル 
curl 'http://www.udesk.cn/v1/datums?email=admin@udesk.cn&timestamp=1573024943&sign=b5236e4bc2e73e529d544ace070f8c31369ca9dd' -i -X PUT -H 'Content-Type: application/json' -d '{
    "name":"新建知识点了哦",
    "robotId":83,
    "templateId":56,
    "categoryId":23
}'
レスポンス
{
    "code": 200,
    "message": "OK",
    "visible": false,
    "data": {
        "id": 3,
        "name": "Udeskテストナレッジポイント",
        "similarList": [],
        "robotId": 83,
        "templateId": 56,
        "templateName": "Udeskテストテンプレート",
        "categoryId": 23,
        "orders": 1,
        "category": 23,
        "attributes": [
            {
                "id": 1,
                "name": "苦情・提案",
                "robotId": 83,
                "datumId": 3,
                "templateId": 56,
                "templateAttributeId": 33,
                "switchStatus": null,
                "answer": null,
                "srcType": null
            },
            {
                "id": 2,
                "name": "テンプレートツリー行2",
                "robotId": 83,
                "datumId": 3,
                "templateId": 56,
                "templateAttributeId": 135,
                "switchStatus": null,
                "answer": "<p>テンプレートツリー行2の値</p>",
                "srcType": 1
            }
        ]
    }
}

リクエスト失敗の原因

{
  "code": 400,
  "message": "{具体的な例外情報}",
  "visible": false
}
message description
"データは削除されたか存在しません" 対応するIDのナレッジポイントは既に存在しません

ナレッジポイント更新API

リクエストURL

リクエストパラメータ

リクエストフィールド

path Type Optional Description
robotId Integer false ロボットID
name String false ナレッジポイント名
displayName String false ナレッジポイント表示名
templateId Integer false テンプレートID
templateName String false テンプレート名
similarList[] String true 同義語
categoryId Integer false カテゴリID
orders Integer false ソートID
attributes Array true ナレッジポイント属性値（ナレッジポイント属性値は変更のみ可能で、新規追加や削除はできません。ナレッジポイント詳細から取得してください）
attributes[].id Integer false ID
attributes[].name String false 属性名
attributes[].robotId Integer false ロボットID
attributes[].datumId Integer false ナレッジポイントID
attributes[].templateId Integer false テンプレートID
attributes[].templateAttributeId Integer false テンプレート属性ID
attributes[].switchStatus Integer false オン/オフ（0.オフ 1.オン）
attributes[].answer String true リッチテキスト回答
attributes[].srcType Integer false ソースタイプ（0.カスタム 1.テンプレート属性値から継承）（属性にデフォルト値がない場合、または属性デフォルト値と異なる場合、srcTypeは0になります）
### リクエスト結果
Path Type Description
--- --- ---
code Integer ステータスコード
message String 返却メッセージ
data Object 返却内容

サンプル

$ curl 'https://km.udesk.cn/api/v1/datums/3?email=admin@udesk.cn&timestamp=1559022283&sign=aa8164470dff8468e6129c1e7d5767651cdedd7c' -i -X PUT -H 'Content-Type: application/json' -H 'Accept: application/json' -d '{
            "id": 3,
            "name": "又新建知识点了哦",
            "similarList": [],
            "robotId": 83,
            "templateId": 56,
            "templateName": null,
            "categoryId": 23,
            "orders": null,
            "category": null,
            "attributes": [
                {
                    "id": 1,
                    "name": "投诉建议",
                    "robotId": 83,
                    "datumId": 3,
                    "templateId": 56,
                    "templateAttributeId": 33,
                    "switchStatus": null,
                    "answer": null,
                    "srcType": null
                },
                {
                    "id": 2,
                    "name": "模版树行2",
                    "robotId": 83,
                    "datumId": 3,
                    "templateId": 56,
                    "templateAttributeId": 135,
                    "switchStatus": null,
                    "answer": "<p>模版树行2值</p>",
                    "srcType": 1
                }
            ]
        }'
返却
{
    "code": 200,
    "message": "OK",
    "visible": false,
    "data": {
        "id": 3,
        "name": "又新建知识点了哦",
        "similarList": [],
        "robotId": 83,
        "templateId": 56,
        "templateName": null,
        "categoryId": 23,
        "orders": null,
        "category": null,
        "attributes": [
                {
                    "id": 1,
                    "name": "投诉建议",
                    "robotId": 83,
                    "datumId": 3,
                    "templateId": 56,
                    "templateAttributeId": 33,
                    "switchStatus": null,
                    "answer": null,
                    "srcType": null
                },
                {
                    "id": 2,
                    "name": "模版树行2",
                    "robotId": 83,
                    "datumId": 3,
                    "templateId": 56,
                    "templateAttributeId": 135,
                    "switchStatus": null,
                    "answer": "<p>模版树行2值</p>",
                    "srcType": 1
                }
            ]
    }
}

カテゴリリスト取得インターフェース

リクエストURL

リクエストパラメータ

リクエストフィールド

Path Type Optional 説明
pageNum Integer true ページ番号
pageSize Integer true 1ページあたりの件数
robotId Integer false ロボットID
keyword String true キーワード検索

レスポンス結果

Path Type 説明
code Integer 実行結果コード
message String 実行結果の説明
data Object カテゴリ情報
data[].id Integer カテゴリID
data[].name String カテゴリ名
data[].robotId Integer ロボットID
data[].parentId Integer 親カテゴリID

サンプル

$ curl 'https://km.udesk.cn/api/v1/datumCategories/search?email=admin@udesk.cn&timestamp=1578367614&sign=5548fd5ad06564b64f6925aeed99ec937d17f444' -i -X POST -H 'Content-Type: application/json' -H 'Accept: application/json' -d '{
    "pageNum":1,
    "pageSize":10,
    "robotId":83,
    "keyword":"阿"
}'
レスポンス
{
    "code": 200,
    "message": "OK",
    "visible": false,
    "paging": {
        "pageNum": 1,
        "pageSize": 10,
        "total": 1
    },
    "data": [
        {
            "id": 26,
            "name": "阿里郎",
            "robotId": 83,
            "parentId": 9
        }
    ]
}