よくある質問テンプレートリストの取得

リクエストURL

• GET /v1/robots/:id/commonQuestionModels

リクエストパラメータ

パスパラメータ

Parameter	Type	Optional	Description
id	Integer	false	ロボットID.

クエリパラメータ

Parameter	Type	Optional	Description
pageNum	Integer	true	ページ番号、デフォルト値は1
pageSize	Integer	true	1ページあたりのレコード数、デフォルト値は20
searchType	Integer	true	1.nameフィールドで検索 2.modelKeyフィールドで検索
searchWord	String	true	検索キーワード

レスポンス

Path	Type	Description
code	Integer	実行結果コード.
message	String	実行結果の説明.
data	Array	テンプレートリスト情報.
data[].id	Integer	テンプレートID.
data[].robotId	Integer	ロボットID.
data[].name	String	テンプレート名.
data[].description	String	テンプレートの説明.
data[].modelKey	String	テンプレート識別キー modelKey（セッション初期化時に渡すことができます）.

例

$ curl 'https://km.udesk.cn/api/v1/robots/83/commonQuestionModels?email=admin@udesk.cn&timestamp=1540881364&sign=4708c26e84801bf4508a44cfbc110c02dceab794' -i

レスポンス

{
  "code" : 200,
  "message" : "OK",
  "visible" : false,
  "data" : [ {
    "id" : 88,
    "robotId" : 83,
    "name" : "デフォルト推奨1",
    "description" : "デフォルト推奨",
    "modelKey" : "0"
  }, {
    "id" : 69,
    "robotId" : 83,
    "name" : "king",
    "description" : "ガイダンス文から入る.....",
    "modelKey" : "哎哎哎"
  }, {
    "id" : 118,
    "robotId" : 83,
    "name" : "テスト",
    "description" : "dd",
    "modelKey" : "dc"
  } ]
}

リクエスト失敗の原因

Message	Description
"Failed to convert value of type 'java.lang.String' to required type 'int'	整数型パラメータの値が異常です

FAQ問題リストの取得

リクエストURL

• POST /v1/questions/search

リクエストパラメータ

リクエストフィールド

Path	Type	Optional	Description
pageNum	Integer	true	ページ番号、デフォルト値は1.
pageSize	Integer	true	1ページあたりのレコード数、デフォルト値は20.
robotId	Integer	false	ロボットID.
categoryId	Integer	true	カテゴリID.
searchWord	String	true	検索キーワード.
searchType	Integer	true	検索タイプ 1:すべての問題（問題および類似の言い回し） 2:標準問題（類似の言い回しを含まない） 3:回答（デフォルト） 4:すべて
type	Integer	true	問題タイプ 1:問題 3:プロセス 4:雑談 0:すべて（デフォルト）
order	Integer	true	更新時間でソート 1:昇順（デフォルト）2：降順.
isWorking	Integer	true	有効かどうか 1:すべて（デフォルト）2:有効 3:無効.
channelIdList	Array	true	シナリオリスト.
### リクエスト結果
Path	Type	Description
---	---	---
code	Integer	実行結果コード.
message	String	実行結果の説明.
data	Array	問題リスト情報
data[].id	Integer	主問題ID.
data[].robotId	Integer	ロボットID.
data[].categoryId	Integer	カテゴリID.
data[].content	String	問題内容.
data[].type	Integer	問題タイプ.
data[].keyword	String	強制リコールワード.
data[].suggestType	Integer	提案タイプ 1:閉じる 2:インテリジェント推奨 3:手動推奨.
data[].availableTimeType	Integer	有効時間タイプ 0:永久無効 1:永久有効 2:カスタム有効期間.
data[].startTime	String	有効開始時間.
data[].endTime	String	有効終了時間.
data[].createTime	String	作成時間.
data[].updateTime	String	更新時間.
data[].answer	Object	問題の回答.
data[].answer.id	Integer	問題回答ID.
data[].answer.content	String	回答内容.
data[].answer.type	Integer	問題回答タイプ
data[].suggestList	Array	問題回答提案リスト.
data[].suggestList[].id	Integer	提案ID.
data[].suggestList[].content	String	提案内容.

サンプル

$ curl 'https://km.udesk.cn/api/v1/questions/search?email=admin@udesk.cn&timestamp=1529402458&sign=29beefc01662bd040a74880346f3da4491a357cf' -i -X POST -H 'Content-Type: application/json' -d '{
  "pageNum" : 1,
  "pageSize" : 10,
  "robotId" : 102,
  "categoryId" : null,
  "searchWord" : "世界",
  "searchType" : 3,
  "type" : 1,
  "order" : 2,
  "isWorking" : 1,
  "channelIdList" : null
}'

レスポンス

{
    "code": 200,
    "message": "OK",
    "visible": false,
    "exception": null,
    "paging": {
        "pageNum": 1,
        "pageSize": 10,
        "total": 2
    },
    "data": [
        {
            "id": 8657,
            "robotId": 102,
            "categoryId": 343,
            "content": "世界哪里和平了",
            "type": 1,
            "keyword": "和平",
            "suggestType": 3,
            "availableTimeType": null,
            "startTime": null,
            "endTime": null,
            "createTime": "2018-05-30 17:06:13",
            "updateTime": "2018-10-31 13:57:47",
            "answer": {
                "id": 4442,
                "content": "<p>没有</p>\n<p><audio style=\"display: none;\" controls=\"controls\"></audio></p>\n<p><audio style=\"display: none;\" controls=\"controls\"></audio></p>",
                "type": 2
            },
            "suggestList": [
                {
                    "id": 9253,
                    "content": "床前明月光啊"
                },
                {
                    "id": 9257,
                    "content": "怎么说英语"
                }
            ]
        },
        {
            "id": 8656,
            "robotId": 102,
            "categoryId": 343,
            "content": "世界和平吗",
            "type": 1,
            "keyword": "和平",
            "suggestType": 3,
            "availableTimeType": null,
            "startTime": null,
            "endTime": null,
            "createTime": "2018-05-30 17:05:53",
            "updateTime": "2018-10-30 18:23:12",
            "suggestList": [
                {
                    "id": 8657,
                    "content": "世界哪里和平了"
                },
                {
                    "id": 9259,
                    "content": "你想去哪儿"
                }
            ]
        }
    ]
}

FAQ問題リストの取得（1万件を超えるデータの場合、このインターフェースを使用）

リクエストURL

• POST /v1/questions/search/scroll

インターフェース説明

• FAQの数が1万を超える場合は、このインターフェースを使用してください。
• 初回リクエストのメッセージボディにscrollIdがない場合、scrollIdと問題リストが返されます。以降のリクエストではscrollIdを含める必要があり、scrollIdと次のページの問題リストが返されます。

リクエストパラメータ

リクエストフィールド

Path	Type	Optional	説明
pageSize	Integer	true	1ページあたりのレコード数、デフォルト値は20です。
robotId	Integer	false	ボットID。
scrollId	String	false	ESカーソルID。
categoryId	Integer	true	カテゴリID。
searchWord	String	true	検索キーワード。
searchType	Integer	true	検索タイプ 1:すべての問題（問題と類似表現） 2:標準問題（類似表現を含まない） 3:回答（デフォルト） 4:すべて
type	Integer	true	問題タイプ 1:問題 3:プロセス 4:雑談 0:すべて（デフォルト）
order	Integer	true	更新時間によるソート 1:昇順（デフォルト） 2：降順。
isWorking	Integer	true	有効かどうか 1:すべて（デフォルト） 2:有効 3:無効。
channelIdList	Array	true	シナリオリスト。

レスポンス結果

Path	Type	説明
code	Integer	実行結果コード。
message	String	実行結果の説明。
data	Object	問題リスト情報
data.scrollId	String	ESカーソルID。
data.questionList	Array	問題リスト情報
data.questionList[].id	Integer	メイン問題ID。
data.questionList[].robotId	Integer	ボットID。
data.questionList[].categoryId	Integer	カテゴリID。
data.questionList[].content	String	問題内容。
data.questionList[].type	Integer	問題タイプ。
data.questionList[].keyword	String	強制リコールワード。
data.questionList[].suggestType	Integer	提案タイプ 1:閉じる 2:インテリジェント推奨 3:手動推奨。
data.questionList[].availableTimeType	Integer	有効時間 0:永久無効を表す 1:永久有効を表す 2:カスタム有効期間を表す。
data.questionList[].startTime	String	有効開始時間。
data.questionList[].endTime	String	有効終了時間。
data.questionList[].createTime	String	作成時間。
data.questionList[].updateTime	String	更新時間。
data.questionList[].answer	Object	問題の回答。
data.questionList[].answer.id	Integer	問題回答ID。
data.questionList[].answer.content	String	回答内容。
data.questionList[].answer.type	Integer	問題回答タイプ
data.questionList[].suggestList	Array	問題回答提案リスト。
data.questionList[].suggestList[].id	Integer	提案ID。
data.questionList[].suggestList[].content	String	提案内容。
### サンプル

$ curl 'https://km.udesk.cn/api/v1/questions/search?email=admin@udesk.cn&timestamp=1529402458&sign=29beefc01662bd040a74880346f3da4491a357cf' -i -X POST -H 'Content-Type: application/json' -d '{
  "pageNum" : 1,
  "pageSize" : 10,
  "robotId" : 102,
  "categoryId" : null,
  "searchWord" : "世界",
  "searchType" : 3,
  "type" : 1,
  "order" : 2,
  "isWorking" : 1,
  "channelIdList" : null,
  "scrollId": "DnF1ZXJ5VGhlbkZldGNoBQAAAAAAAHayFmRMNnQ5eGhnVGp1cTQ2XzRBU0pVcncAAAAAAAB2tBZkTDZ0OXhoZ1RqdXE0Nl80QVNKVXJ3AAAAAAAAdrMWZEw2dDl4aGdUanVxNDZfNEFTSlVydwAAAAAAAHa1FmRMNnQ5eGhnVGp1cTQ2XzRBU0pVcncAAAAAAAB2thZkTDZ0OXhoZ1RqdXE0Nl80QVNKVXJ3"
}'

レスポンス

{
  "code": 200,
  "message": "OK",
  "visible": false,
  "exception": null,
  "paging": {
    "pageNum": 1,
    "pageSize": 10,
    "total": 2
  },
  "data": {
    "scrollId": "DnF1ZXJ5VGhlbkZldGNoBQAAAAAAAHayFmRMNnQ5eGhnVGp1cTQ2XzRBU0pVcncAAAAAAAB2tBZkTDZ0OXhoZ1RqdXE0Nl80QVNKVXJ3AAAAAAAAdrMWZEw2dDl4aGdUanVxNDZfNEFTSlVydwAAAAAAAHa1FmRMNnQ5eGhnVGp1cTQ2XzRBU0pVcncAAAAAAAB2thZkTDZ0OXhoZ1RqdXE0Nl80QVNKVXJ3",
    "questionList": [
      {
        "id": 8657,
        "robotId": 102,
        "categoryId": 343,
        "content": "世界哪里和平了",
        "type": 1,
        "keyword": "和平",
        "suggestType": 3,
        "availableTimeType": null,
        "startTime": null,
        "endTime": null,
        "createTime": "2018-05-30 17:06:13",
        "updateTime": "2018-10-31 13:57:47",
        "answer": {
          "id": 4442,
          "content": "<p>没有</p>\n<p><audio style=\"display: none;\" controls=\"controls\"></audio></p>\n<p><audio style=\"display: none;\" controls=\"controls\"></audio></p>",
          "type": 2
        },
        "suggestList": [
          {
            "id": 9253,
            "content": "床前明月光啊"
          },
          {
            "id": 9257,
            "content": "怎么说英语"
          }
        ]
      },
      {
        "id": 8656,
        "robotId": 102,
        "categoryId": 343,
        "content": "世界和平吗",
        "type": 1,
        "keyword": "和平",
        "suggestType": 3,
        "availableTimeType": null,
        "startTime": null,
        "endTime": null,
        "createTime": "2018-05-30 17:05:53",
        "updateTime": "2018-10-30 18:23:12",
        "suggestList": [
          {
            "id": 8657,
            "content": "世界哪里和平了"
          },
          {
            "id": 9259,
            "content": "你想去哪儿"
          }
        ]
      }
    ]
  }
}

FAQ問題詳細の取得

リクエストURL

• GET /v1/questions/:id

リクエストパラメータ

パスパラメータ

Parameter	Type	Optional	Description
id	int	false	問題ID.

レスポンス

Path	Type	Description
code	Integer	実行結果コード.
message	String	実行結果の説明.
data	Object	問題情報
data.id	Integer	主問題ID.
data.robotId	Integer	ロボットID.
data.categoryId	Integer	カテゴリID.
data.content	String	問題内容.
data.type	Integer	タイプ 1:通常問題 2:類似問題 3:フローエントリー問題 4:雑談
data.keyword	String	強制リコールワード.
data.suggestType	Integer	提案タイプ 1,閉じる 2,インテリジェント推薦 3,手動推薦.
data.availableTimeType	Integer	有効時間タイプ 0 は永久無効、 1 は永久有効、 2 はカスタム有効期間.
data.startTime	String	有効開始時間.
data.endTime	String	有効終了時間.
data.createTime	String	作成時間.
data.updateTime	String	更新時間.
data.needLearnCount	Integer	学習が必要な数.
data.answer	Object	問題の回答.
data.answer.id	Integer	回答ID.
data.answer.content	String	回答内容.
data.answer.type	Integer	回答タイプ 1:プレーンテキスト 2:リッチテキスト 3:音声 4.リンク 5.画像
data.answer.attachmentList[]	Array	添付ファイル
data.answer.attachmentList[].name	String	添付ファイル名
data.answer.attachmentList[].address	String	添付ファイルアドレス
data.answer.attachmentList[].size	Long	添付ファイルサイズ（バイト）
data.suggestList	Array	問題推薦リスト.
data.suggestList[].id	Integer	推薦問題ID.
data.suggestList[].content	String	推薦問題内容.
data.suggestList[].type	Integer	推薦問題タイプ 1:通常問題 2:類似問題 3:フローエントリー問題 4:雑談
data.suggestList[].orders	Integer	推薦問題の順序.
data.channelList	Array	シナリオリスト.
data.channelList[].id	Integer	シナリオID.
data.channelList[].robotId	Integer	ロボットID.
data.channelList[].name	String	シナリオ名.
data.channelList[].description	String	シナリオの説明.
data.channelList[].type	Integer	タイプ 1:デフォルト 2：非デフォルト.

例

$ curl 'https://km.udesk.cn/api/v1/questions/1232?email=admin@udesk.cn&timestamp=1529402455&sign=d4be213127c62bb5b53dea5f5e52eaad06b2362f' -i -H 'Accept: application/json'

レスポンス

{
    "code": 200,
    "message": "OK",
    "visible": false,
    "exception": null,
    "paging": null,
    "data": {
        "id": 1232,
        "robotId": 83,
        "categoryId": 295,
        "content": "返済で異常が発生した場合、どうすればよいですか？",
        "type": 1,
        "keyword": "",
        "suggestType": 1,
        "availableTimeType": 1,
        "startTime": null,
        "endTime": null,
        "createTime": "2018-02-28 18:32:23",
        "updateTime": "2018-06-13 15:20:04",
        "needLearnCount": null,
        "answer": {
            "id": 727,
            "content": "返済中または返済後に異常が発生した場合は、操作画面のスクリーンショットを保存し、すぐにカスタマーサポートに連絡してサポートを受けてください！",
            "type": 2,
            "attachmentList": [
                {
                    "name": "1.xlsx",
                    "address": "https://staging-udesk.oss-cn-beijing.aliyuncs.com/Data/6/1.xlsx",
                    "size": 18183
                },
                {
                    "name": "2.xlsx",
                    "address": "https://staging-udesk.oss-cn-beijing.aliyuncs.com/Data/6/2.xlsx",
                    "size": 18184
                },
            ]
        },
        "suggestList": null,
        "channelList": [
            {
                "id": 82,
                "robotId": 83,
                "name": "システムデフォルトシナリオ",
                "description": "システムデフォルトシナリオ",
                "type": 1
            }
        ]
    }
}

リクエスト失敗の原因

{
  "code": 400,
  "message": "{具体的な例外情報}",
  "visible": false
}

message	description
"The problem does not exist or has been deleted!"	問題が存在しないか、削除されています
## FAQ問題の新規作成
### リクエストURL
+ POST /v1/questions

インターフェース説明

• このインターフェースはFAQ問題およびFAQ雑談ライブラリ問題の作成をサポートします。
  フローの作成は現在サポートされていません。

リクエストパラメータ

リクエストフィールド

Path	Type	Optional	説明
robotId	Integer	false	ボットID.
categoryId	Integer	false	カテゴリID.
labelIds	Array	false	ナレッジタグID.
content	String	false	問題内容. 200文字以内
type	Integer	false	問題タイプ 1.通常問題 4.雑談
answer	Object	false	回答
answer.content	String	true	回答内容.
answer.type	Integer	true	テキストタイプ 2.リッチテキスト 3.音声 4.リンク 5.画像（タイプ3、4、5はすべてURLアドレス）
answer.attachmentList[]	Array	true	添付ファイル
answer.attachmentList[].name	String	true	添付ファイル名
answer.attachmentList[].address	String	true	添付ファイルアドレス
answer.attachmentList[].size	Long	true	添付ファイルサイズ（バイト）
channelList	Array	false	シナリオリスト. システム設定->ボット管理->シナリオ管理で取得可能
channelList[].id	Integer	false	シナリオID.
availableTimeType	Integer	true	有効時間 0: 永久無効、 1: 永久有効、 2: カスタム有効期間.
startTime	String	true	問題有効開始時間. availableTimeType=3の場合、必須
endTime	String	true	問題有効終了時間. availableTimeType=3の場合、必須
keyword	String	true	キーワード: カンマ区切り.
suggestType	Integer	false	推奨タイプ 1:オフ 2:インテリジェント推奨 3:手動推奨.
suggestsList	Array	true	推奨問題リスト
suggestsList[].id	Integer	true	推奨問題ID.
isSwitchStaff	Integer	true	オペレーターへの推奨転送を有効にするか. 0:オフ 1:オン

レスポンス結果

Parameter	Type	説明
code	Integer	実行結果コード
message	String	実行結果説明
data	Object	問題情報
data.id	Integer	メイン問題ID.
data.robotId	Integer	ボットID.
data.categoryId	Integer	カテゴリID.
data.content	String	問題内容.
data.type	Integer	問題タイプ 1.通常問題 4.雑談.
data.keyword	String	問題の強制リコールワード.
data.availableTimeType	Integer	問題有効時間 0: 永久無効、 1: 永久有効、 2: カスタム有効期間.
data.startTime	String	問題有効開始時間.
data.endTime	String	問題有効終了時間.
data.createTime	String	問題作成時間.
data.updateTime	String	問題更新時間.
data.answer	Object	問題回答.
data.answer.id	Integer	問題回答ID.
data.answer.content	String	問題回答内容.
data.answer.type	Integer	問題回答タイプ 1:プレーンテキスト 2:リッチテキスト 3:音声 4:リンク 5:画像
data.answer.attachmentList[]	Array	添付ファイル
data.answer.attachmentList[].name	String	添付ファイル名
data.answer.attachmentList[].address	String	添付ファイルアドレス
data.answer.attachmentList[].size	Long	添付ファイルサイズ（バイト）
data.suggestType	Integer	問題推奨タイプ 1:オフ 2:インテリジェント推奨 3:手動推奨.
data.suggestList	Array	問題推奨リスト
data.suggestList[].id	Integer	推奨問題ID
data.suggestList[].content	String	推奨問題内容.
data.suggestList[].type	Integer	推奨問題タイプ 1:通常問題 3:フローエントリー問題
data.channelList	Array	問題シナリオリスト.
data.channelList[].id	Integer	問題シナリオID.
data.channelList[].robotId	Integer	ボットID.
data.channelList[].name	String	シナリオ名.
data.channelList[].description	String	シナリオ説明.
data.channelList[].type	Integer	シナリオタイプ 1:デフォルト 2：非デフォルト.
### サンプル

$ curl 'https://km.udesk.cn/api/v1/questions?email=admin@udesk.cn&timestamp=1529402459&sign=814452f1c81d0f43303a30c4a6fd1c894d152ef3' -i -X POST -H 'Content-Type: application/json' -d '{
    "robotId": "7203",
    "content": "你好5",
    "categoryId": 102716,
    "type": 1,
    "answer": {
        "type": 2,
        "content": "<p>哈哈</p>"
    },
    "channelList": [
        {
            "id": 9198
        }
    ],
    "availableTimeType": 1,
    "suggestType": 1,
    "isSwitchStaff": 0
  }'

レスポンス

{
    "code": 200,
    "message": "OK",
    "visible": false,
    "exception": null,
    "paging": null,
    "data": {
        "id": 9458,
        "robotId": 102,
        "categoryId": 343,
        "content": "身份证怎么办理",
        "type": 1,
        "keyword": "身份证,身份证明",
        "suggestType": 1,
        "availableTimeType": 1,
        "startTime": null,
        "endTime": null,
        "createTime": "2018-10-31 11:12:39",
        "updateTime": "2018-10-31 11:12:39",
        "answer": {
            "id": 5142,
            "content": "百度一下，你就知道",
            "type": 1
        },
        "suggestList": null,
        "channelList": [
            {
                "id": 105,
                "robotId": 102,
                "name": "系统默认场景",
                "description": "系统默认场景",
                "type": 1
            }
        ]
    }
}

リクエスト失敗の原因

{
  "code": 400,
  "message": "{具体的な例外情報}",
  "visible": false
}

message	description
お客様のナレッジベースは上限に達しました。ナレッジベースの容量をアップグレードするには、Udeskにお問い合わせください	ナレッジベースのFAQ数が上限に達しました
"The robot does not exist or has been deleted!"	該当のロボットは存在しないか、削除されています
"Category doesn't belong to the Robot!"	カテゴリはこのロボットに属していません
"シーンは存在しないか、すでに削除されています!シーンID:{id}"	シーンは存在しないか、すでに削除されています!シーンID:{id}
"シーンはこのロボットに属していません!シーンID:{id}"	シーンはこのロボットに属していません!シーンID:{id}
有効開始時間の後、時間範囲は空にできません	有効時間を空にすることはできません
既存の質問と重複しています！質問ID:{id}	既存の質問と重複しています
"【answer.content】回答を空にすることはできません"	回答内容を空にすることはできません
"【channelList】org.hibernate.validator.constraints.NotEmpty.message"	少なくとも1つのシーンを選択してください
"Similar questions do not meet the requirements (similar questions can not be null characters and the length can not be greater than 200 characters!)"	類似質問が要件を満たしていません（類似質問は空文字にできず、長さは200文字を超えることはできません！）
"【...】javax.validation.constraints.NotNull.message"	【具体的なフィールド】を空にすることはできません
## FAQ問題の削除
### リクエストURL
+ DELETE /v1/questions/:id

リクエストパラメータ

Path parameters

Parameter	Type	Optional	Description
id	Integer	false	問題ID.

レスポンス

• なし。削除成功時、HTTPレスポンスコードは204です。

例

$ curl 'https://km.udesk.cn/api/v1/questions/9362?email=admin@udesk.cn&timestamp=1529402460&sign=87e3763301d72ad81aacc823883c3c96a5fcbcfc' -i -X DELETE -H 'Content-Type: application/json'

FAQ問題の編集

リクエストURL

• PUT /v1/questions/:id

リクエストパラメータ

Path parameters

Parameter	Type	Optional	Description
id	Integer	false	問題ID.

Request fields

Path	Type	Optional	Description
id	Integer	true	問題ID.
categoryId	Integer	false	カテゴリID.
labelIds	Array	false	ナレッジタグID.
content	String	false	問題の内容。200文字以内。
type	Integer	true	問題のタイプ。1: 通常問題 4. 雑談
answerUpdateRequest	Object	false	問題の回答。
answerUpdateRequest.id	Integer	false	回答ID.
answerUpdateRequest.content	String	false	回答の内容.
answerUpdateRequest.type	Integer	true	回答のタイプ 2. リッチテキスト 3. 音声 4. リンク 5. 画像（タイプ3、4、5はすべてURLアドレス）
answerUpdateRequest.attachmentList[]	Array	添付ファイル
answerUpdateRequest.attachmentList[].name	String	添付ファイル名
answerUpdateRequest.attachmentList[].address	String	添付ファイルアドレス
answerUpdateRequest.attachmentList[].size	Long	添付ファイルサイズ（バイト）
simpleChannelList	Array	false	シナリオリスト。システム設定->ボット管理->シナリオ管理で取得可能です。
simpleChannelList[].id	Integer	false	シナリオID.
availableTimeType	Integer	true	有効期間 0: 永久無効、 1: 永久有効、 2: カスタム有効期間.
startTime	String	true	問題の有効開始時間。availableTimeType=3の場合、必須です。
endTime	String	true	問題の有効終了時間。availableTimeType=3の場合、必須です。
keyword	String	true	問題のキーワード.
suggestType	Integer	true	問題の推奨タイプ 1：オフ 2：インテリジェント推奨 3：手動推奨.
suggestsList	Array	true	推奨問題リスト
suggestsList[].id	Integer	true	推奨問題ID.
isSwitchStaff	Integer	true	オペレーターへの転送を推奨.
### リクエスト結果
Path	Type	Description
---	---	---
code	Integer	実行結果コード
message	String	実行結果の説明
data	null	true

例

$ curl 'https://km.udesk.cn/api/v1/questions/9458?email=admin@udesk.cn&timestamp=1529402462&sign=62a0c09fad0446c6bc24fa1ec876ee2eb789297a' -i -X PUT -H 'Content-Type: application/json' -d '{
  "id":9458,
  "categoryId" : 343,
  "labelIds" : [1,2],
  "content" : "身份证怎么办理啊",
  "type": 1,
  "answerUpdateRequest" : {
    "id": 5142,
    "content" : "google一下，你就知道",
    "type" : 1
  },
  "simpleChannelList" : [ {
    "id" : 105
  } ],
  "availableTimeType" : 1,
  "startTime" : null,
  "endTime" : null,
  "suggestType" : 1,
  "suggestsList" : null,
  "isSwitchStaff" : null
}'

レスポンス

{
  "code" : 200,
  "message" : "OK",
  "visible" : false,
  "data" : null
}

リクエスト失敗の原因

{
  "code": 400,
  "message": "{具体的な例外情報}",
  "visible": false
}

message	description
お客様のナレッジベースは上限に達しました。ナレッジベースの容量をアップグレードするには、Udeskにお問い合わせください	ナレッジベースのFAQ数が上限に達しました
"The robot does not exist or has been deleted!"	該当のボットは存在しないか、削除されています
"Category doesn't belong to the Robot!"	カテゴリはこのボットに属していません
"シーンは存在しないか、すでに削除されています!シーンID:{id}"	シーンは存在しないか、すでに削除されています!シーンID:{id}
"シーンはこのボットに属していません!シーンID:{id}"	シーンはこのボットに属していません!シーンID:{id}
有効開始時間の後、時間範囲は空にできません	有効時間を空にすることはできません
既存の問題と重複しています！問題ID:{id}	既存の問題と重複しています
"【answer.content】回答は空にできません"	回答内容は空にできません
"【channelList】org.hibernate.validator.constraints.NotEmpty.message"	少なくとも1つのシーンを選択してください
"類似質問は要件を満たしていません（類似質問は空文字にできず、長さは200文字を超えることはできません！）"	類似質問は要件を満たしていません（類似質問は空文字にできず、長さは200文字を超えることはできません！）
"【...】javax.validation.constraints.NotNull.message"	【具体的なフィールド】は空にできません
## 類似質問のページネーション取得インターフェースリスト
### リクエストアドレス
+ GET /v1/faq/similar/{questionId}

リクエストパラメータ

Path parameters

Parameter	Type	Optional	Description
questionId	Integer	false	主質問ID.
pageNum	Integer	true	ページ番号（デフォルト1）
pageSize	Integer	true	1ページあたりの件数（デフォルト10）

Request fields

Path	Type	Optional	Description

リクエスト結果

Path	Type	Description
code	Integer	実行結果コード
message	String	実行結果説明
data	Array	返却データ
data[].id	Integer	類似質問Id
data[].content	String	類似質問内容
paging	Object	ページネーション情報
paging.pageNum	Integer	ページ番号
paging.pageSize	Integer	1ページあたりの件数
paging.total	Long	ページネーション情報

例

$ curl 'https://km.udesk.cn/api/v1/faq/similar/9458?email=admin@udesk.cn&timestamp=1529402462&sign=62a0c09fad0446c6bc24fa1ec876ee2eb789297a' -i -X GET -H 'Content-Type: application/json'

返却

{
  "code" : 200,
  "message" : "OK",
  "visible" : false,
  "data" : [{
       "id": 78234,
       "content": "類似質問例1"
   },{
        "id": 78235,
       "content": "類似質問例2"
   }],
   "paging": {
        "pageNum": 1,
        "pageSize": 10,
        "total": 773
   }
}

類似質問新規追加インターフェースリスト

リクエストアドレス

• POST /v1/faq/similar/{questionId}

リクエストパラメータ

Path parameters

Parameter	Type	Optional	Description
questionId	Integer	false	主質問ID.

Request fields

Path	Type	Optional	Description
content	String	false	質問内容.

リクエスト結果

Path	Type	Description
code	Integer	実行結果コード
message	String	実行結果説明
data	Object	返却データ
data.id	Integer	類似質問Id
data.content	String	類似質問内容
### サンプル

$ curl 'https://km.udesk.cn/api/v1/faq/similar/9458?email=admin@udesk.cn&timestamp=1529402462&sign=62a0c09fad0446c6bc24fa1ec876ee2eb789297a' -i -X POST -H 'Content-Type: application/json'
-d'{
  "content" : "類似質問サンプル1"
}'

レスポンス

{
  "code" : 200,
  "message" : "OK",
  "visible" : false,
  "data" : {
       "id": 78234,
       "content": "類似質問サンプル1"
   }
}

類似質問編集インターフェース一覧

リクエストURL

• PUT /v1/faq/similar/{questionId}

リクエストパラメータ

Path parameters

パラメータ	タイプ	オプション	説明
questionId	Integer	false	主質問ID.

Request fields

パス	タイプ	オプション	説明
id	Integer	false	類似質問ID.
content	String	false	類似質問内容.
### リクエスト結果
パス	タイプ	説明
---	---	---
code	Integer	実行結果コード
message	String	実行結果説明
data	Object	返却データ
data.id	Integer	類似質問ID
data.content	String	類似質問内容

サンプル

$ curl 'https://km.udesk.cn/api/v1/faq/similar/9458?email=admin@udesk.cn&timestamp=1529402462&sign=62a0c09fad0446c6bc24fa1ec876ee2eb789297a' -i -X PUT -H 'Content-Type: application/json'
-d'{
  "id": "78234",
  "content" : "類似質問サンプル1"
}'

レスポンス

{
  "code" : 200,
  "message" : "OK",
  "visible" : false,
  "data" : {
       "id": 78234,
       "content": "類似質問サンプル1"
   }
}

類似質問削除インターフェース一覧

リクエストURL

• DELETE /v1/faq/similar/{questionId}

リクエストパラメータ

Path parameters

パラメータ	タイプ	オプション	説明
questionId	Integer	false	主質問ID.

Request parameters

パラメータ	タイプ	オプション	説明
similar	Integer	false	類似質問ID.
#### リクエストフィールド
Path	Type	Optional	Description
---	---	---	---

リクエスト結果

Path	Type	Description
code	Integer	実行結果コード
message	String	実行結果の説明
data	null	なし

例

$ curl 'https://km.udesk.cn/api/v1/faq/similar/9458?similarId=78234&email=admin@udesk.cn&timestamp=1529402462&sign=62a0c09fad0446c6bc24fa1ec876ee2eb789297a' -i -X DELETE -H 'Content-Type: application/json'

レスポンス

{
  "code" : 200,
  "message" : "OK",
  "visible" : false
}