流程查询接口
场景描述
智能助手平台提供接口给第三方接入方调用,实现智能交互系统内的流程信息的查询。
接口方法
设置成“POST”。
URL
https://IP:PORT/oifde/rest/api/queryflows
请求说明
参数名称 |
数据类型 |
参数位置 |
必选/可选 |
描述 |
---|---|---|---|---|
tenantId |
String |
body |
True |
租户ID。 |
flowId |
String |
body |
False |
流程ID |
flowName |
String |
body |
False |
流程名称 |
flowCode |
String |
body |
False |
流程编码 |
source |
String |
body |
False |
流程来源 |
pageNum |
int |
body |
False |
页码 分页查询,查询第几页,首页为1 |
pageSize |
int |
body |
False |
每页多少条 |
authToken |
String |
body |
True |
认证token。 请参见C3 智能助手平台接口鉴权方式。 |
响应说明
参数名称 |
数据类型 |
参数位置 |
必选/可选 |
描述 |
---|---|---|---|---|
errorCode |
int |
body |
False |
错误码 成功,不返回errorCode; 失败,参见常用错误码 |
errorMsg |
String |
body |
False |
错误描述 |
total |
long |
body |
M |
总条数 |
flowList |
Flow[] |
body |
True |
数组 |
参数名称 |
数据类型 |
参数位置 |
必选/可选 |
描述 |
---|---|---|---|---|
tenantId |
String |
body |
True |
租户ID |
flowId |
int |
body |
True |
流程ID |
flowCode |
String |
body |
True |
流程编码 |
flowName |
String |
body |
True |
流程名称 |
flowDesc |
String |
body |
False |
流程描述 |
scenarioType |
String |
body |
True |
场景类型 Default:缺省(主流程) subFlow:子流程 SYS_ERROR_DEFAULT:异常流程 |
createDate |
Date |
body |
False |
创建日期 格式为时间戳 |
status |
String |
body |
False |
状态 INITIAL:初始状态 VALID:有效状态 |
statusDate |
Date |
body |
False |
修改时间 格式为时间戳 |
flowStartNode |
String |
body |
False |
开始节点 |
flowEndNode |
String |
body |
False |
结束节点 |
ext01 |
String |
body |
False |
拓展字段 |
logSwitch |
String |
body |
False |
日志开关 0:关闭 1:打开 |
isDefault |
String |
body |
False |
是否默认流程 0:否 1:是 |
version |
String |
body |
False |
流程版本 |
ruleId |
String |
body |
False |
灰度规则ID |
ruleName |
String |
body |
False |
灰度规则名称 |
source |
String |
body |
True |
流程来源 IVR: 传统流程 OIFDE: 智能化流程 |
workMode |
int |
body |
False |
发布模式 |
报文样例
- 请求消息样例
{ "tenantId": "tenant001" , "flowId": "??" , "flowName": "??" , "flowCode": "??" , "pageNum": 5 , "pageSize": 10 , "authToken": "0************************" }
- 响应消息样例
{ "total": 1, "flowList": [ { "flowId": "201904151183171584", "flowCode": "flow_ivr_5d06dad92731499abbe6cc6ebcb9d29d", "flowName": "按键测试", "flowDesc": null, "scenarioType": "subFlow", "tenantId": "NJ_001", "createDate": 1555293043000, "status": "VALID", "statusDate": 1555401640000, "flowStartNode": "node_view_c157d73a1b5640d280ee1cb4dcb239e2", "flowEndNode": "node_end_97dda8c5a62541c5b44b184a4645f6e8", "ext01": null, "logSwitch": null, "isDefault": "1", "version": "v1", "ruleId": null, "ruleName": null, "source":"IVR", "flowVariableList": [] } ] }