AICC - 知识库API开发指南

https://api-bj.clink.cn/xxxxxx?
&AccessKeyId=b1fcdc6c62be261cf97b00b25be6a2af
&Expires=60
&Timestamp=2018-09-11T12:02:34Z
&Signature=A4GDuUoWiFj59wQ0Bfq%2FJnB%2BSRU%3D
...

 https://api-bj.clink.cn/cc/list_clients?
 AccessKeyId=b1fcdc6c62be261cf97b00b25be6a2af
 &Expires=60
 &Timestamp=2018-10-12T10:18:12Z
 &limit=10
 &offset=0
 &qno=0000
 &cnos[0]=0000
 &cnos[1]=0001

AccessKeyId,Expires,Timestamp,cnos[0],cnos[1],limit,offset,qno

AccessKeyId=b1fcdc6c62be261cf97b00b25be6a2af&Expires=60&Timestamp=2018-10-12T10:18:12Z&&cnos[0]=0000&cnos[1]=0001&limit=10&offset=0&qno=0000

2018-10-12T10:18:12Z => 2018-10-12T10%3A18%3A12Z
cnos[0] => cnos%5B0%5D
cnos[1] => cnos%5B1%5D

GETapi-bj.clink.cn/cc/list_clients?AccessKeyId=b1fcdc6c62be261cf97b00b25be6a2af&Expires=60&Timestamp=2018-10-12T10%3A18%3A12Z&cnos%5B0%5D=0000&cnos%5B1%5D=0001&limit=10&offset=0&qno=0000

Signature = URLEncode(base64(hmac-sha1(AccessKeySecret, urlParam)))

 https://api-bj.clink.cn/cc/list_clients?
 AccessKeyId=b1fcdc6c62be261cf97b00b25be6a2af
 &Expires=60
 &Timestamp=2018-10-12T10%3A18%3A12Z
 &limit=10
 &offset=0
 &qno=0000
 &cnos%5B0%5D
 &cnos%5B1%5D
 &Signature=pDS5pcYkw3SqQV0zk312iCaQJpg%3D

 https://api-bj.clink.cn/cc/online?
 AccessKeyId=b1fcdc6c62be261cf97b00b25be6a2af
 &Expires=60
 &Timestamp=2018-10-12T10:18:12Z

{
    "qno":"0000",
    "cnos":["0000","0001"],
    "bindTel":"138xxxx8888",
    "bindType":1,
    "status":1
}

AccessKeyId,Expires,Timestamp

AccessKeyId=b1fcdc6c62be261cf97b00b25be6a2af&Expires=60&Timestamp=2018-10-12T10:18:12Z

2018-10-12T10:18:12Z => 2018-10-12T10%3A18%3A12Z

POSTapi-bj.clink.cn/cc/online?AccessKeyId=b1fcdc6c62be261cf97b00b25be6a2af&Expires=60&Timestamp=2018-10-12T10%3A18%3A12Z

Signature = URLEncode(base64(hmac-sha1(AccessKeySecret, urlParam)))

 https://api-bj.clink.cn/cc/online?
 AccessKeyId=b1fcdc6c62be261cf97b00b25be6a2af
 &Expires=60
 &Timestamp=2018-10-12T10%3A18%3A12Z
 &Signature=pDS5pcYkw3SqQV0zk312iCaQJpg%3D

https://api-bj.clink.cn/aikb/list_public_repositories
&<公共请求参数>

{
  "requestId": "aad87d90-5e6e-4807-92cd-445f9a77ac3a",
  "result": [
        {
            "id": 1,
            "name": "lucy-知识库",
            "createTime": "2024/03/29 09:47:46",
            "updateTime": "2024/03/29 09:47:46",
            "createUser": "lucy",
            "updateUser": "lucy"
        },
        {
            "id": 2,
            "name": "lhc测试",
            "createTime": "2024/04/07 13:50:30",
            "updateTime": "2024/05/22 11:54:07",
            "createUser": "lucy",
            "updateUser": "lucy"
        }
    ]
}

https://api-bj.clink.cn/aikb/list_private_repositories
&<公共请求参数>

{
  "requestId": "aad87d90-5e6e-4807-92cd-445f9a77ac3a",
  "result": [
        {
            "id": 1,
            "name": "个人知识库",
            "createTime": "2024/03/27 16:00:37",
            "owner": "tom"
        },
        {
            "id": 2,
            "name": "个人知识库",
            "createTime": "2024/03/27 17:50:23",
            "owner": "lili"
        }
    ]
}

https://api-bj.clink.cn/aikb/describe_bot_repository
&<公共请求参数>

{
  "requestId": "aad87d90-5e6e-4807-92cd-445f9a77ac3a",
  "result": {
        "id": 1,
        "name": "机器人专用",
        "createTime": "2024/03/27 16:55:16"
    }
}

https://api-bj.clink.cn/aikb/list_directory_tree
&<公共请求参数>

{
  "requestId": "118f0d01-2c07-4f0e-a6ba-8c7f90f2e387",
  "result": [
        {
            "id": 155184,
            "name": "abc",
            "repositoryId": 102169,
            "type": "FAQ",
            "createTime": "2024/05/31 11:59:58",
            "updateTime": null,
            "createUser": "aaa",
            "updateUser": "aaa",
            "subDirectories": [
                {
                    "id": 155886,
                    "name": "b1",
                    "repositoryId": 102169,
                    "type": "FAQ",
                    "createTime": "2024/06/07 22:23:26",
                    "updateTime": null,
                    "createUser": "aaa",
                    "updateUser": "aaa",
                    "subDirectories": [
                        {
                            "id": 155887,
                            "name": "b10",
                            "repositoryId": 102169,
                            "type": "FAQ",
                            "createTime": "2024/06/07 22:23:31",
                            "updateTime": null,
                            "createUser": "aaa",
                            "updateUser": "aaa",
                            "subDirectories": null
                        }
                    ]
                }
            ]
        },
        {
            "id": 155894,
            "name": "l1",
            "repositoryId": 102169,
            "type": "FILE",
            "createTime": "2024/06/07 22:29:46",
            "updateTime": null,
            "createUser": "zhangxy",
            "updateUser": "zhangxy",
            "subDirectories": null
        }
    ]
}

{
    "repositoryId":103681,
    "name":"openapi测试",
    "type":"FAQ",
    "parentId":103680
}

https://api-bj.clink.cn/aikb/create_directory
&<公共请求参数>

{
    "requestId": "118f0d01-2c07-4f0e-a6ba-8c7f90f2e387",
    "id": 160178
}

{
    "targetRepositoryId":100988,
    "name":"test22222",
    "directoryId":162399,
    "targetDirectoryId":160836
}

https://api-bj.clink.cn/aikb/edit_directory
&<公共请求参数>

{
    "requestId": "118f0d01-2c07-4f0e-a6ba-8c7f90f2e387",
    "id": 162399
}

{
    "directoryId":162399
}

https://api-bj.clink.cn/aikb/delete_directory
&<公共请求参数>

{
    "requestId": "118f0d01-2c07-4f0e-a6ba-8c7f90f2e387",
    "id": 162399
}

https://api-bj.clink.cn/aikb/list_faqs
?<公共请求参数>

{
  "requestId": "aad87d90-5e6e-4807-92cd-445f9a77ac3a",
   "result": [
        {
            "repositoryId": 1,
            "directoryId": 2,
            "id": 3,
            "question": "知识标签",
            "createTime": "2024/06/11 09:06:25",
            "updateTime": "2024/06/12 14:19:04",
            "createUser": "lucy",
            "updateUser": "lucy",
            "onlineDateFrom": null,
            "onlineDateTo": null,
            "answers": [
                {
                    "content": "2222",
                    "type": "text"
                }
            ],
            "similars": [
                {
                    "question": "知识标签"
                }
            ]
        }
    ],
    "pageNumber": 1,
    "pageSize": 10,
    "totalCount": 1
}

https://api-bj.clink.cn/aikb/create_faq
?<公共请求参数>

{
    "repositoryId": 103681,
    "directoryId": 160178,
    "question": "问题",
    "answers": [
        {
            "content": "答案",
            "type": "text"
        }
    ],
    "introductionType": 1,
    "introduction": "简介",
    "similars": [
        "相似问"
    ],
    "relatedIds": [
        1557362
    ],
    "onlineDateFrom": "2024/06/20 10:00:00",
    "onlineDateTo": "2024/06/26 10:00:00"
}

{
    "requestId": "aad87d90-5e6e-4807-92cd-445f9a77ac3a",
    "id": 1557363
}

https://api-bj.clink.cn/aikb/edit_faq
?<公共请求参数>

{
    "id": 1557363,
    "repositoryId": 103681,
    "directoryId": 160178,
    "question": "问题",
    "answers": [
        {
            "content": "答案",
            "type": "text"
        }
    ],
    "introductionType": 1,
    "introduction": "简介",
    "similars": [
        "相似问"
    ],
    "relatedIds": [
        1557362
    ],
    "onlineDateFrom": "2024/06/20 10:00:00",
    "onlineDateTo": "2024/06/26 10:00:00"
}

{
    "requestId": "aad87d90-5e6e-4807-92cd-445f9a77ac3a",
    "id": 1557363
}

https://api-bj.clink.cn/aikb/delete_faq
?<公共请求参数>

{
    "id":1576554
}

{
    "requestId": "aad87d90-5e6e-4807-92cd-445f9a77ac3a",
    "id": 1576554
}

https://api-bj.clink.cn/aikb/describe_faq
?<公共请求参数>

{
    "id":1576554
}

{
    "result": {
        "repositoryId": 103700,
        "directoryId": 160364,
        "id": 1576463,
        "question": "环保标准",
        "introduction": "环保标准",
        "introductionType": 1,
        "createTime": "2024/08/01 10:02:45",
        "updateTime": "2024/08/02 09:44:53",
        "createUser": "admin",
        "updateUser": "admin",
        "onlineDateFrom": "2024/08/01 06:00:00",
        "onlineDateTo": "2024/08/24 16:00:52",
        "answers": [
            {
                "content": "<p>零售、工程、家装各环保标准根据客户订购的产品会有所不同，不直接答复客户是什么级别。感谢您使用金牌衣柜，我司板材环保标准符合国标ENF环保标准，甲醛释放量≤0.025mg/m³；使用的是万华MDI无醛添加胶水；感谢您使用金牌厨柜，我司板材环保标准符合欧洲E1级环保标签，国标E0级，甲醛释放量≤0.05mg/m。<a style=\"color: #4385ff;\" href=\"fileKey=file/attachment/material/8001678/6229989308c54764a9797d314321fa4b.xlsx&amp;fileName=问答库导入模板 (8).xlsx\" target=\"_blank\" rel=\"noopener\" download=\"download\">模板.xlsx</a><img src=\"fileKey=file/attachment/material/8001678/439d28edeb374851b080ba2430889f8b.png&amp;fileName=20240627090506.png\" /></p>",
                "type": "html",
                "id": 161634
            }
        ],
        "similars": [
            {
                "question": "相似问"
            },
            {
                "question": "环保标准"
            }
        ],
        "relatedIds": [
            1557980
        ],
        "attachments": [
            {
                "fileKey": "file/attachment/material/8001678/439d28edeb374851b080ba2430889f8b.png",
                "fileName": "20240627090506.png"
            },
            {
                "fileKey": "file/attachment/material/8001678/6229989308c54764a9797d314321fa4b.xlsx",
                "fileName": "模板.xlsx"
            }
        ]
    },
    "requestId": "aad87d90-5e6e-4807-92cd-445f9a77ac3a"
}

https://api-bj.clink.cn/aikb/list_files
?<公共请求参数>

{
    "result": [
        {
            "id": 18396,
            "enterpriseId": 8001678,
            "name": "大是非得失.txt",
            "repositoryId": 104482,
            "directoryId": 178106,
            "approveStatus": null,
            "introduction": "",
            "likeCount": 0,
            "dislikeCount": 0,
            "searchCount": 0,
            "size": 36,
            "type": "txt",
            "createTime": "2025/03/07 17:03:29",
            "updateTime": "2025/03/14 14:39:39",
            "createUser": "xxx",
            "updateUser": "xxx",
            "fileStatus": "QA_ONLINE_SUCCESS",
            "qaRecallRuleId": null,
            "recallRuleName": null,
            "effectiveStatus": "EFFECTIVE",
            "tags": []
        },
        {
            "id": 18335,
            "enterpriseId": 8001678,
            "name": "水电费发带规则生11的.txt",
            "repositoryId": 104482,
            "directoryId": 178106,
            "approveStatus": null,
            "introduction": "人多刚发的",
            "likeCount": 0,
            "dislikeCount": 0,
            "searchCount": 0,
            "size": 58,
            "type": "txt",
            "createTime": "2025/03/05 12:04:38",
            "updateTime": "2025/03/27 14:26:45",
            "createUser": "xxx",
            "updateUser": "xxx",
            "fileStatus": "QA_ONLINE_SUCCESS",
            "qaRecallRuleId": 3,
            "recallRuleName": "召回规则1",
            "effectiveStatus": "EFFECTIVE",
            "tags": [
                {
                    "id": 100504,
                    "name": "测试1"
                },
                {
                    "id": 100726,
                    "name": "小明1"
                }
            ]
        }
    ],
    "pageNumber": 1,
    "requestId": "aad87d90-5e6e-4807-92cd-445f9a77ac3a",
    "pageSize": 10,
    "totalCount": 2
}

https://api-bj.clink.cn/aikb/describe_file
?<公共请求参数>

{
    "id":1576554
}

{
  "result": {
    "id": 1001,
    "enterpriseId": 10086,
    "name": "产品使用手册.pdf",
    "repositoryId": 10001,
    "directoryId": 2001,
    "approveStatus": "APPROVED",
    "introduction": "产品使用说明文档",
    "likeCount": 10,
    "dislikeCount": 2,
    "searchCount": 56,
    "size": 1024000,
    "type": "pdf",
    "createTime": "2023/05/01 10:30:00",
    "updateTime": "2023/05/10 15:20:00",
    "createUser": "张三",
    "updateUser": "李四",
    "fileStatus": "QA_ONLINE_SUCCESS",
    "qaRecallRuleId": 30,
    "recallRuleName": "默认召回规则",
    "effectiveStatus": "EFFECTIVE",
    "tags": [
      {
        "id": 101,
        "name": "产品文档"
      },
      {
        "id": 102,
        "name": "使用说明"
      }
    ],
    "directoryNames": [
      "一级目录",
      "二级目录"
    ]
  },
  "requestId": "aad87d90-5e6e-4807-92cd-445f9a77ac3a"
}

https://api-bj.clink.cn/aikb/create_file
?<公共请求参数>

{
  "repositoryId": 1024,
  "directoryId": 2048,
  "fileName": "常见问题.md",
  "fileUrl": "https://examplebucket.oss-cn-hangzhou.aliyuncs.com/%E5%B8%B8%E8%A7%81%E9%97%AE%E9%A2%98.md?x-oss-process=image%2Fresize%2Cp_10&x-oss-date=20241115T095058Z&x-oss-expires=3600&x-oss-signature-version=OSS4-HMAC-SHA256&x-oss-credential=LTAI****************%2F20241115%2Fcn-hangzhou%2Foss%2Faliyun_v4_request&x-oss-signature=6e7a*********************************",
  "introduction": "常见问题",
  "tags": [4096, 5120],
  "effectiveFrom": "2025-10-01 00:00:00",
  "effectiveTo": "2025-10-07 23:59:59"
}

{
  "requestId": "01049652-6247-4290-9920-8e7d663093de",
  "result": {
    "fileId": 6144
  }
}

https://api-bj.clink.cn/aikb/delete_files
?<公共请求参数>

{
  "repositoryId": 1024,
  "fileIds": [2048, 4096]
}

{
  "requestId": "344ae3a5-6f50-4e3f-bf73-9d81fb6a7410",
  "result": {
    "fileIds": [2048, 4096]
  }
}

https://api-bj.clink.cn/aikb/list_recycled_items
?<公共请求参数>

{
  "repositoryId": 104027,
  "deleteUser": "zzj",
  "keyword": "指导",
  "type": "FAQ",
  "limit": 10,
  "offset": 0
}

{
    "result": [
        {
            "enterpriseId": 8001678,
            "repositoryId": 104027,
            "faqId": null,
            "fileId": null,
            "directoryId": 179997,
            "type": "FAQ",
            "name": "删除的丰东股份",
            "deleteUser": "xxx",
            "deleteTime": "2023/05/01 10:30:00"
        },
        {
            "enterpriseId": 8001678,
            "repositoryId": 104027,
            "faqId": 1780064,
            "fileId": null,
            "directoryId": 176617,
            "type": "FAQ",
            "name": "如何在睡觉和上班之间选择",
            "deleteUser": "xxx",
            "deleteTime": "2023/05/01 10:30:00"
        }
    ],
    "pageNumber": 1,
    "requestId": "aad87d90-5e6e-4807-92cd-445f9a77ac3a",
    "pageSize": 10,
    "totalCount": 2
}

https://api-bj.clink.cn/chat_conversation_on_open?username=zhangpc
&<公共请求参数>

{
    "userId":12345,
    "content":"呼叫中心",
    "conversationId": "a1f3294570a64dc48d153186379cc9ef"

}

{
    "result": {
        "conversationId": "a1f3294570a64dc48d153186379cc9ef",
        "content": "抱歉，我暂时没有找到合适的答案，您可以尝试换种方式提问",
        "createTime": "2024-05-30T07:41:46.701+00:00",
        "messageId": "1482",
        "files": [
            {
              "id" : 1,
              "name" : "知识名称",
              "fileKey" : "https://xxxxxxxxxxxxxxxx"
            }
        ],
        "faqs": [
            {
              "id" : 1,
              "name" : "知识名称"
            }
        ]
    },
    "requestId": "842ab2a6-3732-4c03-8ab7-c7f83180fb0c"
}

https://api-bj.clink.cn/search_knowledge_on_open?username=zhangpc
&<公共请求参数>

{
    "keyword":"呼叫中心",
    "orderField":"createTime",
    "offset": 0,
    "limit": 10
}

{
    "result": [
        {
            "id": "7284",
            "question": null,
            "name": "<em>呼叫</em><em>中心</em> (2).docx",
            "repositoryId": 102343,
            "directoryId": 154541,
            "updateTime": "2024/05/29 11:19:31",
            "likeCount": null,
            "dislikeCount": null,
            "liked": null,
            "searchCount": 1,
            "actionCount": 1,
            "answers": null,
            "content": null,
            "introduction": "",
            "directoryNames": [
                "一级目录",
                "二级目录"
            ],
            "objectKey": "file/attachment/8000376/d2226d9e6aa64c8d9c66e5e176aff51f.docx",
            "type": "docx",
            "similarList": [],
            "knowledgeType": "FILE",
            "attachments": [
                {
                    "fileKey": "file/attachment/8000376/d2226d9e6aa64c8d9c66e5e176aff51f.docx",
                    "fileName": "<em>呼叫</em><em>中心</em> (2).docx"
                }
            ]
        },
        {
            "id": "7277",
            "question": null,
            "name": "<em>呼叫</em><em>中心</em> (2).doc",
            "repositoryId": 102343,
            "directoryId": 154524,
            "updateTime": "2024/05/28 21:25:07",
            "likeCount": null,
            "dislikeCount": null,
            "liked": null,
            "searchCount": 1,
            "answers": null,
            "content": "<em>呼叫</em><em>中心</em>\n<em>呼叫</em><em>中心</em>是一个专门用于管理和处理大量电话<em>呼叫</em>的集中化客户服务系统。它是一个组织或企业内部的部门或外包服务提供商,致力于通过电话与客户进行沟通、解决问题、提供支持以及进行营销等活动。",
            "introduction": "",
            "directoryNames": [
                "一级目录",
                "二级目录"
            ],
            "objectKey": "file/attachment/8000376/cd7da321d80b4a409119c3606fbe7e28.doc",
            "type": "doc",
            "similarList": [],
            "knowledgeType": "FILE",
            "attachments": [
                {
                    "fileKey": "file/attachment/8000376/cd7da321d80b4a409119c3606fbe7e28.doc",
                    "fileName": "<em>呼叫</em><em>中心</em> (2).doc"
                }
            ]
        },
        {
            "id": "7266",
            "question": null,
            "name": "<em>呼叫</em><em>中心</em> (2).doc",
            "repositoryId": 102343,
            "directoryId": 154523,
            "updateTime": "2024/05/28 21:23:34",
            "likeCount": null,
            "dislikeCount": null,
            "liked": null,
            "searchCount": 1,
            "answers": null,
            "content": "<em>呼叫</em><em>中心</em>\n<em>呼叫</em><em>中心</em>是一个专门用于管理和处理大量电话<em>呼叫</em>的集中化客户服务系统。它是一个组织或企业内部的部门或外包服务提供商,致力于通过电话与客户进行沟通、解决问题、提供支持以及进行营销等活动。",
            "introduction": "",
            "directoryNames": [
                "一级目录",
                "二级目录"
            ],
            "objectKey": "file/attachment/8000376/937d7fa538cc4cb4afedbaddc5b33a55.doc",
            "type": "doc",
            "similarList": [],
            "knowledgeType": "FILE",
            "attachments": [
                {
                    "fileKey": "file/attachment/8000376/937d7fa538cc4cb4afedbaddc5b33a55.doc",
                    "fileName": "<em>呼叫</em><em>中心</em> (2).doc"
                }
            ]
        },
        {
            "id": "7500",
            "question": null,
            "name": "<em>呼叫</em><em>中心</em> (2).doc",
            "repositoryId": 102344,
            "directoryId": 154517,
            "updateTime": "2024/05/30 10:51:43",
            "likeCount": null,
            "dislikeCount": null,
            "liked": null,
            "searchCount": 1,
            "answers": null,
            "content": null,
            "introduction": "",
            "directoryNames": [
                "一级目录",
                "二级目录"
            ],
            "objectKey": "file/attachment/8000376/33658a708c3d4a2a92f57b750cda1e8f.doc",
            "type": "doc",
            "similarList": [],
            "knowledgeType": "FILE",
            "attachments": [
                {
                    "fileKey": "file/attachment/8000376/33658a708c3d4a2a92f57b750cda1e8f.doc",
                    "fileName": "<em>呼叫</em><em>中心</em> (2).doc"
                }
            ]
        }
    ],
    "pageNumber": 1,
    "requestId": null,
    "pageSize": 10,
    "totalCount": 41
}

https://api-bj.clink.cn/aikb/describe_file_media_url?fileId=12345
&inline=true
&<公共请求参数>

{
   "url":"https://aikb-prod.oss-cn-beijing.aliyuncs.com/rtf/20221116/6be0d74e9b8743f79d68470b4a9eaba4.png?Expires=1670395217&OSSAccessKeyId=LTAI5tL2sHNds7TJZrt3AZ6V&Signature=QLwmxPha80%2BBKspemPOyQx1YXxA%3D&response-content-disposition=attachment%3B%20filename%3D6be0d74e9b8743f79d68470b4a9eaba4.png"
}

https://api-bj.clink.cn/aikb/describe_faq_media_url?faqId=12345
&inline=true
&fileKey=rtf/20221116/6be0d74e9b8743f79d68470b4a9eaba4.png
&<公共请求参数>

{
     "url":"https://aikb-prod.oss-cn-beijing.aliyuncs.com/rtf/20221116/6be0d74e9b8743f79d68470b4a9eaba4.png?Expires=1670395217&OSSAccessKeyId=LTAI5tL2sHNds7TJZrt3AZ6V&Signature=QLwmxPha80%2BBKspemPOyQx1YXxA%3D&response-content-disposition=attachment%3B%20filename%3D6be0d74e9b8743f79d68470b4a9eaba4.png"
}

https://api-bj.clink.cn/aikb/signature_for_upload
&<公共请求参数>

{
    "fileName": "素材图片.png"
}

{
    "result": {
        "ossAccessKeyId": "fdhgfhsdfdsfsdafasd",
        "signature": "z+jwY3X+dsagfadsfgfdasasdfas=",
        "host": "https://xxx.oss-cn-beijing.aliyuncs.com",
        "key": "aikb/temp/8004423/c71d3c1f700c4238a6e0358cce3c8296.png",
        "policy": "eyJleHBpAwMF0sWyJzdGFydHMtd2l0Il1dfQ==",
        "rawHtmlContent": <img src="share-bj|xxxxx|素材图片.png|aikb/temp/8004423/c71d3c1f700c4238a6e0358cce3c8296.png>,
        "escapedHtmlContent": "<img src=\"share-bj|xxxxx|素材图片.png|aikb/temp/8004423/c71d3c1f700c4238a6e0358cce3c8296.png\">"
    },
    "requestId": null
}