开发者文档
智齿科技
2024-09-09
目录

大模型机器人API

# 大模型机器人

# 接口声明

在调用接口时必须在 https 请求的 header 中携带 "token" 参数

Token 是智齿客服接口开放平台全局唯一的接口调用凭据。 开发者在调用各业务接口时都需使用 Token，开发者需要进行妥善保存。 Token 的存储至少要保留 32 个字符空间。Token 的有效期目前为 24 个小时，需定时刷新，或根据接口返回的 Token 失效提示，进行重新获取。请求 Token 接口，无论 Token 是否存在，都会返回新的 Token，并重置 Token 的过期时间（目前 24 小时）。

Token 使用方式说明：
1、开发者需要统一获取和管理 Token，在调用智齿客服各个业务开放接口时都应该使用同一个的 Token，不应该每个业务都刷新获取新的 Token，否则容易导致 Token 失效，影响接口的正常调用；
2、目前 Token 的有效期通过返回的 expire_in 来传达，目前是 86,400 秒之内的值。开发者需要根据这个有效时间提前去刷新新 Token。
3、开发者需要根据接口返回的 Token 失效提示，进行重新获取 Token。

# 大模型机器人问答接口调用

# ● 获取访问 Token 编码

接口说明：

获取 API 开放接口 Token，此 Token 仅适用于智齿开放平台 5.0 版本全部 API 接口 。API 接口中的参数 appid 、 app_key 请联系智齿售后人员获取。

请求方式：

GET

请求地址：

 https://www.sobot.com/api/get_token
1

请求参数：

参数 类型 必填 描述
appid String 是 接口凭证 Id，第三方用户接口调用唯一凭证 id
create_time String 是 时间戳，时间戳、秒，例如 2019-09-25 15:49:33 的时间戳1569397773
sign String 是 签名，md5(appid + create_time + app_key) sign 签名、app_key 为密钥

返回参数：

参数 类型 必填 描述
ret_code String 是 返回编码
ret_msg String 是 返回信息
item Object 否 返回对象

item 对象：

参数 类型 必填 描述
token String 是 token 编码
expires_in String 是 凭证有效时间

时间戳转换参考工具：

 http://tool.chinaz.com/Tools/unixtime.aspx
1

sign 签名生成示例：

例如，appid = "1"; create_time="1569397773"; app_key="2"

sign = Md5("115693977732") 为 258eec3118705112b2c53dc8043d4d34。

请求示例：

curl  https://www.sobot.com/api/get_token?appid=1&create_time=1569397773&sign=258eec3118705112b2c53dc8043d4d34
1

返回示例：

{
    "item": {
        "token": "4ac37cb2e9c740dba4b75a34d5358802",
        "expires_in": "86400"
    },
    "ret_code": "000000",
    "ret_msg": "操作成功"
}
1
2
3
4
5
6
7
8
# ● 问答-流式

接口说明：

接口类型：主动调用接口

接口作用：可通过调用该接口获取答案，并建立会话。

请求方式：

POST

请求地址：

 http://api-c.soboten.com/text/ai-agent-open/ask/answer
1

请求参数

名称 位置 类型 必选 说明
body body OpenRobotAnswerReqVo 是

OpenRobotAnswerReqVo 对象：

名称 类型 必选 说明
question string 是 问题
show_question string 是 展示问题
input_type_enum string 是 输入类型
biz_id string 是 业务id
biz_type string 是 业务线类型
biz_type_id string 是 产品id
robotid string 是 机器人id
msg_type string 是 TEXT: 文本, IMG: 图片
uid string 否 访客id
user_name string 否 访客姓名
transfer boolean 否 是否开启转人工
ai_agent_cid string 否 AiAgent会话id
call_back_url string 否 回调地址
source_enum string 是 渠道来源
partnerid string 否 对接id
params Map<String,Object> 否 自定义参数
multi_params Map<String,Object> 否 任务流程自定义参数
timing boolean 否 是否开启外部定时
input_variable_infos OpenAnswerVariableInfo 否 外部传入变量
process_info OpenProcessInfo 否 枚举变量点击信息
interface_info OpenInterfaceInfo 否 节点信息

请求示例：

{
  "question": "人工客服",
  "show_question": "人工客服",
  "input_type_enum": "INPUT",
  "biz_id": "a97e877ad6b9403bbf945401ea331111",
  "biz_type": "TEXT",
  "msg_type": "TEXT", 
  "biz_type_id": "1000016",
  "robotid": "1",
  "uid": "c56844605e72633776a6de28d0f598f3",
  "user_name": "用户名称",
  "transfer": true,
  "ai_agent_cid": "17ad7f4ab65b4aedadb3b72caf6a86cd",
  "call_back_url": "http://www.sobot.com/aiAgent/callback",
  "source_enum": "PC",
  "partnerid": "123456",
  "params": {
    "key": {}
  },
  "multi_params": {
    "key": {}
  },
  "timing": false,
  "input_variable_infos": [
    {
      "variable_id": "1888794111663644672",
      "variable_name": "变量名",
      "variable_value": "变量值",
      "variable_type": "CHARACTER"
    }
  ],
  "process_info": {
    "process_id": "5a227ca7b4fc48e98d4e02b113c81c123",
    "node_id": "1905555364410802345",
    "variable_id": "1888794111663644672",
    "variable_value": "变量值"
  }, 
  "interface_info": {
     "cardStyle": "0",
     "cardType": "1",
     "cardForm": "1",
     "cardGuide": "您好，为您查询到以下结果，请点击查看相关手机信息。",
     "customCards": [
        {
           "customCardName": {
              "variableId": "4a39e1872f1e427794848f30945dd50a",
              "paramValue": "华为mate70"
           },
           "customCardHeader": [
              {
                 "序号:": {
                    "variableId": null,
                    "paramValue": "7"
                 }
              }
           ],
           "customCardNum": null,
           "customField": [
              {
                 "自定义信息:": {
                    "variableId": "4a39e1872f1e427794848f30945dd50a",
                    "paramValue": "华为mate70"
                 }
              }
           ],
           "customCardThumbnail": {
              "variableId": null,
              "paramValue": "https://img11.360buyimg.com/n5/s720x720_jfs/t1/332638/32/12246/51387/68c3817dFf6c2947b/3b00cd8ecfe6840b.jpg"
           },
           "customCardAmount": {
              "variableId": null,
              "paramValue": "5599元"
           },
           "customCardAmountSymbol": null,
           "customCardDesc": {
              "variableId": null,
              "paramValue": "手机"
           },
           "customCardType": null,
           "customCardLink": null,
           "paramInfos": [
              {
                 "variableId": "4a39e1872f1e427794848f30945dd50a",
                 "paramValue": "华为mate70"
              }
           ],
           "customMenus": [
              {
                 "menuType": 0,
                 "menuName": "自定义按钮",
                 "menuLink": null
              }
           ]
        }
     ]
  }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97

返回示例：

成功

返回结果

参数 类型 必填 描述
ret_code String 是 返回编码
ret_msg String 是 返回信息
data Object 否 返回对象

返回data数据结构

类型 必选 约束 说明
RobotAnswerRespVo 是 none none

RobotAnswerRespVo

名称 类型 必选 说明
robot_answer_type string 是 回答类型
robot_answer_message_type string 是 消息类型
answer string 否 答案
transfer_result string 否 转人工结果
roundid string 是 消息轮次id
msgid string 是 消息id
ai_agent_cid string 是 AiAgent会话id
biz_id string 是 业务id
robot_name string 是 机器人名称
robot_logo string 是 机器人logo
robotid string 是 机器人id
robot_status string 是 机器人状态
delay integer 是 节点延时
output_variable_infos AnswerVariableInfo 否 返回收集变量
process_id string 否 流程id
node_id string 否 节点id
variable_id string 否 变量id
variable_value_enums array 否 枚举列表
interface_info OpenInterfaceInfo 否 节点数据
{
  "data": [
    {
      "robot_answer_type": "QA_DIRECT",
      "robot_answer_message_type": "MESSAGE",
      "answer": "人工客服",
      "transfer_result": "NO_ACTION",
      "roundid": "12ef2d1957434f2eb4b45c629d2db2dc",
      "msgid": "12789cf50b784e4480a02289ddc69fb9",
      "ai_agent_cid": "12dec883b46d48a5808ea143379b7014",
      "biz_id": "29967d81d67f4a708e8bd7d8f6356447",
      "robot_name": "大模型机器人",
      "robot_logo": "",
      "robotid": "1",
      "robot_status": "DELETE",
      "delay": 0,
      "output_variable_infos": [
        {
          "variable_id": "1888794111663644672",
          "variable_name": "变量名",
          "variable_value": "变量值",
          "variable_type": "CHARACTER"
        }
      ],
      "process_id": "5a227ca7b4fc48e98d4e02b113c81c123",
      "node_id": "1905555364410802345",
      "variable_id": "1888794111663644672",
      "variable_value_enums": [
        ""
      ],
      "interface_info": {
          "cardStyle": "1",
          "cardType": "1",
          "cardForm": "1",
          "cardGuide": "您好，为您查询到以下结果，请点击查看相关手机信息。",
          "customCards": [
             {
                "customCardName": {
                   "variableId": "4a39e1872f1e427794848f30945dd50a",
                   "paramValue": "华为mate70"
                },
                "customCardHeader": [
                   {
                      "序号:": {
                         "variableId": null,
                         "paramValue": "7"
                      }
                   }
                ],
                "customCardNum": null,
                "customField": [
                   {
                      "自定义信息:": {
                         "variableId": "4a39e1872f1e427794848f30945dd50a",
                         "paramValue": "华为mate70"
                      }
                   }
                ],
                "customCardThumbnail": {
                   "variableId": null,
                   "paramValue": "https://img11.360buyimg.com/n5/s720x720_jfs/t1/332638/32/12246/51387/68c3817dFf6c2947b/3b00cd8ecfe6840b.jpg"
                },
                "customCardAmount": {
                   "variableId": null,
                   "paramValue": "5599元"
                },
                "customCardAmountSymbol": null,
                "customCardDesc": {
                   "variableId": null,
                   "paramValue": "手机"
                },
                "customCardType": null,
                "customCardLink": null,
                "paramInfos": [
                   {
                      "variableId": "4a39e1872f1e427794848f30945dd50a",
                      "paramValue": "华为mate70"
                   }
                ],
                "customMenus": [
                   {
                      "menuType": 0,
                      "menuName": "自定义按钮",
                      "menuLink": null
                   }
                ]
             }
          ]
       }
    }
  ],
  "retCode": "000000",
  "retMsg": "操作成功"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
# ● 问答-访客端初始化

接口说明：

接口类型：主动调用接口

接口作用：调用该接口初始化访客信息，生成访客。

请求方式：

GET

请求地址：

 http://api-c.soboten.com/text/ai-agent-open/ask/ask_init
1

参数说明：

请求参数

名称 位置 类型 必选 说明
robotid query string 是 none
bizid query string 是 none

返回示例

成功

{
  "data": {
    "bizid": "a97e877ad6b9403bbf945401ea331111",
    "ai_agent_cid": "17ad7f4ab65b4aedadb3b72caf6a86cd",
    "biz_type": "AI_AGENT",
    "biz_typeid": "1000045"
  },
  "retCode": "000000",
  "retMsg": "操作成功"
}
1
2
3
4
5
6
7
8
9
10

返回结果

参数 类型 必填 描述
ret_code String 是 返回编码
ret_msg String 是 返回信息
data Object 否 返回对象

返回data数据结构

InitRespVo

类型 必选 说明
InitRespVo 是 none

属性

名称 类型 必选 说明
bizId string¦null 否 业务id
aiAgentCid string¦null 否 当前会话id
bizType string¦null 否 业务线类型
bizTypeId string¦null 否 产品id
{
  "bizId": "a97e877ad6b9403bbf945401ea331111",
  "aiAgentCid": "17ad7f4ab65b4aedadb3b72caf6a86cd",
  "bizType": "AI_AGENT",
  "bizTypeId": "1000045"
}
1
2
3
4
5
6
7
# ● 问答-非流式

接口说明：

接口类型：主动调用接口

接口作用：可通过调用该接口获取答案，并建立会话。

请求方式：

POST

请求地址：

 http://api-c.soboten.com/text/ai-agent-open/ask/answer_no_stream
1

请求参数：

名称 位置 类型 必选 说明
body body OpenRobotAnswerReqVo 是 none

OpenRobotAnswerReqVo 对象：

名称 类型 必选 说明
question string 是 问题
show_question string 是 展示问题
input_type_enum string 是 输入类型
biz_id string 是 业务id
biz_type string 是 业务线类型
biz_type_id string 是 产品id
robotid string 是 机器人id
msg_type string 是 TEXT: 文本, IMG: 图片
uid string 否 访客id
user_name string 否 访客姓名
transfer boolean 否 是否开启转人工
ai_agent_cid string 否 AiAgent会话id
call_back_url string 否 回调地址
source_enum string 是 渠道来源
partnerid string 否 对接id
params Map<String,Object> 否 自定义参数
multi_params Map<String,Object> 否 自定义参数
timing boolean 否 是否开启外部定时
input_variable_infos OpenAnswerVariableInfo 否 外部传入变量
process_info OpenProcessInfo 否 枚举变量点击信息
interface_info OpenInterfaceInfo 否 节点数据

Body 请求参数

{
  "question": "人工客服",
  "show_question": "人工客服",
  "input_type_enum": "INPUT",
  "biz_id": "a97e877ad6b9403bbf945401ea331111",
  "biz_type": "TEXT",
  "msg_type": "TEXT",
  "biz_type_id": "1000016",
  "robotid": "1",
  "uid": "c56844605e72633776a6de28d0f598f3",
  "user_name": "用户名称",
  "transfer": true,
  "ai_agent_cid": "17ad7f4ab65b4aedadb3b72caf6a86cd",
  "call_back_url": "http://www.sobot.com/aiAgent/callback",
  "source_enum": "PC",
  "partnerid": "123456",
  "params": {
    "key": {}
  },
  "multi_params": {
    "key": {}
  },
  "timing": false,
  "input_variable_infos": [
    {
      "variable_id": "1888794111663644672",
      "variable_name": "变量名",
      "variable_value": "变量值",
      "variable_type": "CHARACTER"
    }
  ],
  "process_info": {
    "process_id": "5a227ca7b4fc48e98d4e02b113c81c123",
    "node_id": "1905555364410802345",
    "variable_id": "1888794111663644672",
    "variable_value": "变量值"
  }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38

返回示例

成功

返回结果

参数 类型 必填 描述
ret_code String 是 返回编码
ret_msg String 是 返回信息
data Object 否 返回对象

返回data数据结构

类型 必选 约束 说明
RobotAnswerRespVo 是 none none
{
  "data": [
    {
      "robot_answer_type": "QA_DIRECT",
      "robot_answer_message_type": "MESSAGE",
      "answer": "人工客服",
      "transfer_result": "NO_ACTION",
      "roundid": "12ef2d1957434f2eb4b45c629d2db2dc",
      "msgid": "12789cf50b784e4480a02289ddc69fb9",
      "ai_agent_cid": "12dec883b46d48a5808ea143379b7014",
      "biz_id": "29967d81d67f4a708e8bd7d8f6356447",
      "robot_name": "大模型机器人",
      "robot_logo": "",
      "robotid": "1",
      "robot_status": "DELETE",
      "delay": 0,
      "output_variable_infos": [
        {
          "variable_id": "1888794111663644672",
          "variable_name": "变量名",
          "variable_value": "变量值",
          "variable_type": "CHARACTER"
        }
      ],
      "process_id": "5a227ca7b4fc48e98d4e02b113c81c123",
      "node_id": "1905555364410802345",
      "variable_id": "1888794111663644672",
      "variable_value_enums": [
        ""
      ]
    }
  ],
  "retCode": "000000",
  "retMsg": "操作成功"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
# ● 问答-分词联想

接口说明：

接口类型：主动调用接口

接口作用：客户通过此接口可以提前获取知识库中的标问。

请求方式：

POST

请求地址：

  http://api-c.soboten.com/text/ai-agent-open/ask/answer_suggest
1

Body 请求参数

请求参数

名称 位置 类型 必选 说明
body body OpenRobotAnswerReqVo 是

OpenRobotAnswerReqVo 对象：

名称 类型 必选 说明
question string 是 问题
show_question string 是 展示问题
input_type_enum string 是 输入类型
biz_id string 是 业务id
biz_type string 是 业务线类型
biz_type_id string 是 产品id
robotid string 是 机器人id
msg_type string 是 TEXT: 文本, IMG: 图片
uid string 否 访客id
user_name string 否 访客姓名
transfer boolean 否 是否开启转人工
ai_agent_cid string 否 AiAgent会话id
call_back_url string 否 回调地址
source_enum string 是 渠道来源
partnerid string 否 对接id
params Map<String,Object> 否 自定义参数
multi_params Map<String,Object> 否 自定义参数
timing boolean 否 是否开启外部定时
input_variable_infos OpenAnswerVariableInfo 否 外部传入变量
process_info OpenProcessInfo 否 枚举变量点击信息
{
  "question": "人工客服",
  "show_question": "人工客服",
  "input_type_enum": "INPUT",
  "biz_id": "29967d81d67f4a708e8bd7d8f6356447",
  "biz_type": "TEXT",
  "msg_type": "TEXT", 
  "biz_type_id": "1000016",
  "robotid": "1",
  "uid": "c56844605e72633776a6de28d0f598f3",
  "user_name": "用户名称",
  "transfer": true,
  "ai_agent_cid": "12dec883b46d48a5808ea143379b7014",
  "call_back_url": "http://www.sobot.com/aiAgent/callback",
  "source_enum": "PC",
  "partnerid": "123456",
  "params": {
    "key": {}
  },
  "multi_params": {
    "key": {}
  },
  "timing": false,
  "input_variable_infos": [
    {
      "variable_id": "1888794111663644672",
      "variable_name": "变量名",
      "variable_value": "变量值",
      "variable_type": "CHARACTER"
    }
  ]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32

返回示例

成功

返回结果

参数 类型 必填 描述
ret_code String 是 返回编码
ret_msg String 是 返回信息
data Object 否 返回对象

返回data数据结构

类型 必选 约束 说明
RobotAnswerSuggestRespVo 是 none none
{
  "data": {
    "qa_contents": [
      {
        "question": "人工客服",
        "questionid": "dda6a07ef5b74642a601102095d1681a",
        "docid": "e3e8a0a11f27496a8448ced8a7ba392d",
        "score": 0
      }
    ]
  },
  "retCode": "000000",
  "retMsg": "操作成功"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
# ● 问答-异步

接口说明：

接口类型：主动调用接口

接口作用：可通过调用该接口异步的方式返回机器人答案。

请求方式：

POST

请求地址：

 http://api-c.soboten.com/text/ai-agent-open/ask/answer_with_call_back
1

Body 请求参数

请求参数

名称 位置 类型 必选 说明
body body RobotAnswerReqVo 是 none
{
  "question": "人工客服",
  "show_question": "人工客服",
  "input_type_enum": "INPUT",
  "biz_id": "29967d81d67f4a708e8bd7d8f6356447",
  "biz_type": "TEXT",
  "msg_type": "TEXT",
  "biz_type_id": "1000016",
  "robotid": "1",
  "uid": "c56844605e72633776a6de28d0f598f3",
  "user_name": "用户名称",
  "transfer": true,
  "ai_agent_cid": "12dec883b46d48a5808ea143379b7014",
  "call_back_url": "http://www.sobot.com/aiAgent/callback",
  "source_enum": "PC",
  "partnerid": "123456",
  "params": {
    "key": {}
  },
  "multi_params": {
    "key": {}
  },
  "timing": "false",
  "input_variable_infos": [
    {
      "variable_id": "1888794111663644672",
      "variable_name": "变量名",
      "variable_value": "变量值",
      "variable_type": "CHARACTER"
    }
  ],
  "process_info": {
    "process_id": "5a227ca7b4fc48e98d4e02b113c81c123",
    "node_id": "1905555364410802345",
    "variable_id": "1888794111663644672",
    "variable_value": "变量值"
  }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38

返回示例

成功

{
  "data": {},
  "retCode": "000000",
  "retMsg": "操作成功",
  "pageNo": 0,
  "pageCount": 0,
  "totalCount": 0,
  "pageSize": 0
}
1
2
3
4
5
6
7
8
9

返回结果

参数 类型 必填 描述
ret_code String 是 返回编码
ret_msg String 是 返回信息
data Object 否 返回对象
# ● 会话结束

接口说明：

接口类型：主动调用接口

接口作用：可通过调用该接口结束机器人的会话。

请求方式：

GET

请求地址：

  http://api-c.soboten.com/text/ai-agent-open/ask/end_session
1

请求参数

名称 位置 类型 必选 说明
ai_agent_cid query string 是 none

返回示例：

成功

{
  "data": {},
  "ret_code": "000000",
  "ret_msg": "操作成功"
}
1
2
3
4
5

返回结果

参数 类型 必填 描述
ret_code String 是 返回编码
ret_msg String 是 返回信息
data Object 否 返回对象
# ● 轮询超时消息

接口说明：

接口类型：主动调用接口

接口作用：可通过调用该接口轮询超时消息。

请求方式：

POST

请求地址：

 http://api-c.soboten.com/text/ai-agent-open/ask/get_push_info
1

请求参数：

名称 位置 类型 必选 说明
msgid query string 是 none

返回示例

成功

{
  "data": {
    "msgid": "12789cf50b784e4480a02289ddc69fb9",
    "data": {
      "msgid": "12789cf50b784e4480a02289ddc69fb9",
      "bizid": "a97e877ad6b9403bbf945401ea331111",
      "ai_agent_cid": "12dec883b46d48a5808ea143379b7014",
      "round_id": "12ef2d1957434f2eb4b45c629d2db2dc",
      "msg": "人工客服",
      "source_enum": "PC",
      "uid": "c56844605e72633776a6de28d0f598f3",
      "polling_id": "4cd268c9836d45eb931af9c70cf6cc1d",
      "polling_status": "POLLING_END"
    },
    "bizid": "a97e877ad6b9403bbf945401ea331111",
    "push_type": "ROBOT_ANSWER"
  },
  "retCode": "",
  "retMsg": ""
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

返回结果

参数 类型 必填 描述
ret_code String 是 返回编码
ret_msg String 是 返回信息
data Object 否 返回对象

返回data数据结构

类型 必选 约束 说明
PushInfo 是 none none
# ● 问答-三方大模型机器人对接

接口说明：客户在大模型机器人配置页面配置好对应地址即可使用

接口类型：主动调用接口

接口作用：智齿大模型通过此接口可以直接获取客户方大模型回答。

请求方式：

POST

请求地址：客户自行配置

Body 请求参数

请求参数

名称 位置 类型 必选 说明
body body ThirdAlgorithmReqVo 是

ThirdAlgorithmReqVo 对象：

名称 类型 必选 说明
question string 是 问题
show_question string 是 展示问题
input_type_enum string 是 输入类型：INPUT-普通输入，CLICK-普通点击，PROCESS_CLICK-任务流程点击，PROCESS_CARD_CLICK-多轮卡片点击
robot_name string 否 机器人名称
robotLogo string 否 机器人Logo
robotRemark string 否 机器人备注
robotid string 是 机器人id
msg_type string 是 TEXT: 文本, IMG: 图片
companyid string 是 公司id
biz_type string 是 业务线类型：TEXT-文本，CALL-呼叫，WORK_ORDER-工单
partnerid string 否 对接id
ai_agent_cid string 是 AiAgent会话id
interface_info ThirdInterfaceInfo 否 节点卡片接口信息
source_enum string 否 渠道来源
context_validity_time Long 是 上下文有效时间
params Map<String,Object> 否 自定义参数
multi_params Map<String,Object> 否 自定义参数
roundid string 是 轮次id
input_variable_infos OpenAnswerVariableInfo 否 外部传入变量
process_info OpenProcessInfo 否 枚举变量点击信息
runtimeid string 否 运行id，批量测试使用
questionid string 否 批量测试问题id
robot_model string 是 机器人模式：THIRD_STANDARD-标准，THIRD_DEBUG-调试
req_stream boolean 是 请求ai返回格式：true-流式，false-标准http
copilot boolean 是 是否是辅助机器人：true-是，false-不是

ThirdInterfaceInfo 对象：

名称 类型 必选 说明
card_style string 是 卡片样式，1-列表
card_type string 是 卡片类型，1-商品
card_form string 是 卡片来源，1-大模型
card_guide string 是 卡片引导语
custom_cards List 是 卡片信息

ThirdInterfaceCardInfo 对象：

名称 类型 必选 说明
custom_card_name ThirdCardParamInfo 是 标题
custom_card_header List<Map<String, ThirdCardParamInfo>> 否 页眉
custom_card_num ThirdCardParamInfo 否 商品数量
custom_field List<Map<String, ThirdCardParamInfo>> 否 卡片自定义字段
custom_card_thumbnail ThirdCardParamInfo 否 图片
custom_card_amount ThirdCardParamInfo 否 合计金额
custom_card_amount_symbol ThirdCardParamInfo 否 货币符号
custom_card_desc ThirdCardParamInfo 否 描述
custom_card_type Integer 是 卡片动作类型，0-发送，1-自定义
custom_card_link String 否 卡片链接
param_infos List 否 该卡片的所有参数与变量对应关系
custom_menus ThirdInterfaceCardButtonInfo 否 卡片按钮

ThirdInterfaceCardButtonInfo 对象：

名称 类型 必选 说明
menu_type Integer 是 按钮动作类型，0-发送，1-自定义
menu_name String 是 按钮名称
menu_link String 否 按钮链接
{
   "question": "question_7a033c05b97d",
   "show_question": "show_question_a8e88791853d",
   "input_type_enum": "INPUT",
   "robotid": "robotid_97775fd863d0",
   "robot_name": "robot_name_fb9b23e26933",
   "robot_logo": "robot_logo_dbf190cab17c",
   "robot_remark": "robot_remark_e860b23dd59a",
   "ai_agent_cid": "ai_agent_cid_ad877ac21893",
   "companyid": "companyid_69c0a98e2874",
   "biz_type": "TEXT",
   "context_validity_time": 0,
   "partnerid": "partnerid_657958dce1b1",
   "params": {},
   "multi_params": {},
   "source_enum": "source_enum_8226cdbd3c71",
   "roundid": "roundid_5da5d19a0f2d",
   "input_variable_infos": [
      {
         "variable_id": "variable_id_9acd68d03618",
         "variable_name": "variable_name_97abb8c7029d",
         "variable_value": "variable_value_17c2da4c71d3",
         "variable_code": "variable_code_da936fee5e9f",
         "variable_type": "CHARACTER"
      }
   ],
   "process_info": {
      "node_id": "node_id_00afb01de3f6",
      "process_id": "process_id_4af01bd3b25e",
      "variable_id": "variable_id_9f732319c7ea",
      "variable_value": "variable_value_ffb2e58773f6"
   },
   "interface_info": {
      "card_style": "card_style_e9938c7cc17b",
      "card_type": "card_type_01210c33f5d2",
      "card_form": "card_form_59c9037b1546",
      "card_guide": "card_guide_02e0d57211c7",
      "custom_cards": [
         {
            "custom_card_name": {
               "variableid": "variableid_3b06f96fe2c8",
               "param_value": "param_value_87ceefad6dc2"
            },
            "custom_card_header": [
               {}
            ],
            "custom_card_num": {
               "variableid": "variableid_161a64d8e3e5",
               "param_value": "param_value_a493dcf0d81d"
            },
            "custom_field": [
               {}
            ],
            "custom_card_thumbnail": {
               "variableid": "variableid_a3c2d8153b2e",
               "param_value": "param_value_5e12a18d6a85"
            },
            "custom_card_amount": {
               "variableid": "variableid_2037358e2a11",
               "param_value": "param_value_bce35b73feb0"
            },
            "custom_card_amount_symbol": {
               "variableid": "variableid_93e1ae7feee2",
               "param_value": "param_value_d0e53f4fa478"
            },
            "custom_card_desc": {
               "variableid": "variableid_4a6d6a88f707",
               "param_value": "param_value_e34a1576d661"
            },
            "custom_card_type": 0,
            "custom_card_link": "custom_card_link_7d98c985f4f9",
            "param_infos": [
               {
                  "variableid": "variableid_4e163ff134c0",
                  "param_value": "param_value_dbf47baf0341"
               }
            ],
            "custom_menus": [
               {
                  "menu_type": 0,
                  "menu_name": "menu_name_7a4c7b514a8e",
                  "menu_link": "menu_link_062f16821e30"
               }
            ]
         }
      ]
   },
   "msg_type": "TEXT",
   "runtimeid": "runtimeid_82de6047a003",
   "questionid": "questionid_b89f6d5dd01b",
   "robot_model": "SELF_DEBUG",
   "req_stream": false,
   "copilot": false
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94

返回示例

成功

返回结果

参数 类型 必填 描述
ret_code String 是 返回编码
ret_msg String 是 返回信息
data Object 否 返回对象

返回data数据结构

类型 必选 约束 说明
ThirdAlgorithmRespVo 是 none none

ThirdAlgorithmRespVo

名称 类型 必选 说明
answer_type string 是 回答类型
robot_answer_message_type string 是 消息类型：THIRD_ANSWER_INFO-文本或非流程，THIRD_PROCESS_INFO-任务流程，MESSAGE-文字消息（不单独出现）
lan string 是 语言标识
llm_answer string 是 答案
roundid string 是 消息轮次id
runtimeid string 否 批量测试运行id
questionid string 否 批量测试问题id
companyid string 是 公司id
success boolean 否 批量测试算法标识，true：成功 false：失败
hit_sensitive_word boolean 否 命中敏感词
message_end string 是 MESSAGE的最后一条
third_interface_info ThirdInterfaceInfo 否 卡片消息体
third_processid string 否 三方流程id
third_nodeid string 否 三方节点id
third_variable_value_enums List 否 三方变量id
third_variable_id String 否 三方变量集合
{
   "answer_type": "QA_DIRECT",
   "robot_answer_message_type": "MESSAGE",
   "lan": "lan_8018cad1eccd",
   "llm_answer": "llm_answer_f04380c77ff6",
   "roundid": "roundid_0aa8febbcca7",
   "runtimeid": "runtimeid_b80f48e55d61",
   "questionid": "questionid_8536deb2a29a",
   "companyid": "companyid_770644147cec",
   "success": false,
   "hit_sensitive_word": false,
   "message_end": false,
   "third_interface_info": {
      "card_style": "card_style_7c284829f017",
      "card_type": "card_type_bf7ff998f8a4",
      "card_form": "card_form_79314e2b5755",
      "card_guide": "card_guide_46d88ed54b29",
      "custom_cards": [
         {
            "custom_card_name": {
               "variableid": "variableid_1e5238bb6165",
               "param_value": "param_value_772bde60287e"
            },
            "custom_card_header": [
               {}
            ],
            "custom_card_num": {
               "variableid": "variableid_bdb40ee8ef87",
               "param_value": "param_value_9e958a35826b"
            },
            "custom_field": [
               {}
            ],
            "custom_card_thumbnail": {
               "variableid": "variableid_65808769c6f5",
               "param_value": "param_value_14dbe5a13f6c"
            },
            "custom_card_amount": {
               "variableid": "variableid_4ddf5bc95e1e",
               "param_value": "param_value_c0170efe1283"
            },
            "custom_card_amount_symbol": {
               "variableid": "variableid_99b9b4dba216",
               "param_value": "param_value_1ffd443bc8a8"
            },
            "custom_card_desc": {
               "variableid": "variableid_6bacee5947e0",
               "param_value": "param_value_a94494bc11ea"
            },
            "custom_card_type": 0,
            "custom_card_link": "custom_card_link_35b8326a91f9",
            "param_infos": [
               {
                  "variableid": "variableid_2b27893622b1",
                  "param_value": "param_value_ca7bda6d2f9f"
               }
            ],
            "custom_menus": [
               {
                  "menu_type": 0,
                  "menu_name": "menu_name_ddb1ea945dbc",
                  "menu_link": "menu_link_bfba26affa51"
               }
            ]
         }
      ]
   },
   "third_processid": "third_processid_eb483c5b915e",
   "third_nodeid": "third_nodeid_8870ffb96e8d",
   "third_variable_value_enums": [
      "third_variable_value_enums_3135b9f69643"
   ],
   "third_variable_id": "third_variable_id_47a7e93cf55b"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
# ● 问答-三方大模型机器人对接的辅助类型回调

接口说明：调取客户大模型机器人时，copilot=true时，需要客户主动回调智齿，传入答案。

接口类型：被动调用接口

接口作用：客户回传答案使用

请求方式：

POST

请求地址：

https://api-c.soboten.com/text/ai-agent-open/ask/callback_list
1

Body 请求参数

请求参数

名称 位置 类型 必选 说明
body body ThirdCallbackListRespVo 是

ThirdCallbackListRespVo 对象：

名称 类型 必选 说明
algorithm_resp_vos List 是 算法响应

返回示例

成功

# ● 问答-三方大模型机器人对接的批量测试回调

接口说明：调取客户大模型机器人时，runtimeId不为空时，需要客户主动回调智齿，传入测试结果。

接口类型：被动调用接口

接口作用：客户通过此接口可以通知智齿测试结果。

请求方式：

POST

请求地址：

https://api-c.soboten.com/text/ai-agent-open/api/kb/question_call_back
1

Body 请求参数

请求参数

名称 位置 类型 必选 说明
body body ThirdAlgorithmRespVo 是

返回示例

成功

# ● 流式接口解析方式
  1. 判断robotAnswerMessageType字段 ERROR_END为会话异常结束 MESSAGE为消息解析，取answer字段即可，msgId为消息id，和下面的回答信息对应 ANSWER_INFO和PROCESS_INFO为回答信息解析，answer和其余字段均需解析，其中answer无值则无需解析
  2. 判断robotAnswerType字段，在ANSWER_INFO和PROCESS的情况下，该字段目前用于转人工按钮显示，后续可能会有别的作用
  3. 判断transferResult字段，在ANSWER_INFO和PROCESS的情况下，该字段用于判断是否需要转人工
  4. 判断delay字段，在ANSWER_INFO和PROCESS的情况下，该字段大于0，则开启轮询节点超时
# ● 任务流程中按钮消息交互
  1. 流程中变量设置为枚举类型
  2. 机器人问答接口出参RobotAnswerRespVo会返回枚举相关数据(process_id,node_id,variable_id,variable_value_enums)
  3. 当选择枚举中某个值后，需要机器人问答接口入参RobotAnswerReqVo增加枚举数据process_info(process_id对应步骤2的process_id,node_id对应步骤2的node_id,variable_id对应步骤2的variable_id,variable_value对应步骤2的variable_value_enums某个值)，input_type_enum设置为PROCESS_CLICK
# ● 任务流程中节点消息交互
  1. 流程中配置了相关的卡片消息
  2. 机器人问答接口出参RobotAnswerRespVo会返回相关的卡片消息数据(interface_info)
  3. 当点击某个卡片消息，需要在机器人问答接口入参RobotAnswerReqVo增加卡片数据(interface_info) 具体修改入参的值：
字段 类型 说明
input_type_enum String 值为：PROCESS_CARD_CLICK
interface_info Object 见：interface_info说明
show_question String 见：show_question说明,按照字符串入参
question String 见：question说明,按照字符串入参

interface_info说明

interface_info字段是将返回的interface_info对象进行处理后，然后入参
1.将interface_info中的cardStyle赋值为0
2.将修改后的整个interface_info对象入参interface_info字段
1
2
3

show_question说明

show_question字段是将返回的interface_info字段进行处理后，然后入参
1.将interface_info中的cardStyle赋值为0
2.customCards字段，只保留点击卡片的完整属性作为入参
3.其他不变,然后按照字符串的格式进行入参

形如：{\"cardStyle\":\"0\",\"cardType\":\"1\",\"cardForm\":\"1\",\"cardGuide\":\"您好，为您查询到以下结果，请选择您要查询的手机相关信息。\",\"customCards\":[{\"customCardName\":{\"variableId\":\"4a39e1872f1e427794848f30945dd50a\",\"paramValue\":\"小米15\"},\"customCardHeader\":[{\"序号:\":{\"variableId\":null,\"paramValue\":\"1\"}}],\"customCardNum\":null,\"customField\":[{\"自定义信息:\":{\"variableId\":\"4a39e1872f1e427794848f30945dd50a\",\"paramValue\":\"小米15\"}}],\"customCardThumbnail\":{\"variableId\":null,\"paramValue\":\"https://img11.360buyimg.com/n5/s720x720_jfs/t1/334979/11/13421/36831/68c781ebF83a737e9/02c00e06f2043c7a.jpg\"},\"customCardAmount\":{\"variableId\":null,\"paramValue\":\"3999元\"},\"customCardAmountSymbol\":null,\"customCardDesc\":{\"variableId\":null,\"paramValue\":\"手机\"},\"customCardType\":null,\"customCardLink\":null,\"paramInfos\":[{\"variableId\":null,\"paramValue\":\"1\"},{\"variableId\":\"4a39e1872f1e427794848f30945dd50a\",\"paramValue\":\"小米15\"},{\"variableId\":null,\"paramValue\":\"3999元\"},{\"variableId\":null,\"paramValue\":\"手机\"},{\"variableId\":null,\"paramValue\":\"https://img11.360buyimg.com/n5/s720x720_jfs/t1/334979/11/13421/36831/68c781ebF83a737e9/02c00e06f2043c7a.jpg\"}],\"customMenus\":[{\"menuType\":0,\"menuName\":\"自定义按钮\",\"menuLink\":null}]}]}
1
2
3
4
5
6

question说明

question字段需要组装一下
1.提取点击卡片中对应的paramInfos属性
2.遍历paramInfos数组
3.组装对象,其中参数有：
processId : data.processId,
nodeId : data.nodeId,
variableId : paramInfos[i].variableId,
variableValue : paramInfos[i].paramValue
customCardButtonName:点击按钮的名称,customMenus.menuName
4.将遍历后组装的对象,放入集合中
5.将当前集合按照字符串的格式进行入参

形如：[{\"processId\":\"a0077340350347c6b107e9ade1e2bddd\",\"nodeId\":\"e9eac6c0f4e244a68e4ea23ffbc1348f\",\"variableId\":null,\"variableValue\":\"3\",\"customCardButtonName\":\"自定义按钮\"}]
1
2
3
4
5
6
7
8
9
10
11
12
13
# ● 三方对接大模型接口说明
  1. 判断input_type_enum字段,INPUT-普通输入，CLICK-普通点击，PROCESS_CLICK-任务流程点击，PROCESS_CARD_CLICK-多轮卡片点击 INPUT时，直接使用question作为问题提问； CLICK时，预留； PROCESS_CLICK时，任务流程中按钮模式点击，同时入参会携带process_info，会将点击信息传入； PROCESS_CARD_CLICK时，任务流程中卡片模式点击，同时入参会携带interface_info，会将点击信息传入；
  2. 判断msg_type字段，TEXT是纯文字，或input_type_enum=PROCESS_CLICK/PROCESS_CARD_CLICK时，question是json，IMG为图片，question里面是个链接
  3. 判断robot_model字段，根据是标准还是调试，来选取合适的回答返回
  4. 判断req_stream字段，在true的情况下，使用sse格式流式返回，具体返回方式参照流式接口解析方式,其中PROCESS_INFO换成THIRD_PROCESS_INFO，ANSWER_INFO换成THIRD_ANSWER_INFO 同时在MESSAGE的情况下，本次回答的最后一个MESSAGE的message_end=true； 在false的情况下，使用标准http格式一次性返回，返回格式参照问答-非流式，启动data数据格式为List
  5. 判断copilot字段，为true时，需要调取问答-三方大模型机器人对接的辅助类型回调接口，进行答案回传
  6. 判断runtimeid字段，不为空时，需要调取问答-三方大模型机器人对接的批量测试回调接口，进行结果回传
  7. roundid为轮次id，一次问答为一轮，提问时回携带过去，给出答案时需要返回
# ● 数据模型

PushInfo

{
  "msgid": "12789cf50b784e4480a02289ddc69fb9",
  "data": {},
  "bizid": "a97e877ad6b9403bbf945401ea331111",
  "push_type": "SESSION_OVER_TIME"
}
1
2
3
4
5
6
7

属性

名称 类型 必选 说明
msg_id string 是 消息id
data Object 是 消息
bizid string 是 业务id
push_type string 是 消息类型

PushData格式

{
      "msgid": "12789cf50b784e4480a02289ddc69fb9",
      "bizid": "a97e877ad6b9403bbf945401ea331111",
      "ai_agent_cid": "12dec883b46d48a5808ea143379b7014",
      "round_id": "12ef2d1957434f2eb4b45c629d2db2dc",
      "msg": "人工客服",
      "source_enum": "PC",
      "uid": "c56844605e72633776a6de28d0f598f3",
      "polling_id": "4cd268c9836d45eb931af9c70cf6cc1d",
      "polling_status": "POLLING_END"
}
1
2
3
4
5
6
7
8
9
10
11

属性

名称 类型 必选 说明
msgid string 是 消息id
bizid string 是 业务id
ai_agent_cid string 是 大模型机器人会话id
round_id string 是 轮次id
msg string 否 消息
source_enum string 是 来源
uid string 否 访客id
polling_id string 是 轮询id
polling_status string 是 轮询状态

枚举值

属性 值 说明
push_type SESSION_OVER_TIME 会话超时，data格式
push_type NODE_OVER_TIME 节点超时，data格式
push_type ROBOT_ANSWER 推送答案，data数据为List
polling_status POLLING_START 开始
polling_status POLLING_RUNNING 进行中
polling_status POLLING_END 结束

RobotAnswerReqVo

{
  "question": "人工客服",
  "show_question": "人工客服",
  "input_type_enum": "INPUT",
  "biz_id": "29967d81d67f4a708e8bd7d8f6356447",
  "biz_type": "TEXT",
  "biz_type_id": "1000016",
  "robotid": "1",
  "uid": "c56844605e72633776a6de28d0f598f3",
  "user_name": "用户名称",
  "transfer": true,
  "ai_agent_cid": "12dec883b46d48a5808ea143379b7014",
  "call_back_url": "http://www.sobot.com/aiAgent/callback",
  "source_enum": "PC",
  "partnerid": "123456",
  "params": {
    "key": {}
  },
  "multi_params": {
    "key": {}
  },
  "timing": false,
  "input_variable_infos": [
    {
      "variable_id": "1888794111663644672",
      "variable_name": "变量名",
      "variable_value": "变量值",
      "variable_type": "CHARACTER"
    }
  ],
  "process_info": {
    "process_id": "5a227ca7b4fc48e98d4e02b113c81c123",
    "node_id": "1905555364410802345",
    "variable_id": "1888794111663644672",
    "variable_value": "变量值"
  }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38

属性

名称 类型 必选 说明
question string 是 问题
show_question string 是 展示问题
input_type_enum string 是 输入类型
biz_id string 是 业务id
biz_type string 是 业务线类型
biz_type_id string 是 产品id
robotid string 是 机器人id
uid string 否 访客id
user_name string 否 访客姓名
transfer boolean 否 是否开启转人工
ai_agent_cid string 否 AiAgent会话id
call_back_url string 否 回调地址
source_enum string 是 渠道来源
partnerid string 否 对接id
params Map<String,Object> 否 自定义参数
multi_params Map<String,Object> 否 自定义参数
timing boolean 否 是否开启外部定时
input_variable_infos OpenAnswerVariableInfo 否 外部传入变量
process_info OpenProcessInfo 否 枚举变量点击信息

枚举值

属性 值 说明
input_type_enum INPUT 普通输入
input_type_enum CLICK 点击输入
input_type_enum PROCESS_CLICK 任务流程点击输入
input_type_enum WELCOME 获取欢迎语
input_type_enum PROCESS_CARD_CLICK 任务流程卡片输入
biz_type AI_AGENT 大模型机器人本身
source_enum PC 桌面
source_enum weChat 微信
source_enum APP sdk
source_enum weiBo 微博
source_enum wap h5
source_enum huJiao 呼叫
source_enum workOrder 工单
source_enum uCenter 客户中心
source_enum qiYeWeixin 企业微信
source_enum miniApp 小程序
source_enum baiDu 百度
source_enum touTiao 淘宝
source_enum qihu360 奇虎360
source_enum wolongShenMa
source_enum sougou 搜狗
source_enum wxkf 微信客服
source_enum guangDianTong
source_enum zhihu
source_enum fb
source_enum whatsApp
source_enum instagram
source_enum line
source_enum discord
source_enum telegram
source_enum shopify
source_enum twitter

AnswerVariableInfo

{
  "variable_id": "1888794111663644672",
  "variable_name": "变量名",
  "variable_value": "变量值",
  "variable_code": "string",
  "variable_type": "CHARACTER"
}
1
2
3
4
5
6
7
8

属性

名称 类型 必选 说明
variable_id string 是 变量id
variable_name string 是 变量名称
variable_value string 是 变量值
variable_code string 是 变量编码
variable_type string 是 变量类型(1:字符, 2:数字, 3:枚举)

枚举值

属性 值 说明
variable_type CHARACTER 字符
variable_type NUMBER 数字
variable_type ENUMERATION 枚举

OpenProcessInfo

{
  "process_id": "5a227ca7b4fc48e98d4e02b113c81c123",
  "node_id": "1905555364410802345",
  "variable_id": "1888794111663644672",
  "variable_value": "变量值"
}
1
2
3
4
5
6
7

属性

名称 类型 必选 说明
variable_id string 是 变量id
process_id string 是 流程id
variable_value string 是 变量值
node_id string 是 节点id

OpenInterfaceInfo

{
   "cardStyle": "0",
   "cardType": "1",
   "cardForm": "1",
   "cardGuide": "您好，为您查询到以下结果，请点击查看相关手机信息。",
   "customCards": [
      {
         "customCardName": {
            "variableId": "4a39e1872f1e427794848f30945dd50a",
            "paramValue": "华为mate70"
         },
         "customCardHeader": [
            {
               "序号:": {
                  "variableId": null,
                  "paramValue": "7"
               }
            }
         ],
         "customCardNum": null,
         "customField": [
            {
               "自定义信息:": {
                  "variableId": "4a39e1872f1e427794848f30945dd50a",
                  "paramValue": "华为mate70"
               }
            }
         ],
         "customCardThumbnail": {
            "variableId": null,
            "paramValue": "https://img11.360buyimg.com/n5/s720x720_jfs/t1/332638/32/12246/51387/68c3817dFf6c2947b/3b00cd8ecfe6840b.jpg"
         },
         "customCardAmount": {
            "variableId": null,
            "paramValue": "5599元"
         },
         "customCardAmountSymbol": null,
         "customCardDesc": {
            "variableId": null,
            "paramValue": "手机"
         },
         "customCardType": null,
         "customCardLink": null,
         "paramInfos": [
            {
               "variableId": "4a39e1872f1e427794848f30945dd50a",
               "paramValue": "华为mate70"
            }
         ],
         "customMenus": [
            {
               "menuType": 0,
               "menuName": "自定义按钮",
               "menuLink": null
            }
         ]
      }
   ]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59

属性

名称 类型 必选 说明
cardStyle string 是 卡片样式，1是机器人发的卡片列表，0是客户点击的回复卡片
cardType string 是 卡片类型，1-商品
cardForm string 是 卡片来源，1-大模型
cardGuide string 是 卡片引导语
customCards List 是 卡片信息

OpenInterfaceCardInfo属性

名称 类型 必选 说明
customCardName OpenCardParamInfo 是 标题
customCardHeader List<Map<String, OpenCardParamInfo>> 是 页眉
customCardNum OpenCardParamInfo 是 商品数量
customField List<Map<String, OpenCardParamInfo>> 是 卡片自定义字段
customCardThumbnail OpenCardParamInfo 是 图片
customCardAmount OpenCardParamInfo 是 合计金额
customCardAmountSymbol OpenCardParamInfo 是 货币符号
customCardDesc OpenCardParamInfo 是 描述
customCardType Integer 是 卡片动作类型，0-发送，1-自定义
customCardLink String 是 卡片链接
paramInfos List 是 该卡片的所有参数与变量对应关系
customMenus List 是 卡片按钮

OpenCardParamInfo属性

名称 类型 必选 说明
variableId string 是 变量id
paramValue string 是 参数值

OpenInterfaceCardButtonInfo属性

名称 类型 必选 说明
menuType string 是 按钮动作类型，0-发送，1-自定义
menuName string 是 按钮名称
menuLink string 是 按钮链接

QaInfo

{
  "question": "人工客服",
  "questionid": "dda6a07ef5b74642a601102095d1681a",
  "docid": "e3e8a0a11f27496a8448ced8a7ba392d",
  "score": 0
}
1
2
3
4
5
6
7

属性

名称 类型 必选 说明
question string 是 标问
questionId string 是 标问id
docId string 是 词条id
score number 是 匹配阈值

RobotAnswerSuggestRespVo

{
  "qa_contents": [
    {
      "question": "人工客服",
      "questionid": "string",
      "docid": "e3e8a0a11f27496a8448ced8a7ba392d",
      "score": 0
    }
  ]
}
1
2
3
4
5
6
7
8
9
10
11

属性

名称 类型 必选 说明
qaContents QaInfo 是 分词联想列表

RobotAnswerRespVo

{
  "robot_answer_type": "QA_DIRECT",
  "robot_answer_message_type": "MESSAGE",
  "answer": "人工客服",
  "transfer_result": "NO_ACTION",
  "roundid": "12ef2d1957434f2eb4b45c629d2db2dc",
  "msgid": "12789cf50b784e4480a02289ddc69fb9",
  "ai_agent_cid": "12dec883b46d48a5808ea143379b7014",
  "biz_id": "29967d81d67f4a708e8bd7d8f6356447",
  "robot_name": "大模型机器人",
  "robot_logo": "string",
  "robotid": "1",
  "robot_status": "DELETE",
  "delay": 0,
  "output_variable_infos": [
    {
      "variable_id": "1888794111663644672",
      "variable_name": "变量名",
      "variable_value": "变量值",
      "variable_code": "string",
      "variable_type": "CHARACTER"
    }
  ],
  "process_id": "5a227ca7b4fc48e98d4e02b113c81c123",
  "node_id": "1905555364410802345",
  "variable_id": "1888794111663644672",
  "variable_value_enums": [
    "string"
  ]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30

属性

名称 类型 必选 说明
robot_answer_type string 是 回答类型
robot_answer_message_type string 是 消息类型
answer string 否 答案
transfer_result string 否 转人工结果
roundid string 是 消息轮次id
msgid string 是 消息id
ai_agent_cid string 是 AiAgent会话id
biz_id string 是 业务id
robot_name string 是 机器人名称
robot_logo string 是 机器人logo
robotid string 是 机器人id
robot_status string 是 机器人状态
delay integer 是 节点延时
output_variable_infos AnswerVariableInfo 否 返回收集变量
process_id string 否 流程id
node_id string 否 节点id
variable_id string 否 变量id
variable_value_enums array 否 枚举列表

枚举值

属性 值 说明
robot_answer_type QA_DIRECT 直接回答
robot_answer_type DOCUMENT_DIRECT 文档直接回答
robot_answer_type PROCESS 流程开始
robot_answer_type PROCESS_DOING 流程进行中
robot_answer_type PROCESS_DOING_UNKOW 任务流程进行中命中未知回答
robot_answer_type PROCESS_DOING_LLM 任务流程进行中提示语由大模型生成
robot_answer_type PROCESS_DOING_QA_GENERAL 任务流程进行中命中通识
robot_answer_type PROCESS_DOING_CLEAR 任务流程进行中流程澄清
robot_answer_type PROCESS_DOING_SLOT_CLEAR 任务流程进行中槽值澄清
robot_answer_type PROCESS_DOING_QA_DIRECT 任务流程进行中命中QA直接回答
robot_answer_type PROCESS_DOING_DOCUMENT_DIRECT 任务流程进行中命中文档直接回答
robot_answer_type PROCESS_ERROR 任务流程_异常
robot_answer_type PROCESS_VALUE_ERROR 未获取到变量枚举值
robot_answer_type PROCESS_END 任务流程结束
robot_answer_type TRANSFER_INTENTION 转人工意图
robot_answer_type UNKNOWN 未知回答
robot_answer_type GENERAL 通识回答
robot_answer_message_type MESSAGE 消息解析
robot_answer_message_type ANSWER_INFO 回答解析
robot_answer_message_type ERROR 解析错误
robot_answer_message_type ERROR_END 会话已终止
robot_answer_message_type PROCESS_INFO 流程解析
transfer_result NO_ACTION 不转人工
transfer_result KEY_WORD 关键词转人工
transfer_result GPT_TRANSFER 意图转人工
transfer_result REPEAT 重复提问转人工
transfer_result NEGATIVE_EMOTIONS 情绪负向转人工
transfer_result MUCH_UNKNOWN 多次未知转人工
transfer_result PROCESS_NODE_TRANSFER 流程节点转人工
robot_status DELETE 大模型机器人已被删除
robot_status ENABLE 大模型机器人正常
robot_status EXPIRE 大模型机器人已过期停用
robot_status EXHAUST 大模型机器人问答量已用完

枚举值

属性 值 说明
bizType AI_AGENT 大模型机器人

# 大模型机器人调用企业接口说明

使用范围：

本文档用于大模型机器人调用企业外部接口的规范说明，主要涉及任务流程接口节点和动作管理模块。

# 1、支持的接口类型
  • 接口配置方式

  在任务流程接口节点、动作管理模块中配置接口时，需要先按截图路径配置接口。 您可以自定义Header参数、请求参数、输出参数。 img.png

  • 支持的接口类型

  目前大模型仅支持 POST 请求，且请求头中必须包含 Content-Type 为 application/json 的请求头。

  • 请求参数

  大模型机器人调用企业接口时，partnerId、params、multiParams将作为固定入参。请求参数类型建议使用 application/json 格式，否则可能会导致接口调用失败。

字段名称 字段说明 类型
partnerId 会话开始时，您传入智齿的客户的对接ID。未传则为空。 固定参数
params 会话开始时，它接收的值是一个 Json 格式的字符串。支持渠道：Web-JS、Android SDK、IOS SDK、微信客服、微信小程序 固定参数
multiParams 会话开始时，您传入的multiParams参数，json键值对格式，如：{"city":"北京","category":"衬衫"}。未传则为空。支持渠道：Web-JS、Android SDK、IOS SDK 固定参数
source 会话渠道。0为桌面网站（PC），2为APP，4为移动网站（H5） 固定参数
robotNo 会话开始时，您传入的multiParams参数，json键值对格式，如：{"city":"北京","category":"衬衫"}。未传则为空。支持渠道：Web-JS、Android SDK、IOS SDK 固定参数
docId 调用本接口的问题ID 固定参数
自定义参数 您自定义的请求参数。 固定参数
  • 返回参数

  返回参数可用于大模型机器人后续对话。如您需要使用「任务流程-接口节点-消息卡片」功能，请使用Json格式接口，并填写JSONpath表达式从接口返回结果中提取参数值。具体配置可参考帮助文档 消息卡片配置|帮助中心 (opens new window)

# 2、接口调用鉴权

  大模型机器人每次调用企业接口时，每一次调用接口我们都会传入 params和 mulitParams 两个固定的自定义参数。

  如企业需要使用动态token进行鉴权，可将token字段放入params和mulitParams 字段用于对接，每次大模型机器人调用企业接口时，会将params和mulitParams字段回传给企业接口，企业接口可根据自身需求进行鉴权，可用于验证用户身份，防止非法调用接口。

  • 请求示例
  curl https://xxxx.com/api/xxxx
  POST
  -H "Content-Type:application/json"
  -H "自定义Header:header值" //后台自定义的header参数
  -D "partnerId=xxx&multiParams={\"xx\":\"xx\"}&token=xxxx&source=0&robotNo=1&docId=xxxx/请求参数部分，可以将token拼接到Params或multiParams字段内
1
2
3
4
5
# 3、企业传参赋值变量

  如您希望通过企业传参对特定变量赋值，您可以在「大模型机器人-变量管理」内先创建一个变量，再将该变量的编码拼到params或multiParams字段内。此时企业传入的参数值会直接赋值到机器人变量。

img.png

  • 示例
  initInfo&multiParams = {"city":"北京","category":"衬衫"}
1

# 大模型机器人-接待记录

# ● 接待记录列表

接口说明：获取大模型机器人接待记录列表

请求方式：POST

请求地址：

 https://api-c.soboten.com/text/ai-agent-open/api/statistics/recordList
1

请求参数：

参数名 类型 必填 描述
start_time String 是 查询开始时间（会话开始时间）
end_time String 是 查询结束时间（会话开始时间）
page_no Integer 是 查询页码
page_size Integer 是 查询条数
robotid String 否 机器人ID以逗号分隔 见（获取机器人列表接口）
biz_type String 否 业务类型， 以逗号分隔 ， 见（biz_type枚举）
source String 否 渠道类型 以逗号分隔， 见（source枚举）
channel_flag_plus String 否 咨询渠道 以逗号分隔，见（获取咨询渠道接口）
cid String 否 机器人会话ID
bizid String 否 业务线会话ID
transfer2_human Integer 否 是否成功转人工 1-是 0-否
trigger2_human Integer 否 是否触发转人工 1-是 0-否
timeZoneid String 否 时区（默认为：Asia/Shanghai），见（接口：获取时区接口）
solve_status Integer 否 解决情况 1-确认解决 2-推断解决 3-未解决
answer_type String 否 回答类型 ，逗号隔开 见（answer_type枚举）
valid_trigger2_human_type String 否 转人工类型，见（valid_trigger2_human_type枚举）
emotion_type String 否 表达是否满意 POSITIVE--满意 NEGATIVE--不满意
satisfaction_status Integer 否 会话是否评价 1--已评价 0--未评价
score_level String 否 分值评价 见（score_level枚举）
star_level String 否 星级评价 见（star_level 枚举）
assess_status String 否 二级评价 5--满意 1--不满意
satisfaction_labels List 否 会话评价标签 见（接口：获取会话标签接口）
test Integer 否 是否测试会话 0:非测试会话 1:测试会话
like_dislike_status Integer 否 赞踩情况 1-点赞 2-点踩 3-答案未评价
like_dislike_labels List 否 点踩标签 见（接口：获取点踩标签接口）
robot_valid Integer 否 是否有效会话 1-有效会话、0-无效会话
robot_consult Integer 否 会话是否结束 0-会话中 1-已结束
rule_ids List 否 客群id集合 见（接口：获取客群接口）
is_trigger_session_guide_status Integer 否 是否触发会话引导 0未触发 1触发
robot_types List 否 机器人类型 AI_AGENT 为大模型机器人，AI_COPILOT 大模型辅助

返回参数：

参数名 类型 描述
ret_code String 返回编码
ret_msg String 返回信息
data Object 接待记录列表
total_count Integer 总记录数
page_no Integer 当前页码
page_size Integer 每页大小
page_count Integer 总页数

data 对象：

参数名 类型 描述
robot_name String 机器人名称
robot_valid Integer 是否有效会话 1-有效会话、0-无效会话
biz_type_enum String 业务类型枚举
source String 来源渠道
channel_flag String 渠道标识
user_msg_times Integer 用户消息次数
uid String 用户ID
valid_trigger_other2_human Integer 其他方式触发转人工
companyid String 公司ID
valid_trigger_ruler2_human Integer 规则触发转人工
like_dislike_status Integer 赞踩状态 1-点赞 2-点踩 3-未评价
satisfaction_status Integer 满意度状态 0-未评价 1-已评价
answer_variable_infos List 答案变量信息
robot_consult Integer 会话状态 0-会话中 1-已结束
test Integer 是否测试会话 0-否 1-是
rule_infos List 客群规则信息
channel_flag_plus String 扩展渠道标识
robot_flag String 机器人标识
robot_type String 机器人类型 AI_AGENT/AI_COPILOT
valid_trigger2_human_type String 转人工类型
transfer2_human Integer 是否成功转人工 0-否 1-是
biz_type String 业务类型名称
trigger2_human Integer 是否触发转人工 0-否 1-是
end_time Long 结束时间
start_time Long 开始时间
channel_flag_name String 渠道名称
answer_type List 回答类型
bizid String 业务ID
robot_msg_times Integer 机器人消息次数
cid String 会话ID

请求示例：

curl https://api-c.soboten.com/text/ai-agent-open/api/statistics/recordList
-X POST 
-H 'token:cdc94901834c4190adbde1810d2d3a58' 
-H 'language:zh' 
-H 'content-type: application/json' 
-d '
{
  "start_time": "2025-11-20",
  "end_time": "2025-11-20",
  "robot_types": [
    "AI_AGENT"
  ],
  "timeZoneid":"Asia/Shanghai",
  "robotid": "18,15,14",
  "biz_type": "TEXT,AI_AGENT",
  "source": "PC,wap,APP",
  "is_trigger_session_guide_status": 1,
  "trigger2_human": 0,
  "transfer2_human": 0,
  "rule_ids": [
    "a0546104b604441281419fc5b241417c"
  ],
  "page_no": 1,
  "page_size": 15,
  "answer_type": "2,3",
  "valid_trigger2_human_type": "REPEAT",
  "emotion_type": "POSITIVE",
  "assess_status": "5",
  "channel_flag_plus": "PC_24,PC_1",
  "robot_consult": 0,
  "solve_status": 2,
  "satisfaction_status": 1,
  "score_level": "10,9",
  "star_level": "5",
  "satisfaction_labels": [
    "3bde5e888b8c447fb437eafb3f750992"
  ],
  "robot_valid": 1,
  "test": 1,
  "like_dislike_status": 2,
  "like_dislike_labels": [
    "73da2cf57f42402b9c362fa1e4f62d6f"
  ],
  "cid": "f2f0daf6552c4078893932b50dfb963c"
}
'
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46

返回示例：

{
    "data": [
        {
            "robot_name": "机器人",
            "robot_valid": 0,
            "biz_type_enum": "TEXT",
            "source": "unknown",
            "channel_flag": "unknown",
            "user_msg_times": 1,
            "uid": "ad16e00bed9f4a21aedb6cc82e4c44e6",
            "valid_trigger_other2_human": 0,
            "companyid": "eb5c7fc458c54d6e978bab602673d504",
            "valid_trigger_ruler2_human": 0,
            "like_dislike_status": 3,
            "satisfaction_status": 0,
            "answer_variable_infos": [],
            "robot_consult": 1,
            "test": 0,
            "rule_infos": [
                {
                    "rule_name": "默认桌面网站21GV9P0w3v84",
                    "ruleid": "8196ed60ee6b4420a6e54d6fb40b2f1b"
                }
            ],
            "channel_flag_plus": "unknown_unknown",
            "robot_flag": "18",
            "robot_type": "AI_COPILOT",
            "valid_trigger2_human_type": "",
            "transfer2_human": 0,
            "biz_type": "在线客服",
            "trigger2_human": 0,
            "end_time": 1763551895072,
            "start_time": 1763549376694,
            "channel_flag_name": "unknown",
            "answer_type": [],
            "bizid": "5bdcd797c7b14d8cbd29ad2e525f87ae",
            "robot_msg_times": 0,
            "cid": "f2f0daf6552c4078893932b50dfb963c"
        }
    ],
    "total_count": 32,
    "page_no": 1,
    "ret_msg": "操作成功",
    "ret_code": "000000",
    "page_count": 3,
    "page_size": 15
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
# ● 获取机器人列表

请求方式：GET

请求地址：

 https://api-c.soboten.com/text/ai-agent-open/api/statistics/queryAiRobotList
1

请求参数：

参数名 类型 必填 描述
robotType String 否 机器人类别 1接待机器人 2客服助手

请求示例：

curl https://api-c.soboten.com/text/ai-agent-open/api/statistics/queryAiRobotList
-H 'token:cdc94901834c4190adbde1810d2d3a58' 
-H 'language:zh'
1
2
3

返回示例:

{
   "data": [
   	{
   		"kbid": 56,
   		"create_time": 1762165449497,
   		"robot_type": 1,
   		"robot_name": "cccc",
   		"robot_logo": "https://img-sg.sobot.com/static-resource/online-agent/image/newRbtPreviewFace.png",
   		"robot_model_status": "DRAFT",
   		"update_name": "小虎",
   		"updateid": "0a8c83731fd04728ac2ed13e9ef180dc",
   		"update_time": 1762165449497,
   		"companyid": "eb5c7fc458c54d6e978bab602673d504",
   		"robot_model": "NORMAL",
   		"configid": "a3e0b660f69e4f35b8d0438393672061",
   		"robot_veritable_remark": ""
   	}
   ],
   "ret_msg": "操作成功",
   "ret_code": "000000"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
# ● 获取咨询渠道

请求方式：POST

请求地址：

 https://api-c.soboten.com/text/ai-agent-open/api/statistics/sourceList
1

请求参数：

参数名 类型 必填 描述
start_time String 是 开始时间
end_time String 是 结束时间
timeZoneid String 否 时区（默认为：Asia/Shanghai）

返回参数：

参数名 类型 描述
kbid Integer 机器人Id
robot_type Integer 机器人类型
robot_name String 机器人名称
robot_logo String 机器人头像
companyid String 公司Id
create_time long 创建时间

请求示例：

curl https://api-c.soboten.com/text/ai-agent-open/api/statistics/sourceList
-X POST 
-H 'token:cdc94901834c4190adbde1810d2d3a58' 
-H 'language:zh' 
-H 'content-type: application/json' 
-d '
{
  "start_time": "2025-11-20",
  "end_time": "2025-11-20",
  "timeZoneid":"Asia/Shanghai"
}
'
1
2
3
4
5
6
7
8
9
10
11
12

返回示例:

{
   "data": [
   	{
   		"kbid": 56,
   		"create_time": 1762165449497,
   		"robot_type": 1,
   		"robot_name": "cccc",
   		"robot_logo": "https://img-sg.sobot.com/static-resource/online-agent/image/newRbtPreviewFace.png",
   		"robot_model_status": "DRAFT",
   		"update_name": "小虎",
   		"updateid": "0a8c83731fd04728ac2ed13e9ef180dc",
   		"update_time": 1762165449497,
   		"companyid": "eb5c7fc458c54d6e978bab602673d504",
   		"robot_model": "NORMAL",
   		"configid": "a3e0b660f69e4f35b8d0438393672061",
   		"robot_veritable_remark": ""
   	}
   ],
   "ret_msg": "操作成功",
   "ret_code": "000000"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
# ● 获取时区

请求方式：GET

请求地址：

 https://api-c.soboten.com/text/ai-agent-open/api/statistics/getTimezoneInfo
1

返回参数：

参数名 类型 描述
timezoneid String 时区Id
timezone_value String 时区
create_time long 创建时间

请求示例：

curl https://api-c.soboten.com/text/ai-agent-open/api/statistics/getTimezoneInfo 
-H 'token:cdc94901834c4190adbde1810d2d3a58' 
-H 'language:zh' 
-H 'content-type: application/json' 
'
1
2
3
4
5

返回示例:

{
   "data": [
   	{
   		"create_time": 1691484085445,
   		"timezone": "+09:00",
   		"timezoneid": "Asia/Seoul",
   		"id": "e5a5ac46319a41b89e88aec1f182cb47",
   		"timezone_value": "GMT+09:00 首尔"
   	},
   	{
   		"create_time": 1676875112127,
   		"main_timezone_flag": 1,
   		"timezone": "+08:00",
   		"timezoneid": "Asia/Shanghai",
   		"id": "eb63c44816fc43bf9c55861670ebdad9",
   		"timezone_value": "GMT+08:00 北京"
   	}
   ],
   "ret_msg": "操作成功",
   "ret_code": "000000"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
# ● 获取会话标签

请求方式：GET

请求地址：

 https://api-c.soboten.com/text/ai-agent-open/api/statistics/getLabels
1

返回参数：

参数名 类型 描述
name String 标签名称
id String 标签Id
create_time long 创建时间

请求示例：

curl https://api-c.soboten.com/text/ai-agent-open/api/statistics/getLabels
-H 'token:cdc94901834c4190adbde1810d2d3a58' 
-H 'language:zh' 
-H 'content-type: application/json' 
'
1
2
3
4
5

返回示例:

{
	"data": [
		{
			"companyid": "eb5c7fc458c54d6e978bab602673d504",
			"raw_name": "{dc_welcom_message1}",
			"create_time": 1761547328,
			"name": "您好默认内容",
			"id": "f22b65ffc8a440af87dbe901e8f22313"
		}
	],
	"ret_msg": "操作成功",
	"ret_code": "000000"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
# ● 获取点踩标签

请求方式：GET

请求地址：

 https://api-c.soboten.com/text/ai-agent-open/api/statistics/getLabelInfoList
1

返回参数：

参数名 类型 描述
name String 标签名称
id String 标签Id
create_time long 创建时间

请求示例：

curl https://api-c.soboten.com/text/ai-agent-open/api/statistics/getLabelInfoList
-H 'token:cdc94901834c4190adbde1810d2d3a58' 
-H 'language:zh' 
-H 'content-type: application/json' 
'
1
2
3
4
5

返回示例:

{
	"data": [
		{
			"companyid": "eb5c7fc458c54d6e978bab602673d504",
			"create_time": 1758178949759,
			"createid": "dfdeb1b627c649e39b601a334200ddf6",
			"name": "123213",
			"is_del": 0,
			"id": "45d1568f195c47b6a98f011392c658af"
		}
	],
	"ret_msg": "操作成功",
	"ret_code": "000000"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
# ● 获取客群

请求方式：GET

请求地址：

 https://api-c.soboten.com/text/ai-agent-open/api/statistics/simpleList
1

返回参数：

参数名 类型 描述
rule_title String 客群名称
ruleid String 客群Id

请求示例：

curl https://api-c.soboten.com/text/ai-agent-open/api/statistics/simpleList
-H 'token:cdc94901834c4190adbde1810d2d3a58' 
-H 'language:zh' 
-H 'content-type: application/json' 
'
1
2
3
4
5

返回示例:

{
	"data": [
		{
			"rule_title": "test",
			"ruleid": "52e49616bfa2455abc3ccfbb10de1218"
		}
	],
	"ret_msg": "操作成功",
	"ret_code": "000000"
}
1
2
3
4
5
6
7
8
9
10
# ● biz_type枚举
枚举值 描述
TEXT 在线客服
CALL 呼叫中心
WORK_ORDER 工单
AI_AGENT 开放平台
# ● source枚举
枚举值 描述
PC 桌面网站
wap 移动网站
APP App
Email 邮件
qiYeWeixin 企业微信
wxkf 微信客服
miniApp 微信小程序
weChat 微信公众号
fb Facebook
whatsApp WhatsApp
instagram Instagram
line line
discord Discord
telegram Telegram
shopify shopify
twitter twitter
TikTok Shop TikTok
Amazon Amazon
Walmart Walmart
Zalo Zalo
Kakao Kakao
Lazada Lazada
rednote rednote
# ● answer_type枚举
枚举值 描述
1 知识回答 - 直接回答
2 知识回答 - 问题 / 文章 / 文件 / 网页
3 知识回答 - 任务流程
4 智能回答
# ● valid_trigger2_human_type枚举
枚举值 描述
KEY_WORD 关键词
REPEAT 连续重复提问
PROCESS_NODE_TRANSFER 任务流程转人工
OTHER 其他方式转人工
CUSTOM_SCENE 自定义场景转人工
MUCH_UNKNOWN 缺少知识
# ● score_level枚举
枚举值 描述
10 10 分(好评)
9 9 分(好评)
8 8分(中评)
7 7 分(中评)
6 6 分(差评)
5 5 分(差评)
4 4 分(差评)
3 3 分(差评)
2 2 分 (差评)
1 1 分 (差评)
0 0 分 (差评)
# ● star_level枚举
枚举值 描述
5 5 星(好评)
4 4 星(中评)
3 3 星(中评)
2 2 星(差评)
1 1 星(差评)
上次更新: 2025/12/10 15:55:13

← 在线客服统计V6 API→

最近更新
01
知识中心 API
07-25
02
在线客服统计V6 API
04-23
03
运营支持 API
03-03
更多文章>
Theme by Vdoing